Skip to content

Commit 6a20ca1

Browse files
authored
docs: responses api (#396)
* docs: responses api * fix: image
1 parent f686ce9 commit 6a20ca1

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

docs/docs/agent/responses-api.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Responses API支持
3+
---
4+
5+
# ResponsesAPI介绍
6+
Responses API 是火山方舟最新推出的 API 接口,原生支持高效的上下文管理,支持更简洁的输入输出格式,并且工具调用方式也更加便捷,不仅延续了 Chat API 的易用性,还结合了更强的智能代理能力。
7+
随着大模型技术不断升级,Responses API 为开发各类面向实际行动的应用提供了更灵活的基础,并且支持工具调用多种扩展能力,非常适合搭建智能助手、自动化工具等场景。
8+
9+
## 使用教程
10+
11+
目前Veadk ResponsesAPI支持对litellm版本依赖有限制,需要`litellm>=1.79.3`,请确保您的litellm版本符合要求。
12+
=== "pip"
13+
```bash
14+
pip install "litellm>=1.79.3"
15+
```
16+
=== "uv"
17+
```bash
18+
uv pip install "litellm>=1.79.3"
19+
```
20+
21+
22+
### 快速开始
23+
只需要要配置enable_responses=True即可
24+
25+
```python hl_lines="4"
26+
from veadk import Agent
27+
28+
root_agent = Agent(
29+
enable_responses=True, # 开启responses api
30+
)
31+
32+
```
33+
34+
### 效果展示
35+
![responses-api](../assets/images/agents/responses_api.png)
36+
37+
38+
## 注意事项
39+
40+
- 必须提升litellm版本: `litellm>=1.79.3`,用于支撑responses_request转换
41+
- 必须保证adk版本: `google-adk>=1.15`
42+
- 请保证使用的模型支持ResponsesAPI
43+
658 KB
Loading

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ nav:
4646
- 多智能体交互: agent/agents.md
4747
- A2A 协议: agent/agent-to-agent.md
4848
- Prompt 管理: agent/prompt.md
49+
- ResponsesAPI 支持: agent/responses-api.md
4950
- 执行引擎:
5051
- Runner: runner.md
5152
- 个性化引擎——记忆:

0 commit comments

Comments
 (0)