Skip to content

Commit 8a7f970

Browse files
authored
fix: udpate some typo of docs (#422)
* fix: udpate some typo of docs * fix: udpate default config * fix: udpate short term memory sample * fix: udpate long term memory backend
1 parent ebd543e commit 8a7f970

File tree

7 files changed

+30
-15
lines changed

7 files changed

+30
-15
lines changed

docs/docs/agent/agent-to-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ title: A2A Agent
3232

3333
| 场景名称 | 说明 |
3434
| - | - |
35-
| **内部代码组织** | 您在单个 Agent 内将复杂任务拆分为更小、可管理的函数或模块,这类场景出于性能与简洁考虑,更适合作为本地子 |
36-
| **性能关键的内部操作** | 某个 Sub Agent 负责与主 Agent 执行紧密耦合的高频、低延迟操作,这类场景由于需要低延迟响应,更适合作为本地Local Sub-Agents |
35+
| **内部代码组织** | 您在单个 Agent 内将复杂任务拆分为更小、可管理的函数或模块,这类场景出于性能与简洁考虑,更适合作为本地 Local Sub-Agents |
36+
| **性能关键的内部操作** | 某个 Sub Agent 负责与主 Agent 执行紧密耦合的高频、低延迟操作,这类场景由于需要低延迟响应,更适合作为本地 Local Sub-Agents |
3737
| **共享内存或上下文** | 当 Sub Agent 需要直接访问主 Agent 的内部状态或共享内存以提高效率时,A2A 的网络开销与序列化/反序列化会适得其反 |
3838
| **简单的辅助函数** | 对于无需独立部署或复杂状态管理的小型复用逻辑,直接在同一 Agent 中编写函数或类,通常比拆分为独立的 A2A Agent 更合适 |
3939

docs/docs/configuration.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,13 @@ veidentity:
142142
| 名称 | 值 | 释义 |
143143
|------|----|------|
144144
| DEFAULT_AGENT_NAME | `veAgent` | Agent 的缺省名称 |
145-
| DEFAULT_MODEL_AGENT_NAME | `doubao-seed-1-6-250615` | Agent 的推理模型名称 |
146-
| DEFAULT_MODEL_AGENT_PROVIDER | `openai` | Agent 的推理模型提供商 |
145+
| DEFAULT_MODEL_AGENT_NAME | `doubao-seed-1-6-251015` | Agent 的推理模型名称 |
146+
| DEFAULT_MODEL_AGENT_PROVIDER | `openai` | Agent 的推理模型提供商,方舟平台兼容 openai 规范,因此使用方舟默认是 openai 即可 |
147147
| DEFAULT_MODEL_AGENT_API_BASE | `https://ark.cn-beijing.volces.com/api/v1/` | 模型 API 基础地址 |
148+
| DEFAULT_IMAGE_GENERATE_MODEL_NAME | `doubao-seedream-4-5-251128` | image_generate 工具默认使用的方舟生图模型 |
149+
| DEFAULT_IMAGE_GENERATE_MODEL_API_BASE | `https://ark.cn-beijing.volces.com/api/v3/` | image_generate 工具默认使用的方舟生图模型 API 基础地址 |
150+
| DEFAULT_VIDEO_MODEL_NAME | `doubao-seedance-1-5-pro-251215` | video_generate 工具默认使用的方舟视频生成模型 |
151+
| DEFAULT_VIDEO_MODEL_API_BASE | `https://ark.cn-beijing.volces.com/api/v3/` | video_generate 工具默认使用的方舟视频生成模型 API 基础地址 |
148152
| DEFAULT_APMPLUS_OTEL_EXPORTER_ENDPOINT | `http://apmplus-cn-beijing.volces.com:4317` | APMPlus OpenTelemetry Trace 导出地址 |
149153
| DEFAULT_APMPLUS_OTEL_EXPORTER_SERVICE_NAME | `veadk_tracing` | APMPlus 服务名 |
150154
| DEFAULT_COZELOOP_OTEL_EXPORTER_ENDPOINT | `https://api.coze.cn/v1/loop/opentelemetry/v1/traces` | CozeLoop OTEL Trace 上报地址 |
@@ -155,5 +159,5 @@ veidentity:
155159
| DEFAULT_CR_REPO_NAME | `veadk-user-repo` | 容器镜像仓库名称 |
156160
| DEFAULT_TLS_LOG_PROJECT_NAME | `veadk-logs` | TLS 日志项目名称 |
157161
| DEFAULT_TLS_TRACING_INSTANCE_NAME | `veadk-tracing` | TLS Tracing 实例名称 |
158-
| DEFAULT_TOS_BUCKET_NAME | `veadk-default-bucket` | 默认 TOS 存储桶名称 |
162+
| DEFAULT_TOS_BUCKET_NAME | `veadk-default-bucket` | 默认 TOS 存储桶名称,由于 TOS 存储桶全球唯一,因此强烈建议用户自定义存储桶名称,避免与其他用户冲突导致运行失败 |
159163
| DEFAULT_COZELOOP_SPACE_NAME | `VeADK Space` | CozeLoop 空间名称 |

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ hide:
116116

117117
---
118118

119-
提供短期记忆与长期记忆的完整解决方案:短期记忆可基于 MySQL 实现持久化存储;长期记忆则依托 Viking DB、云搜索服务构建。VeADK 以 LlamaINdex 作为知识库核心处理入口,同时支持 Viking 知识库后端无缝接入。
119+
提供短期记忆与长期记忆的完整解决方案:短期记忆可基于 MySQL 实现持久化存储;长期记忆则依托 Viking DB、云搜索服务构建。VeADK 以 LlamaIndex 作为知识库核心处理入口,同时支持 Viking 知识库后端无缝接入。
120120

121121
- :material-toolbox:{ .lg .middle } __内置丰富工具和生态集成__
122122

docs/docs/memory/long-term-memory.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,16 @@ title: 长期记忆
1717

1818
## 支持后端类型
1919

20-
| 类别 | 说明 |
20+
调试可以用 `local` 后端。生产更建议使用 `viking``mem0` 后端。
21+
22+
| 类别 | 说明 |
2123
| :----------- | :--------------------------------------------------------- |
22-
| `local` | 内存跨 Session 记忆,程序结束后即清空 |
23-
| `opensearch` | 使用 OpenSearch 作为长期记忆存储,可实现持久化和检索 |
24-
| `redis` | 使用 Redis 作为长期记忆存储,Redis 需要支持 Rediseach 功能 |
25-
| `viking` | 使用 VikingDB 记忆库产品作为长期记忆存储 |
26-
| `viking_mem` | 已废弃,设置后将会自动转为 `viking` |
24+
| `local` | 内存跨 Session 记忆,程序结束后即清空 (仅适用于本地调试) |
25+
| `viking` | 使用 VikingDB 记忆库产品作为长期记忆存储 (生产推荐) |
26+
| `mem0` | 使用 Mem0 记忆库产品作为长期记忆存储 (生产推荐) |
27+
| `viking_mem` | 已废弃,设置后将会自动转为 `viking` |
28+
| `opensearch` | 使用 OpenSearch 作为长期记忆存储,可实现持久化和检索 |
29+
| `redis` | 使用 Redis 作为长期记忆存储,Redis 需要支持 Rediseach 功能 |
2730

2831
## 初始化方法
2932

docs/docs/memory/short-term-memory.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,15 +211,23 @@ VeADK 中,您可以使用如下短期记忆后端服务来初始化您的短
211211
```python
212212
from google.adk.apps.app import App
213213
from google.adk.apps.app import EventsCompactionConfig
214+
from veadk.agent import Agent
215+
216+
root_agent = Agent(
217+
description="hello world agent",
218+
instruction="""你是一个智能助手,擅长用中文礼貌回复用户的问题。""",
219+
)
214220

215221
app = App(
216-
name='my-agent',
222+
name='my_agent',
217223
root_agent=root_agent,
218224
events_compaction_config=EventsCompactionConfig(
219225
compaction_interval=3, # 每 3 次新调用触发一次压缩。
220226
overlap_size=1 # 包含前一个窗口的最后一次事件重叠。
221227
),
222228
)
229+
230+
root_agent = agent
223231
```
224232

225233
### 定义压缩器

docs/docs/veadk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ graph LR
4141

4242
## VeADK 体系结构
4343

44-
VeADK 基于模块化设计,主要组件包括:智能体运行时、工具、记忆系统、知识库、观测系统、评测系统等。各组件通过明确的接口进行解耦,以便在不同业务场景下替换或扩展。
44+
VeADK 基于模块化设计,主要组件包括:执行引擎、工具、记忆系统、知识库、观测系统、评测系统等。各组件通过明确的接口进行解耦,以便在不同业务场景下替换或扩展。
4545

4646
### 核心组件
4747

veadk/consts.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
DEFAULT_TLS_LOG_PROJECT_NAME = "veadk-logs"
5959
DEFAULT_TLS_TRACING_INSTANCE_NAME = "veadk-tracing"
6060

61-
DEFAULT_TOS_BUCKET_NAME = "ark-tutorial"
61+
DEFAULT_TOS_BUCKET_NAME = "veadk-default-bucket"
6262

6363
DEFAULT_COZELOOP_SPACE_NAME = "VeADK Space"
6464

0 commit comments

Comments
 (0)