Skip to content

Commit 8aed663

Browse files
committed
docs: update usage of command line and fix typos in deploy.md
1 parent 3b8b78a commit 8aed663

File tree

2 files changed

+33
-7
lines changed

2 files changed

+33
-7
lines changed

docs/docs/cli.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,43 @@
1-
# 命令行工具Vego
1+
# 命令行工具VeADK
22

33
## 提示词优化
44

5-
主要用来优化系统提示词(System prompt)。
5+
用来优化 Agent 的系统提示词(System prompt)。
66

77
```bash
8-
vego prompt
8+
veadk prompt
99
```
1010

11+
选项包括:
12+
13+
- `--path`:指定要优化的 Agent 文件路径,默认值为当前目录下的 `agent.py` 文件。注意,必须将你定义的智能体作为全局变量导出
14+
- `--feedback`:指定优化后的提示词反馈,用于优化模型
15+
- `--api-key`:指定 AgentPilot 平台的 API Key,用于调用优化模型
16+
- `--model-name`:指定优化模型的名称,默认值为 `doubao-1.5-pro-32k-250115`
17+
1118
## 一键上云部署
1219

13-
可直接将本地项目部署到火山引擎FaaS平台上
20+
可直接将本地项目部署到火山引擎 FaaS 平台上
1421

1522
```bash
16-
vego deploy
17-
```
23+
veadk deploy
24+
```
25+
26+
选项包括:
27+
28+
- `--access-key`:指定火山引擎的 Access Key,用于调用 FaaS 平台的 API
29+
- `--secret-key`:指定火山引擎的 Secret Key,用于调用 FaaS 平台的 API
30+
- `--name`:指定部署的应用名称,用于在 FaaS 平台上标识该部署
31+
- `--path`:指定项目路径,默认值为当前目录
32+
33+
## 本地调试
34+
35+
可以通过`adk web``veadk studio`来启动Web页面,运行智能体:
36+
37+
```bash
38+
adk web
39+
# or
40+
veadk studio
41+
```
42+
43+
它们能够自动读取执行命令目录中的`agent.py`文件,并加载`root_agent`全局变量。

docs/docs/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ cloud_app.create_session(user_id=..., session_id=...)
2222

2323
# 发起任务
2424
cloud_app.invoke(user_id=..., session_id=..., message=...)
25-
```
25+
```

0 commit comments

Comments
 (0)