11# 快速入门
22
3- 本指南将引导您使用 “Basic Agent App” 模板开发一个简单的 ** Agent** ,快速体验 ** AgentKit** 从开发、部署到测试的全流程。
3+ 本指南将引导您使用 “Basic Agent App” 模板开发一个简单的 ** Agent** ,快速体验 ** AgentKit** 从开发、部署到测试的全流程。AgentKit 提供多种模板,包括基础应用、流式输出、A2A 协议等,支持 Python 和 Golang 开发。
44
55## 准备工作
66
@@ -30,7 +30,35 @@ export VOLCENGINE_SECRET_KEY=<your_secret_key>
3030 ![ API Key管理] ( ../../public/images/model_apikey.jpg )
3131
3232请记录下您的 ** Endpoint ID** 如` ep-20250520174054-xxxxx ` (也可以是模型ID如 ` deepseek-v3-1-terminus ` )和 ** API Key** ,后续将通过环境变量` MODEL_AGENT_NAME ` 和` MODEL_AGENT_API_KEY ` 配置给 ** Agent**
33- > 如果您不提供这些信息,** AgentKit Platform** 将在云端部署时自动为您注入一个内置的 ` doubao-seed-1-6 ` 模型,本地调试也默认使用该内置模型。
33+ > 如果您不提供这些信息,** AgentKit Platform** 将在云端部署时自动为您注入一个内置的 ` doubao-seed-1-6 ` 模型。
34+
35+ ### 3. 本地调试凭证配置 (Local 模式必读)
36+
37+ 如果您计划在本地 (Local 模式) 运行和调试 Agent,由于本地环境无法自动注入云端凭证,您** 必须** 手动配置访问凭证,否则 Agent 将无法调用大模型。
38+
39+ 您可以通过以下两种方式之一配置凭证:
40+
41+ ** 方式一:配置方舟模型凭证**
42+
43+ 直接指定要使用的模型接入点和 API Key:
44+
45+ ``` bash
46+ # 在 config 时通过 --runtime_envs (-e) 设置
47+ agentkit config -e MODEL_AGENT_NAME=< your_endpoint_id> -e MODEL_AGENT_API_KEY=< your_api_key>
48+ ```
49+
50+ ** 方式二:配置火山引擎访问密钥**
51+
52+ 如果配置了火山引擎的 AK/SK,veADK 会尝试自动获取您的模型访问权限:
53+
54+ ``` bash
55+ # 在 config 时通过 --runtime_envs (-e) 设置
56+ agentkit config -e VOLCENGINE_ACCESS_KEY=< your_access_key> -e VOLCENGINE_SECRET_KEY=< your_secret_key>
57+ ```
58+
59+ > ** 注意** :
60+ > 1 . 在 Local 模式下,直接在宿主机 shell 中 ` export ` 环境变量对容器内无效,必须使用 ` agentkit config -e ` 将其写入 ` agentkit.yaml ` 的 ` runtime_envs ` 中。
61+ > 2 . 在 Cloud 模式下,Runtime 会自动注入相关凭证,通常无需手动配置上述环境变量。
3462
3563## 开始使用
3664
@@ -47,7 +75,18 @@ mkdir simple-agent && cd simple-agent
4775agentkit init
4876```
4977
50- 执行后会显示可用模板列表,选择模板 ` 1 ` (Basic Agent App):
78+ 执行后会显示可用模板列表,选择模板 ` 1 ` (Basic Agent App)。您也可以使用 ` --template ` 参数直接指定模板:
79+
80+ ``` bash
81+ # 使用基础模板
82+ agentkit init --template basic
83+
84+ # 使用流式输出模板
85+ agentkit init --template basic_stream
86+
87+ # 查看所有可用模板
88+ agentkit init --list-templates
89+ ```
5190
5291命令执行后,将在当前目录生成模板代码和配置文件:
5392``` txt
@@ -70,19 +109,19 @@ agentkit config
70109配置向导会引导您完成以下设置:
71110
72111** 通用配置** (按 回车 使用默认值):
73- - ** 1.应用名称** :Agent 应用名称(模板1, 默认值为 ` simple_agent ` ,如接纳直接回车即可(下同) )
74- - ** 2.入口文件** :应用入口文件(模板1, 默认值为 ` simple_agent.py ` )
112+ - ** 1.应用名称** :Agent 应用名称(默认值为 ` simple_agent ` ,可直接按回车使用默认值 )
113+ - ** 2.入口文件** :应用入口文件(默认值为 ` simple_agent.py ` )
75114- ** 3.应用描述** :应用描述信息(可选)
76- - ** 4.Python 版本 ** :默认 3.12
77- - ** 5.依赖文件** :默认 ` requirements.txt `
115+ - ** 4.编程语言 ** :Python 或 Golang( 默认 Python)
116+ - ** 5.依赖文件** :默认 ` requirements.txt ` 或 ` go.mod `
78117- ** 6.Agent应用内部Runtime常用环境变量** :
79118 - ` MODEL_AGENT_NAME ` :方舟模型接入点 ID(可选)
80119 - ` MODEL_AGENT_API_KEY ` :方舟模型 API Key(可选)
81120- ** 7.部署模式** :选择 ` cloud ` (云端构建和部署)
82121
83122** 云端部署配置** :
84123- ** 1.服务区域** :默认 ` cn-beijing `
85- - ** 2.镜像标签** :默认 ` latest `
124+ - ** 2.镜像标签** :默认 ` {{timestamp}} ` , 会自动渲染为时间戳,格式如20251218154940
86125- ** 3.CR 镜像仓库** :CLI 会自动生成CR实例名称、CR命名空间和CR仓库名,用户也可手动指定(建议自动即可)
87126
88127完成配置后,执行 ` launch ` 命令即可一键部署:
@@ -142,4 +181,5 @@ Using default headers: {'user_id': 'agentkit_user', 'session_id': 'agentkit_samp
142181
143182接下来您可以:
144183- 探索其他应用模板(MCP、A2A 等)
145- - 集成 Memory、Knowledge 等 Platform 服务,开发更强大的 ** Agent**
184+ - 集成 Memory、Knowledge、Tools 等 Platform 服务,开发更强大的 ** Agent**
185+ - 使用 ` agentkit memory ` 、` agentkit knowledge ` 、` agentkit tools ` 等命令管理平台服务
0 commit comments