Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/docs/agent/prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,25 @@

## CozeLoop 提示词管理

您可以通过 CozeLoop 云端提示词管理功能来对接您的 Agent 系统提示词。

### 准备

在使用 CozeLoop 进行提示词管理前,您需要安装 Python 版本的 `cozeloop` SDK:

```bash
pip install cozeloop
```

您可以通过 CozeLoop 云端提示词管理功能来对接您的 Agent 系统提示词。例如:
### 属性获取

- [了解如何获取 CozeLoop Workspace ID](https://loop.coze.cn/open/docs/cozeloop/authentication-for-sdk#05d27a86)
- [了解如何获取 CozeLoop Token / API Key](https://loop.coze.cn/open/docs/cozeloop/authentication-for-sdk)
- 您可以在 CozeLoop 中的 “Prompt 开发” 板块获取 Prompt Key,如下图所示:

![img](../assets/images/cozeloop_prompt_key.png)

### 使用方法

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

prompt_manager = CozeloopPromptManager(
cozeloop_workspace_id="", # CozeLoop workspace ID
cozeloop_token="", # CozeLoop token
cozeloop_token="", # CozeLoop token / api key
prompt_key="", # CozeLoop 中创建的 Prompt Key
label="production", # CozeLoop 中创建的 Prompt 标签
)
Expand Down
15 changes: 8 additions & 7 deletions docs/docs/agent/responses-api.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: Responses API支持
title: Responses API 支持
---

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

---

## 使用教程

目前Veadk ResponsesAPI支持对litellm版本依赖有限制,需要`litellm>=1.79.3`,请确保您的litellm版本符合要求。
目前 VeADK Responses API 支持对 LiteLLM 版本依赖有限制,需要 `litellm>=1.79.3`,请确保您的 LiteLLM 版本符合要求。

=== "pip"
```bash
pip install "litellm>=1.79.3"
Expand All @@ -18,26 +20,25 @@ Responses API 是火山方舟最新推出的 API 接口,原生支持高效的
uv pip install "litellm>=1.79.3"
```


### 快速开始

只需要要配置enable_responses=True即可

```python hl_lines="4"
from veadk import Agent

root_agent = Agent(
enable_responses=True, # 开启responses api
enable_responses=True, # 开启 Responses API
)

```

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

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

## 注意事项

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

Binary file added docs/docs/assets/images/cozeloop_prompt_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions docs/docs/deploy/deploy-vefaas.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ title: 部署到 VeFaaS
### 函数服务

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

### API网关

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

## 部署方式概览

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

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

### 调用方法

Expand Down Expand Up @@ -370,7 +370,7 @@ if __name__ == "__main__":
```

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

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

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


### 2. 挂载持续交付流水线
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/deploy/evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ VeADK 提供了以下三种方式来评测您的 Agent:

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

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/deploy/optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@ veadk_rl_ark_project
1. 脚手架中,基于 VeADK 的天气查询 Agent 进行强化学习优化
2. 提交任务 (veadk rl submit --platform ark)

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

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

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

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

### Agent Lightning

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

![启动client](./assets/images/optimization/lightning_client.png)
![启动client](../assets/images/optimization/lightning_client.png)

![启动server](./assets/images/optimization/lightning_training_server.png)
![启动server](../assets/images/optimization/lightning_training_server.png)
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ nav:
- 多智能体交互: agent/agents.md
- A2A 协议: agent/agent-to-agent.md
- Prompt 管理: agent/prompt.md
- ResponsesAPI 支持: agent/responses-api.md
- Responses API: agent/responses-api.md
- 执行引擎:
- Runner: runner.md
- 个性化引擎——记忆:
Expand Down