Skip to content

Commit bb50f95

Browse files
committed
docs(prompt): add cozeloop api key fetching method
1 parent 6a20ca1 commit bb50f95

File tree

7 files changed

+43
-30
lines changed

7 files changed

+43
-30
lines changed

docs/docs/agent/prompt.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,25 @@
44

55
## CozeLoop 提示词管理
66

7+
您可以通过 CozeLoop 云端提示词管理功能来对接您的 Agent 系统提示词。
8+
9+
### 准备
10+
711
在使用 CozeLoop 进行提示词管理前,您需要安装 Python 版本的 `cozeloop` SDK:
812

913
```bash
1014
pip install cozeloop
1115
```
1216

13-
您可以通过 CozeLoop 云端提示词管理功能来对接您的 Agent 系统提示词。例如:
17+
### 属性获取
18+
19+
- [了解如何获取 CozeLoop Workspace ID](https://loop.coze.cn/open/docs/cozeloop/authentication-for-sdk#05d27a86)
20+
- [了解如何获取 CozeLoop Token / API Key](https://loop.coze.cn/open/docs/cozeloop/authentication-for-sdk)
21+
- 您可以在 CozeLoop 中的 “Prompt 开发” 板块获取 Prompt Key,如下图所示:
22+
23+
![img](../assets/images/cozeloop_prompt_key.png)
24+
25+
### 使用方法
1426

1527
```python title="agent.py" linenums="1" hl_lines="4 6-11 13"
1628
import asyncio
@@ -20,7 +32,7 @@ from veadk.prompts.prompt_manager import CozeloopPromptManager
2032

2133
prompt_manager = CozeloopPromptManager(
2234
cozeloop_workspace_id="", # CozeLoop workspace ID
23-
cozeloop_token="", # CozeLoop token
35+
cozeloop_token="", # CozeLoop token / api key
2436
prompt_key="", # CozeLoop 中创建的 Prompt Key
2537
label="production", # CozeLoop 中创建的 Prompt 标签
2638
)

docs/docs/agent/responses-api.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
2-
title: Responses API支持
2+
title: Responses API 支持
33
---
44

5-
# ResponsesAPI介绍
65
Responses API 是火山方舟最新推出的 API 接口,原生支持高效的上下文管理,支持更简洁的输入输出格式,并且工具调用方式也更加便捷,不仅延续了 Chat API 的易用性,还结合了更强的智能代理能力。
76
随着大模型技术不断升级,Responses API 为开发各类面向实际行动的应用提供了更灵活的基础,并且支持工具调用多种扩展能力,非常适合搭建智能助手、自动化工具等场景。
87

8+
---
9+
910
## 使用教程
1011

11-
目前Veadk ResponsesAPI支持对litellm版本依赖有限制,需要`litellm>=1.79.3`,请确保您的litellm版本符合要求。
12+
目前 VeADK Responses API 支持对 LiteLLM 版本依赖有限制,需要 `litellm>=1.79.3`,请确保您的 LiteLLM 版本符合要求。
13+
1214
=== "pip"
1315
```bash
1416
pip install "litellm>=1.79.3"
@@ -18,26 +20,25 @@ Responses API 是火山方舟最新推出的 API 接口,原生支持高效的
1820
uv pip install "litellm>=1.79.3"
1921
```
2022

21-
2223
### 快速开始
24+
2325
只需要要配置enable_responses=True即可
2426

2527
```python hl_lines="4"
2628
from veadk import Agent
2729

2830
root_agent = Agent(
29-
enable_responses=True, # 开启responses api
31+
enable_responses=True, # 开启 Responses API
3032
)
3133

3234
```
3335

3436
### 效果展示
35-
![responses-api](../assets/images/agents/responses_api.png)
3637

38+
![responses-api](../assets/images/agents/responses_api.png)
3739

3840
## 注意事项
3941

4042
- 必须提升litellm版本: `litellm>=1.79.3`,用于支撑responses_request转换
4143
- 必须保证adk版本: `google-adk>=1.15`
4244
- 请保证使用的模型支持ResponsesAPI
43-
136 KB
Loading

docs/docs/deploy/deploy-vefaas.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ title: 部署到 VeFaaS
2828
### 函数服务
2929

3030
1. 首次进入 [函数服务](https://console.volcengine.com/vefaas) 页面,控制台将会提醒你进行IAM角色的开通,请点击【立即授权】同意角色开通。
31-
![IAM 角色开通](./assets/images/deploy/vefaas_attach_role.png)
31+
![IAM 角色开通](../assets/images/deploy/vefaas_attach_role.png)
3232
2. 点击后,控制台将会显示你已完成授权。几秒后将会自动跳转会 [函数服务](https://console.volcengine.com/vefaas) 控制台。当展示如下页面时,[函数服务](https://console.volcengine.com/vefaas) 服务即开通成功。
33-
![IAM 角色开通](./assets/images/deploy/vefaas_index.png)
33+
![IAM 角色开通](../assets/images/deploy/vefaas_index.png)
3434

3535
### API网关
3636

3737
1. 首次进入 [API网关](https://console.volcengine.com/veapig) 页面,控制台将会提醒你进行IAM角色的开通,请点击【立即授权】同意角色开通。
38-
![IAM 角色开通](./assets/images/deploy/veapig_attach_role.png)
38+
![IAM 角色开通](../assets/images/deploy/veapig_attach_role.png)
3939
2. 点击后,控制台将会显示你已完成授权。几秒后将会自动跳转会 [API网关](https://console.volcengine.com/veapig) 控制台。当展示如下页面时,[API网关](https://console.volcengine.com/veapig) 服务即开通成功。
40-
![IAM 角色开通](./assets/images/deploy/veapig_index.png)
40+
![IAM 角色开通](../assets/images/deploy/veapig_index.png)
4141

4242
## 部署方式概览
4343

@@ -122,7 +122,7 @@ veadk-cloud-proj
122122
1. 在项目根目录下,将 `config.yaml.example` 文件复制一份并重命名为 `config.yaml`
123123
2. 编辑 `config.yaml` 文件,填入你的火山引擎访问密钥 (Access Key 和 Secret Key)。
124124
3. 如果是新建的火山账号,还需确认是否已经授权给`ServerlessApplicationRole`角色。进入[创建应用页面](https://console.volcengine.com/vefaas/region:vefaas+cn-beijing/application/create)点击[一键授权]即可。
125-
![一键授权](./assets/images/deploy/add_permission.png)
125+
![一键授权](../assets/images/deploy/add_permission.png)
126126

127127
```yaml
128128
volcengine:
@@ -324,7 +324,7 @@ Confirm delete cloud app my-python-agent? (y/N): y
324324
1. 登录 [火山引擎函数服务 (veFaaS) 控制台](https://console.volcengine.com/vefaas)。
325325
2. 在左侧导航栏中,选择 **我的应用**。
326326
3. 在应用列表中,你应该能看到你刚刚部署的应用。你可以单击应用名称进入详情页,查看其配置、日志、监控和访问端点等信息。
327-
![部署完成](./assets/images/deploy/deploy_agent.png)
327+
![部署完成](../assets/images/deploy/deploy_agent.png)
328328

329329
### 调用方法
330330

@@ -370,7 +370,7 @@ if __name__ == "__main__":
370370
```
371371

372372
> ⚠️ **注意**:上述 `CloudApp` 的直接调用方式默认不会携带认证信息。如果你的 API 网关开启了密钥认证,此调用会失败。你需要使用下一种方式,或临时关闭认证插件。
373-
> ![关闭插件](./assets/images/deploy/close_key_auth.png)
373+
> ![关闭插件](../assets/images/deploy/close_key_auth.png)
374374

375375
**方式二:作为子 Agent 远程调用 (使用 `RemoteVeAgent`)**
376376

@@ -471,16 +471,16 @@ if __name__ == "__main__":
471471
与函数服务和 API 网关类似,首次访问这些服务时,你需要根据页面提示完成 **IAM 角色授权**。
472472
#### 持续交付
473473
1. 首次进入 [持续交付](https://console.volcengine.com/cp) 页面,控制台将会提醒你进行IAM角色的开通,请点击【立即授权】同意角色开通。
474-
![IAM 角色开通](./assets/images/deploy/cp_attach_role.png)
474+
![IAM 角色开通](../assets/images/deploy/cp_attach_role.png)
475475
2. 点击授权后,控制台将会继续为你开通服务,界面如下。
476-
![IAM 服务开通](./assets/images/deploy/cp_open.png)
476+
![IAM 服务开通](../assets/images/deploy/cp_open.png)
477477
3. 当点击【申请开通】后,控制台将会自动跳转。当展示如下页面时,[持续交付](https://console.volcengine.com/cp)` 服务即开通成功。
478-
![IAM 角色开通](./assets/images/deploy/cp_index.png)
478+
![IAM 角色开通](../assets/images/deploy/cp_index.png)
479479
#### 镜像仓库
480480
1. 首次进入 [镜像仓库](https://console.volcengine.com/cr) 页面,控制台将会提醒你进行IAM角色的开通,请点击【立即授权】同意角色开通。
481-
![IAM 角色开通](./assets/images/deploy/cr_attach_role.png)
481+
![IAM 角色开通](../assets/images/deploy/cr_attach_role.png)
482482
3. 点击授权后,控制台将会自动跳转。当展示如下页面时,[持续交付](https://console.volcengine.com/cp) 服务即开通成功。
483-
![IAM 角色开通](./assets/images/deploy/cr_index.png)
483+
![IAM 角色开通](../assets/images/deploy/cr_index.png)
484484

485485

486486
### 2. 挂载持续交付流水线

docs/docs/deploy/evaluation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ VeADK 提供了以下三种方式来评测您的 Agent:
3939

4040
1. **基于网页的用户界面(veadk web)**
4141
通过基于网页的界面,以交互方式评测 Agent 。操作过程中可直接在网页上与 Agent 互动,实时观察其表现并进行评测。
42-
![evaluation-web-ui](./assets/images/evaluation/veadk_web_eval.gif)
42+
![evaluation-web-ui](../assets/images/evaluation/veadk_web_eval.gif)
4343
2. **命令行界面(veadk eval)**
4444
直接从命令行对现有的评测集文件运行评测。无需打开图形界面,通过输入命令即可快速执行评测操作,适合熟悉命令行的开发人员。
45-
![evaluation-cli](./assets/images/evaluation/veadk_eval.gif)
45+
![evaluation-cli](../assets/images/evaluation/veadk_eval.gif)
4646
3. **编程方式(pytest)**
4747
使用 pytest(Python 的一种测试框架)和测试文件,将评测集成到您的测试流程中。这种方式适合自动化测试场景,可与现有开发测试链路无缝衔接。
4848

docs/docs/deploy/optimization.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,14 @@ veadk_rl_ark_project
9090
1. 脚手架中,基于 VeADK 的天气查询 Agent 进行强化学习优化
9191
2. 提交任务 (veadk rl submit --platform ark)
9292

93-
![提交任务](./assets/images/optimization/submit_task.png)
93+
![提交任务](../assets/images/optimization/submit_task.png)
9494

95-
![训练中](./assets/images/optimization/training.png)
95+
![训练中](../assets/images/optimization/training.png)
9696
3. 查看训练日志和时间线
9797

98-
![查看训练日志](./assets/images/optimization/logs.png)
98+
![查看训练日志](../assets/images/optimization/logs.png)
9999

100-
![查看训练时间线](./assets/images/optimization/timeline.png)
100+
![查看训练时间线](../assets/images/optimization/timeline.png)
101101

102102
### Agent Lightning
103103

@@ -163,6 +163,6 @@ veadk_rl_lightning_project
163163
1. 脚手架中,基于 VeADK 的天气查询 Agent 进行强化学习优化
164164
2. 启动 client (veadk rl run --platform lightning --client) 与 server (veadk rl run --platform lightning --server),分别在终端1与终端2中运行以上命令
165165

166-
![启动client](./assets/images/optimization/lightning_client.png)
166+
![启动client](../assets/images/optimization/lightning_client.png)
167167

168-
![启动server](./assets/images/optimization/lightning_training_server.png)
168+
![启动server](../assets/images/optimization/lightning_training_server.png)

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +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
49+
- Responses API: agent/responses-api.md
5050
- 执行引擎:
5151
- Runner: runner.md
5252
- 个性化引擎——记忆:

0 commit comments

Comments
 (0)