Skip to content

Commit dfd49e1

Browse files
fix(docs): add imports in doc (#364)
1 parent 2fb31b3 commit dfd49e1

File tree

2 files changed

+41
-22
lines changed

2 files changed

+41
-22
lines changed

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

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,30 +30,24 @@ title: 长期记忆
3030
在使用长期记忆之前,需要实例化 LongTermMemory 对象并指定后端类型。以下代码展示了如何初始化基于 VikingDB 的长期记忆模块,并将其绑定到 Agent:
3131

3232
```python
33-
os.environ["DATABASE_VIKING_PROJECT"] = "default"
34-
os.environ["DATABASE_VIKING_REGION"] = "cn-beijing"
33+
from veadk import Agent, Runner
34+
from veadk.memory import LongTermMemory
3535

3636
# 初始化长期记忆
3737
# backend="viking" 指定使用 VikingDB
3838
# app_name 和 user_id 用于数据隔离
3939
long_term_memory = LongTermMemory(
40-
backend="viking",
41-
app_name="local_memory_demo",
42-
user_id="demo_user"
40+
backend="viking", app_name="local_memory_demo", user_id="demo_user"
4341
)
4442

4543
# 将长期记忆绑定到 Agent
4644
root_agent = Agent(
47-
name='minimal_agent',
45+
name="minimal_agent",
4846
instruction="Acknowledge user input and maintain simple conversation.",
49-
short_term_memory=short_term_memory, # 短期记忆实例
47+
long_term_memory=long_term_memory, # 长期记忆实例
5048
)
5149

52-
# 初始化 Runner 时传入 shared memory 对象
53-
runner = Runner(
54-
agent=root_agent,
55-
long_term_memory=long_term_memory, # 长期记忆实例
56-
)
50+
runner = Runner(agent=root_agent)
5751
```
5852

5953
## 记忆管理
@@ -64,10 +58,8 @@ runner = Runner(
6458

6559
```python
6660
# 假设 runner1 已经完成了一次对话
67-
completed_session = await runner1.session_service.get_session(
68-
app_name=APP_NAME,
69-
user_id=USER_ID,
70-
session_id=session_id
61+
completed_session = await runner.session_service.get_session(
62+
app_name=APP_NAME, user_id=USER_ID, session_id=session_id
7163
)
7264

7365
# 将完整会话归档到长期记忆
@@ -146,7 +138,7 @@ async for event in runner2.run_async(user_id=USER_ID, session_id=session_id, new
146138
- 提供连续性强、个性化的多会话交互体验;
147139
- 为长期任务、学习型应用或持续监控场景提供基础能力。
148140

149-
```
141+
```text
150142
[Log Output]
151143
Runner1 Question: My favorite project is Project Alpha.
152144
Runner1 Answer: (Acknowledged)

docs/docs/observation/ve-tracing.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@ title: 在火山引擎观测
33
---
44

55
## CozeLoop 平台
6+
67
通过 VeADK 开发的火山智能体接入到扣子罗盘之后,可以通过扣子罗盘的评测功能进行 Agent 评测,或者通过 Trace 功能实现调用链路观测。火山智能体的 Trace 数据可以直接上报至扣子罗盘,实现调用链路观测;在扣子罗盘中注册的火山智能体,也可以通过观测功能进行 Agent 评测。
8+
79
### 准备工作
10+
811
在 VeADK 配置文件 config.yaml 的 observability 字段中填写 cozeloop 的属性。关于配置文件的详细说明及示例可参考配置文件。
912

10-
- endpoint:固定设置为 https://api.coze.cn/v1/loop/opentelemetry/v1/traces
13+
- endpoint:固定设置为 `https://api.coze.cn/v1/loop/opentelemetry/v1/traces`
1114
- api_key:扣子罗盘访问密钥,支持个人访问令牌、OAuth 访问令牌和服务访问令牌。获取方式可参考[配置个人访问令牌](https://loop.coze.cn/open/docs/cozeloop/authentication-for-sdk#05d27a86)
12-
- service_name:扣子罗盘工作空间的 ID。你可以在登录扣子罗盘之后,左上角切换到想要存放火山智能体数据的工作空间,并在 URL 的 space 关键词之后获取工作空间 ID,例如 https://loop.coze.cn/console/enterprise/personal/space/739XXXXXXXX092/pe/prompts 中,**739XXXXXXXX092**为工作空间 ID。
15+
- service_name:扣子罗盘工作空间的 ID。你可以在登录扣子罗盘之后,左上角切换到想要存放火山智能体数据的工作空间,并在 URL 的 space 关键词之后获取工作空间 ID,例如 `https://loop.coze.cn/console/enterprise/personal/space/739XXXXXXXX092/pe/prompts` 中,**739XXXXXXXX092**为工作空间 ID。
1316

1417
![cozeloop空间](../assets/images/observation/coze-spaceid.png)
1518

@@ -34,7 +37,9 @@ observability:
3437
```
3538
3639
### 部署运行
40+
3741
#### Cozeloop exporter接入代码
42+
3843
```python title="agent.py"
3944
import asyncio
4045

@@ -61,17 +66,24 @@ prompt = "How is the weather like in Beijing? Besides, tell me which tool you in
6166

6267
asyncio.run(runner.run(messages=prompt, session_id=session_id))
6368
```
69+
6470
#### 效果展示
71+
6572
```bash
6673
python agent.py
6774
```
75+
6876
![cozeloop空间](../assets/images/observation/coze-console.png)
77+
6978
![cozeloop空间](../assets/images/observation/coze-trace.png)
7079

7180
## APMPlus 平台
72-
通过 VeADK 开发的火山智能体接入到 APMPlus 之后,可以通过 APMPlus 的评测功能进行 Agent 评测,或者通过 Trace 功能实现调用链路观测。火山智能体的 Trace 数据可以直接上报至 APMPlus,实现调用链路观测。
81+
82+
通过 VeADK 开发的火山智能体可以通过定义 APMPlus 数据导出器接入到火山引擎 APMPlus 平台,实现调用链路观测。
83+
7384
### 准备工作
74-
- endpoint:指定APMPlus的接入点为 http://apmplus-cn-beijing.volces.com:4317。
85+
86+
- endpoint:指定APMPlus的接入点为 http://apmplus-cn-beijing.volces.com:4317
7587
- api_key:需填入有效应用程序密钥。
7688
- service_name:指定服务名称,可根据实际需求修改。
7789
初始化 APMPlusExporter:利用APMPlusExporterConfig配置端点、应用程序密钥和服务名称,创建APMPlusExporter实例,配置从环境变量获取。示例代码如下:
@@ -125,25 +137,35 @@ asyncio.run(runner.run(messages=prompt, session_id=session_id))
125137
```
126138

127139
### 部署运行
140+
128141
本地运行上述agent.py代码,触发APMPlus追踪器记录Agent运行的各个节点的调用,以及Metrics信息上传云端存储:
142+
129143
```bash
130144
python agent.py
131145
```
146+
132147
![apmplus空间](../assets/images/observation/apm-console.png)
133148

134149
#### 会话信息
150+
135151
![apmplus空间](../assets/images/observation/apm-session.png)
136152

137153
#### trace信息
154+
138155
![apmplus空间](../assets/images/observation/apm-trace.png)
139156

140157
#### 模型指标信息
158+
141159
![apmplus空间](../assets/images/observation/apm-metrics.png)
142160

143161
## TLS 平台
144-
通过 VeADK 开发的火山智能体接入到 TLS 之后,可以通过 TLS 的评测功能进行 Agent 评测,或者通过 Trace 功能实现调用链路观测。火山智能体的 Trace 数据可以直接上报至 TLS,实现调用链路观测。
162+
163+
通过 VeADK 开发的火山智能体可以通过定义 TLS 数据导出器来接入到火山引擎日志服务 TLS,并在 TLS 的观测功能模块中进行 Agent 执行链路观测。
164+
145165
### 准备工作
166+
146167
#### veADK代码中创建tracing project和实例
168+
147169
```yaml title="config.yaml"
148170
model:
149171
agent:
@@ -191,6 +213,7 @@ print(f"Created trace instance with ID: {trace_instance['TraceInstanceId']}")
191213
```
192214
193215
#### TLS Exporter接入代码示例
216+
194217
```python title="agent.py"
195218
import asyncio
196219

@@ -226,9 +249,13 @@ asyncio.run(runner.run(messages=prompt, session_id=session_id))
226249
```
227250

228251
### 部署运行
252+
229253
本地运行上述agent.py代码,触发TLS Project、Topic的创建,并且通过追踪器记录Agent运行的各个节点的调用:
254+
230255
```bash
231256
python agent.py
232257
```
258+
233259
![控制台打印](../assets/images/observation/tls-console.png)
260+
234261
![tls空间](../assets/images/observation/tls-trace.png)

0 commit comments

Comments
 (0)