Skip to content

Commit f85d6a5

Browse files
yaozheng-fangyaozheng-fang
authored
docs: update docs and README.md (#356)
* chore: update docs * fix docs * fallback req.txt * update png
1 parent 0e60c8b commit f85d6a5

File tree

4 files changed

+25
-18
lines changed

4 files changed

+25
-18
lines changed

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ git clone ... # clone repo first
3333

3434
cd veadk-python
3535

36-
uv venv --python 3.10
36+
# create a virtual environment with python 3.12
37+
uv venv --python 3.12
3738

3839
# only install necessary requirements
3940
uv sync
@@ -63,7 +64,7 @@ model:
6364
api_key: # <-- set your Volcengine ARK api key here
6465
```
6566
66-
You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
67+
You can refer to the [config instructions](https://volcengine.github.io/veadk-python/configuration/) for more details.
6768
6869
## Have a try
6970

‎docs/docs/assets/images/observation/show_traceid.jpeg‎

751 KB
Loading

‎docs/docs/index.md‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ hide:
2121
}
2222
</style>
2323

24-
!!! tip "欢迎报名 2025 年度火山引擎冬季 Force 大会 “AI Agent开发工作坊”"
24+
!!! tip "🎉 欢迎报名 2025 年度火山引擎冬季 Force 大会 “AI Agent开发工作坊”"
2525

26-
**时间：**2025 年 12 月 19 日 14:00-18:00
26+
**⏰ 时间：**2025 年 12 月 19 日 14:00-18:00
2727

28-
**场地：**上海世博中心 6F-617
28+
**📌 场地：**上海世博中心 6F-617
2929

30-
**论坛简介：**AI Agent 工作坊，依托全流程的实际动手操作，并融合相关理论与最佳实践总结，助力参会者掌握从零到一构建企业级 AI Agent 的实战能力，使其具备涵盖 Agent 设计、开发、部署、运维以及持续评估与优化的完整技能体系。借助 AI IDE TRAE 和火山的 Agent SDK VeADK，推动 AI Agent快速落地，实现 Vibe 编程，助力参与者完成基础的 Agent 开发并加速进阶；通过集成和使用 Agentkit，促使 AI Agent 实现从 Research 到 Production - Ready 的能力跨越；运用 Agentkit Identity，达成用户到智能体、智能体到智能体、智能体到 MCP 工具的全链路零信任安全；通过Agentkit MCP 网关，实现存量应用向智能体的迁移与复用；利用 AgentKit 罗盘评测工具，对智能体进行持续评估和质量监测；基于面向真实客户场景的最佳实践闭环，加速 AI 从试点应用迈向规模化应用的落地进程。通过样例库介绍和动手实验，构建共创、行动、反馈的迭代机制。
30+
**📄 简介：**AI Agent 工作坊，依托全流程的实际动手操作，并融合相关理论与最佳实践总结，助力参会者掌握从零到一构建企业级 AI Agent 的实战能力，使其具备涵盖 Agent 设计、开发、部署、运维以及持续评估与优化的完整技能体系。借助 AI IDE TRAE 和火山的 Agent SDK VeADK，推动 AI Agent快速落地，实现 Vibe 编程，助力参与者完成基础的 Agent 开发并加速进阶；通过集成和使用 Agentkit，促使 AI Agent 实现从 Research 到 Production - Ready 的能力跨越；运用 Agentkit Identity，达成用户到智能体、智能体到智能体、智能体到 MCP 工具的全链路零信任安全；通过Agentkit MCP 网关，实现存量应用向智能体的迁移与复用；利用 AgentKit 罗盘评测工具，对智能体进行持续评估和质量监测；基于面向真实客户场景的最佳实践闭环，加速 AI 从试点应用迈向规模化应用的落地进程。通过样例库介绍和动手实验，构建共创、行动、反馈的迭代机制。
3131

3232
<a class="openai-button" href="https://www.volcengine.com/contact/force-2512">点击报名</a>
3333

@@ -82,6 +82,12 @@ hide:
8282

8383
---
8484

85+
## 使用 VeADK 构建 DeepResearch
86+
87+
![type:video](https://veadk.tos-cn-beijing.volces.com/doc-assets/veadk_deepresearch.mp4)
88+
89+
---
90+
8591
<div class="grid cards" markdown>
8692

8793
- :material-account-group:{ .lg .middle } __多生态与模型兼容__
@@ -136,22 +142,22 @@ VeADK 各组件与火山引擎相关产品的结合矩阵：
136142
| | [**VeSearch**](https://www.volcengine.com/docs/85508/1512748)（联网问答Agent） | 提供信息搜索与云端自动整合功能 |
137143
| | [**Web Scraper**](https://www.volcengine.com/docs/84296/1545470) | 定制化内容查询（邀测） |
138144
| | [**飞书 Lark**](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction) | 进行飞书相关操作 |
139-
| | [**AI 数据湖服务 LAS(Lake AI Service)**](https://www.volcengine.com/product/las)| 提供开放、低成本、高性能的AI数据湖，海量数据存储与查询能力 |
145+
| | [**AI 数据湖服务 LAS**](https://www.volcengine.com/product/las)| 提供开放、低成本、高性能的AI数据湖，海量数据存储与查询能力 |
140146
| **短期记忆** | [**MySQL**](https://www.volcengine.com/docs/6313) | 提供使用 MySQL 数据库存储短期记忆，提供高性能读写能力，可实现持久化 |
141147
| | [**PostgreSQL**](https://www.volcengine.com/product/rds-pg) | 提供使用 PostgreSQL 数据库存储短期记忆，提供高性能读写能力，可实现持久化 |
142148
| | [**火山引擎云数据库 MySQL 版**](https://www.volcengine.com/product/rds-mysql) | 记忆存储 |
143-
| **长期记忆** | [**云搜索服务**](https://www.volcengine.com/product/es)(OpenSearch) | 兼容 OpenSearch，支持向量搜索等能力 |
149+
| **长期记忆** | [**云搜索服务**](https://www.volcengine.com/product/es) (OpenSearch) | 兼容 OpenSearch，支持向量搜索等能力 |
144150
| | [**Redis**](https://www.volcengine.com/product/redis) | Redis 作为长期记忆存储，支持 Redisearch 功能 |
145-
| | [**viking**](https://www.volcengine.com/docs/84313/1254437) | 知识向量化存储和检索 |
146-
| **知识库** | [**viking**](https://www.volcengine.com/docs/84313/1254437) | 知识向量化存储和检索 |
147-
| | [**mysql**](https://www.volcengine.com/docs/6313) | 提供使用 MySQL 数据库存储短期记忆，提供高性能读写能力，不具备向量搜索功能 |
148-
| | [**redis**](https://www.volcengine.com/product/redis) | Redis 作为长期记忆存储，支持 Redisearch |
149-
| | [**云搜索服务**](https://www.volcengine.com/product/es)(OpenSearch) | 知识向量化存储和检索 |
150-
| **可观测** | [**应用性能监控全链路版**](https://www.volcengine.com/product/apmplus)(APMPlus) | 调用链路观测 |
151+
| | [**Viking 记忆库**](https://www.volcengine.com/docs/84313/1860687?lang=zh) | 知识向量化存储和检索 |
152+
| **知识库** | [**Viking 知识库**](https://www.volcengine.com/docs/84313/1860732?lang=zh) | 知识向量化存储和检索 |
153+
| | [**MySQL**](https://www.volcengine.com/docs/6313) | 提供使用 MySQL 数据库存储短期记忆，提供高性能读写能力，不具备向量搜索功能 |
154+
| | [**Redis**](https://www.volcengine.com/product/redis) | Redis 作为长期记忆存储，支持 Redisearch |
155+
| | [**云搜索服务**](https://www.volcengine.com/product/es) (OpenSearch) | 知识向量化存储和检索 |
156+
| **可观测** | [**应用性能监控全链路版**](https://www.volcengine.com/product/apmplus) (APMPlus) | 调用链路观测 |
151157
| | [**扣子罗盘**](https://www.coze.cn/loop)(CozeLoop) | 调用链路观测 |
152-
| | [**日志服务**](https://www.volcengine.com/product/tls)(TLS) | 调用链路观测、日志存储与检索 |
153-
| **评测** | [**扣子罗盘**](https://www.coze.cn/loop)(CozeLoop) | 在线评测 |
154-
| **云部署** | [**火山引擎函数服务**](https://www.volcengine.com/product/vefaas)(VeFaaS) | 提供一键上云能力 |
158+
| | [**日志服务**](https://www.volcengine.com/product/tls) (TLS) | 调用链路观测、日志存储与检索 |
159+
| **评测** | [**扣子罗盘**](https://www.coze.cn/loop) (CozeLoop) | 在线评测 |
160+
| **云部署** | [**火山引擎函数服务**](https://www.volcengine.com/product/vefaas) (VeFaaS) | 提供一键上云能力 |
155161
| | [**火山引擎 API 网关**](https://www.volcengine.com/product/apig) | 提供鉴权、路由等能力 |
156162
| | [**火山引擎持续交付**](https://www.volcengine.com/product/cp) | 提供用户仓库向 VeFaaS 进行基于镜像的持续交付部署 |
157163
| | [**火山引擎镜像仓库**](https://www.volcengine.com/product/cr) | 提供用户代码镜像托管维护 |

‎docs/docs/observation/tracing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Tracing 指的是对智能体执行过程的**全链路记录与追踪**。
204204

205205
开启后，您可以看到日志中可以打印出相关 Tracing 数据的 ID：
206206

207-
【图】
207+
![TraceID示意](../assets/images/observation/show_traceid.jpeg)
208208

209209
!!! tip "与 OpenTelemetry 的兼容性"
210210
VeADK 相关字段命名遵循 OpenTelemetry 生成式 AI 规范，您可以直接将 Tracing 数据导入到 OpenTelemetry 兼容的系统中进行分析和可视化。

0 commit comments

Comments
 (0)