11# Hello World Demo
22
33## 简介
4+
45构建一个最简单的聊天 Agent
56
67## 项目说明
8+
79本示例演示了 VeADK 的核心功能:
10+
811- ** Agent 创建** :使用简单的配置创建 AI Agent
912- ** 短期记忆** :使用本地后端(local backend)存储对话历史,实现会话级别的上下文记忆
1013- ** 多轮对话** :通过 session_id 关联对话,Agent 能记住之前的对话内容
1114
1215## 前置依赖
16+
13171 . ** 开通火山方舟模型服务** :前往 [ Ark console] ( https://exp.volcengine.com/ark?mode=chat )
14- 2 . ** 准备 model_api_key** :在控制台获取 ** API Key** 。
1518
1619## 运行方法
17- ### 1. 安装veadk和agentkit python sdk 配置环境变量
1820
19- ``` bash
20- uv pip install veadk-python
21- uv pip install agentkit-sdk-python
21+ ### 1. 环境配置
22+
23+ 若未安装 uv,请先安装(任选其一)
24+
2225```
26+ # macOS / Linux(官方安装脚本)
27+ curl -LsSf https://astral.sh/uv/install.sh | sh
28+ # 或使用 Homebrew(macOS)
29+ brew install uv
30+ ```
31+
32+ 初始化项目依赖
2333
24- 在 ` config.yaml ` 中设置你的模型信息:
25- ``` yaml
26- model :
27- agent :
28- name : doubao-seed-1-6-251015
29- api_key : XXXX
3034```
35+ uv sync
36+ source .venv/bin/activate
37+ ```
38+
39+ ## 2. 环境变量配置
40+
41+ ```
42+ export MODEL_AGENT_NAME=doubao-seed-1-6-251015
43+ # 这一步需要把YOUR_AK换成自己的ak
44+ export VOLCENGINE_ACCESS_KEY=YOUR_AK
45+ # 这一步需要把YOUR_AK换成自己的sk
46+ export VOLCENGINE_SECRET_KEY=YOUR_SK
47+ ```
48+
49+ ### 3. 运行本地客户端
3150
32- ### 2. 运行本地客户端
3351``` bash
34- python agent.py
52+ # 启动服务端
53+ uv run agent.py
54+
55+ # 启动客户端进行测试
56+ uv run client.py
3557```
3658
37- ### 3. 运行veadk web客户端并使用浏览器登录 http://127.0.0.1:8000
59+ ### 4. 运行veadk web客户端并使用浏览器登录 http://127.0.0.1:8000
60+
3861``` bash
3962cd ..
4063veadk web
4164
4265```
4366
44- ### 4. 部署到vefaas
67+ ### 5. 部署到vefaas
68+
4569> ** 安全提示:请勿在生产环境中禁用密钥认证。确保 ` VEFAAS_ENABLE_KEY_AUTH ` 保持为 ` true ` (或不设置,默认为开启),并正确配置访问密钥和角色。只有在本地受控环境调试时,才可临时关闭认证,并务必加以警告。**
4670
4771``` bash
@@ -53,38 +77,47 @@ export VOLCENGINE_ACCESS_KEY=YOUR_AK
5377# 这一步需要把YOUR_AK换成自己的sk
5478export VOLCENGINE_SECRET_KEY=YOUR_SK
5579# 这一步部署应用到云上
80+ veadk deploy --vefaas-app-name=hello-world --use-adk-web
81+ # 可以使用更多的复杂配置进行部署
5682veadk deploy --vefaas-app-name=hello-world --use-adk-web --veapig-instance-name=< your veapig instance name> --iam-role " trn:iam::<your account id>:role/<your iam role name>"
5783
5884```
5985
60- ### 5 . 部署到AgentKit 并且使用client.py测试
86+ ### 6 . 部署到AgentKit 并且使用client.py测试
6187
6288``` bash
6389cd hello_world
6490# Uncomment the following line in agent.py to run the agentkit app server
6591# agent_server_app.run(host="0.0.0.0", port=8000)
6692agentkit config
6793agentkit launch
94+
95+ # 使用命令进行调试
96+ agentkit invoke ' who r u'
6897```
6998
70- ## 示例 Prompt
99+ ## 7. 示例 Prompt
100+
71101示例代码展示了一个简单的两轮对话:
72102
73103** 第一轮对话** :
104+
74105```
75106输入:我叫VeADK
76107输出:你好VeADK!很高兴认识你。
77108```
78109
79110** 第二轮对话** (测试记忆功能):
111+
80112```
81113输入:你还记得我叫什么吗?
82114输出:当然记得,你叫VeADK。
83115```
84116
85117你也可以尝试以下对话:
118+
86119- "我今年25岁" → "我多大了?"
87120- "我喜欢编程" → "你知道我的爱好吗?"
88121- "我住在北京" → "你记得我住在哪里吗?"
89122
90- 这些示例展示了 Agent 如何在同一会话中保持上下文记忆。
123+ 这些示例展示了 Agent 如何在同一会话中保持上下文记忆。
0 commit comments