docs: add production links and fix typos (#45)

yaozheng-fang · web-flow · commit c898ddaa4bb8 · 2025-08-12T11:27:13.000+08:00
* docs: add production links and fix typos

* fix links
diff --git a/README.md b/README.md
@@ -61,8 +61,8 @@ print(res)
 
 VeADK provides several useful command line tools for faster deployment and optimization, such as:
 
-- `veadk deploy`: deploy your project to Volcengine VeFaaS platform (you can use `veadk init` to init a demo project first)
-- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
 
 ## Contribution
 
diff --git a/docs/docs/README.md b/docs/docs/README.md
@@ -13,13 +13,13 @@ actions:
 
 features:
   - title: 更丰富的内置工具
-    details: Builtin工具，例如侧重头条、抖音搜索的web_search等；MCP工具，例如飞书Lark、数据湖LAS、优解PromptPilot等
+    details: Builtin工具，例如侧重头条、抖音搜索的WEB_SEARCH等；MCP工具，例如飞书Lark、数据湖LAS、优解PromptPilot等
   - title: 更灵活的功能扩展
     details: 提供Agent各类组件的基础实现，通过插件方式灵活扩展。
   - title: 更完备的观测和评估管理
     details: 运行时数据通过OpenTelemetry协议无缝衔接APMPlus、Cozeloop、TLS；运行时数据生成测试数据集文件，可直接在本地和Cozeloop中进行评估测试。
   - title: 更强大的知识和记忆管理
-    details: 知识库支持火山引擎各类现有数据库，例如关系型数据库、键值数据库、VikingDB知识库，记忆库等。
+    details: 知识库支持火山引擎各类现有数据库，例如关系型数据库、缓存数据库、VikingDB知识库、记忆库等。
   - title: 更科学的结果评测
     details: 提供不确定性Tools（例如搜索类）场景下的测评解决方案，弥补传统仅根据输入输出进行评测而导致评测结果不符合预期的问题。
   - title: 更友好的最佳实践
diff --git a/docs/docs/agent.md b/docs/docs/agent.md
@@ -22,6 +22,8 @@ Agent 中主要包括如下属性：
 | tracers | list | 追踪器列表，能够定义不同的追踪方式，并在 Agent 执行完毕后将整体 Tracing 信息保存至本地 |
 | serve_url | str | Agent 服务主机的 URL，将显示在 Agent Card 中 |
 
+您可以在[火山引擎方舟平台](https://www.volcengine.com/product/ark)选择适合您的大模型。
+
 ## 运行
 
 在生产环境中，我们推荐您使用 VeADK 的`Runner`执行器来进行多租户服务与 Agent 运行，在多租场景下，`Runner`通过三个属性来确定资源空间：
@@ -111,4 +113,4 @@ planner_agent = Agent(
 
 runner = Runner(agent=planner_agent, short_term_memory=ShortTermMemory())
 response = await runner.run(messages=prompt, session_id=session_id)
-```
+```
diff --git a/docs/docs/deploy.md b/docs/docs/deploy.md
@@ -2,7 +2,7 @@
 
 VeADK提供了一个云引擎，配合命令行脚手架，你可以方便地：
 
-- 将你的本地Agent项目上传到云端
+- 将你的本地Agent项目上传到云端（[火山引擎函数服务平台](https://www.volcengine.com/product/vefaas)）
 - 启动一个新的样例模板项目进行开发
 
 你可以指定部署到云端的项目以三种模式进行对外服务：
@@ -138,10 +138,10 @@ updated_cloud_app = engine.update_function_code(
 ```
 
 **注意事项：**
+
 - 更新操作会保持相同的访问端点URL
 - 确保项目路径包含`agent.py`文件
 
-
 ## 删除云应用
 
 ### 通过 CloudAgentEngine 删除
@@ -156,8 +156,9 @@ engine.remove(app_name="my-agent-app")
 ```
 
 执行时会提示确认：
-```
+
+```bash
 Confirm delete cloud app my-agent-app? (y/N): y
 ```
 
-输入`y`确认删除，输入其他任何字符或直接回车则取消删除。
+输入`y`确认删除，输入其他任何字符或直接回车则取消删除。
diff --git a/docs/docs/evaluation.md b/docs/docs/evaluation.md
@@ -52,7 +52,7 @@ assert dump_path != "", "Dump eval set file failed! Please check runtime logs."
     - `tool_uses`：Agent 使用的工具
     - `intermediate_responses`：Agent 的中间会话
 
-## 评测
+## 开展评测
 
 VeADK 目前支持 [DeepEval](https://deepeval.com/) 评测器和 [ADKEval](https://google.github.io/adk-docs/evaluate/)，通过如下方式定义评测器：
 
@@ -80,7 +80,7 @@ await evaluator.eval(eval_set_file_path=dump_path, metrics=metrics)
 
 ## 数据上报
 
-评测结果可以自动上报至火山引擎的 [VMP](https://console.volcengine.com/prometheus) 平台，只需要在定义评估器的时候传入 Prometheus pushgateway 等相关参数即可，可在 `config.yaml` 中进行配置并从环境变量中自动读取：
+评测结果可以自动上报至火山引擎的[托管 Prometheus (VMP)](https://www.volcengine.com/product/prometheus)平台，只需要在定义评估器的时候传入 Prometheus pushgateway 等相关参数即可，可在 `config.yaml` 中进行配置并从环境变量中自动读取：
 
 ```python
 from veadk.evaluation.utils.prometheus import PrometheusPushgatewayConfig
@@ -154,4 +154,4 @@ eval_set_file_path = os.path.join(
     os.path.dirname(__file__), "builtin_tools", "evalsetf0aef1.evalset.json"
 )
 await evaluator.eval(eval_set_file_path=eval_set_file_path, metrics=metrics)
-```
+```
diff --git a/docs/docs/get-started.md b/docs/docs/get-started.md
@@ -1,6 +1,7 @@
 # 快速开始
 
 ## 安装 VeADK
+
 参考[安装](./installation.md)文档进行配置，并将`config.yaml`配置文件放在项目根目录。
 
 ## 构建 Agent
@@ -13,11 +14,13 @@ from veadk.tools.demo_tools import get_city_weather
 
 agent = Agent(tools=[get_city_weather])
 ```
+
 ## 执行 Agent
 
 由于某些操作是异步的，因此 Agent 的运行需要借助`asyncio`库在异步环境中进行。
 
 Agent 的运行有两种方式，第一种是使用 Agent 自带的 `run` 方法运行：
+
 ```python
 import asyncio
 
@@ -45,4 +48,4 @@ print(response) # The weather in Beijing is Sunny with a temperature of 25°C. T
 我们在`Agent`类中提供的`run`方法仅为了本地测试和开发使用，由于该函数位于一个异步与同步函数共存的运行环境，可能会产生不可预知的异常。
 
 因此不建议在生产环境中使用。
-:::
+:::
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -4,9 +4,17 @@
 
 ## 环境
 
+### PyPI
+
+您可以直接使用`pip`从 [PyPI 平台](https://pypi.org/project/veadk-python/)进行安装：
+
+```bash
+pip install veadk-python
+```
+
 ### 从源码构建
 
-本项目使用`uv`进行构建（[安装`uv`](https://docs.astral.sh/uv/getting-started/installation/))。
+本项目使用`uv`进行构建（[安装`uv`](https://docs.astral.sh/uv/getting-started/installation/)）。
 
 ```bash
 # clone repo first
@@ -35,21 +43,14 @@ uv sync
 uv pip install -e .
 ```
 
-### PyPI
-
-本项目近期将发布在PyPI上，届时您可以使用`pip`进行安装。
-
-```bash
-pip install veadk-python
-```
-
 ## 配置
 
 VeADK 在仓库中提供了一个示例配置文件`config.yaml.example`，其中标明了一个智能体运行的必需（required）配置和可选（optional）配置。您可以基于该示例文件，在项目根目录下创建实际使用的配置文件`config.yaml`。VeADK 中的配置模块将自动查找并加载该文件内容，并将其中的配置项映射为运行时环境变量，从而帮助您省去环境配置的时间。
 
 完整的配置项可以参考[`config.yaml.example`文件](https://github.com/volcengine/veadk-python/blob/main/config.yaml.example)。
 
 ### 说明
+
 下面是详细的配置说明：
 
 ```yaml
@@ -186,4 +187,4 @@ MODEL_API_BASE_BASE_B=
 ...
 ```
 
-VeADK 中提供了一个`getenv`方法来读取相关配置，您无需在各组件中次手动传入某个配置的参数。
+VeADK 中提供了一个`getenv`方法来读取相关配置，您无需在各组件中次手动传入某个配置的参数。
diff --git a/docs/docs/introduction.md b/docs/docs/introduction.md
@@ -2,15 +2,16 @@
 
 ## 关于VeADK
 
-**VeADK（Volcengine Agent Development Kit）** 是由火山引擎推出的一套面向智能体（Agent）开发的全流程框架，旨在为开发者提供一套面向智能体构建、云端部署、评测与优化的全流程开发框架。
+**VeADK（Volcengine Agent Development Kit）** 是由[火山引擎](https://www.volcengine.com/)推出的一套面向智能体（Agent）开发的全流程框架，旨在为开发者提供一套面向智能体构建、云端部署、评测与优化的全流程开发框架。
 
 VeADK 相较于现有的智能体开发框架，具备与火山引擎产品体系深度融合的优势，帮助开发者更高效地构建企业级 AI 智能体应用。
 
 ## VeADK 核心优势
+
 ### 更快速的企业级部署
 
 - 通过云部署项目模板支持 CloudEngine 的一键部署和发布能力
-- 支持 veFaaS 与 APIG，实现高可用、高弹性的服务托管
+- 支持 [VeFaaS](https://www.volcengine.com/product/vefaas) 与[火山引擎APIG](https://www.volcengine.com/product/apig)，实现高可用、高弹性的服务托管
 - 提供简易的 CLI 工具与编程化发布
 
 ### 更安全的企业级部署
@@ -20,22 +21,22 @@ VeADK 相较于现有的智能体开发框架，具备与火山引擎产品体
 
 ### 更完备的可观测性和评估能力
 
-- 运行时数据无缝衔接 APMPlus、Cozeloop, TLS 等云观测平台，提供可视化监控
+- 运行时数据无缝衔接 [APMPlus](https://www.volcengine.com/product/apmplus)、[CozeLoop](https://www.coze.cn/loop), [TLS](https://www.volcengine.com/product/tls) 等云观测平台，提供可视化监控
 - 运行时数据直接落地为测试数据集文件， 支持离线和在线的评估能力
 
 ### 更丰富的内置工具
 
 - 内置头条、抖音搜索工具，实现实时信息获取与内容聚合
-- 集成飞书 Lark（协同办公）、LAS（AI 数据湖服务）等工具，增强 Agent 实用性
+- 集成飞书 Lark（协同办公）、[LAS（AI 数据湖服务）](https://www.volcengine.com/product/las)等工具，增强 Agent 实用性
 
 ### 更灵活的功能扩展
 
 - 提供 Agent 构建所需核心组件的基础实现，支持开发者根据需求灵活组合与扩展
 
 ### 更强大的知识管理
 
-- 支持连接火山引擎各类现有数据库，包括关系型数据库、键值数据库等
-- 集成 Viking DB 等火山引擎云知识库，实现知识的高效存储、检索与更新
+- 支持连接火山引擎各类现有数据库，包括[关系型数据库](https://www.volcengine.com/product/rds-mysql)、[缓存数据库](https://www.volcengine.com/product/redis)等
+- 集成 [Viking DB](https://www.volcengine.com/docs/84313/1254437) 等火山引擎云知识库，实现知识的高效存储、检索与更新
 
 ### 更友好的最佳实践
 
diff --git a/docs/docs/knowledgebase.md b/docs/docs/knowledgebase.md
@@ -13,7 +13,7 @@ knowledgebase = KnowledgeBase(backend=...)
 | backend | 说明 |
 | --- | --- |
 | local | GIGO 模式的内存存储，不具备向量检索功能，仅用于测试 |
-| [viking](https://console.volcengine.com/vikingdb) | 火山引擎 Viking DB 服务 |
+| [viking](https://www.volcengine.com/docs/84313/1254437) | 火山引擎 Viking DB 服务 |
 | opensearch | OpenSearch 数据库 |
 | redis | Redis 数据库，但不具备向量搜索功能 |
 | mysql | MySQL 数据库，但不具备向量搜索功能 |
@@ -39,7 +39,7 @@ agent = Agent(knowledgebase=knowledgebase)
 
 ## 火山知识库
 
-VeADK 中提供了火山引擎支持的知识库 [VikingDB](https://console.volcengine.com/vikingdb)，支持用户直接上传本地文档，文档切片和存储维护均在云上自动执行：
+VeADK 中提供了火山引擎支持的知识库 [VikingDB](https://www.volcengine.com/docs/84313/1254437)，支持用户直接上传本地文档，文档切片和存储维护均在云上自动执行：
 
 ```python
 from veadk import Agent
@@ -53,4 +53,4 @@ knowledgebase.add(
 )
 
 agent = Agent(knowledgebase=knowledgebase)
-```
+```
diff --git a/docs/docs/memory.md b/docs/docs/memory.md
@@ -67,7 +67,6 @@ response = await runner.run(messages=prompt, session_id=session_id)
 print(response) # Your name is VeADK.
 ```
 
-
 ### 短期记忆的优化
 
 持久化的短期记忆可能过长，占满某些模型的上下文。为解决短期记忆过长的问题，VeADK 中提供了记忆优化器来进行短期记忆的优化，通过在短期记忆类中传入`enable_memory_optimization`参数，开启记忆优化器。
@@ -95,6 +94,7 @@ short_term_memory = ShortTermMemory(
 - 自定义维度（例如结构化信息抽取）
 
 以下示例展示了 VeADK 中短期记忆在开启记忆优化模式（`enable_memory_optimization=True`）后的使用方式。通过该模式，Agent 能够在存储用户对话上下文时自动剔除冗余或无关的信息，从而提高记忆效率与响应准确性。
+
 ```python
 import os
 from sqlalchemy import create_engine
@@ -138,6 +138,7 @@ print(response)
 # clear local database
 os.remove(local_database_path)
 ```
+
 短期记忆优化过程与结果：
 
 ![短期记忆优化结果](/images/memory-optimization.png)
@@ -174,6 +175,7 @@ await self.long_term_memory.add_session_to_memory(session) # 添加
 | mysql | MySQL 数据库，但不具备向量搜索功能 |
 
 以下示例展示了如何在 VeADK 中使用长期记忆实现跨会话的信息保留与调用。开发者可以通过 `save_session_to_long_term_memory` 方法，将某一会话中的知识性信息存入长期记忆存储后端。在新的会话中，即使上下文为空，Agent 依然能够基于长期记忆准确回忆并回答相关问题。
+
 ```python
 from veadk import Agent, Runner
 from veadk.memory.long_term_memory import LongTermMemory
@@ -202,4 +204,3 @@ student_prompt = "..."
 response = await runner.run(messages=student_prompt, session_id=new_session_id)
 print(response)
 ```
-
diff --git a/docs/docs/tool.md b/docs/docs/tool.md
@@ -62,6 +62,7 @@ VeADK 中集成了多个火山引擎提供的工具：
 - Code sandbox (TBD)
 
 以下示例展示了如何在 VeADK 中集成并调用内置工具 vesearch，用于获取今天的三条热点新闻：
+
 ```python
 from veadk import Agent
 from veadk.tools.builtin_tools.vesearch import vesearch
@@ -104,4 +105,4 @@ lark_mcp_remote = MCPToolset(
 ### 系统工具
 
 - `load_knowledgebase`：检索知识库工具，在你给 Agent 传入`knowledgebase`参数后，将会自动挂载`load_knowledgebase_tool`工具，Agent 将在运行时自主决定何时查询知识库；
-- `load_memory`：检索长期记忆工具，在你给 Agent 传入`long_term_memory`参数后，将会自动挂载`load_memory`工具，Agent 将在运行时自主决定何时查询长期记忆。
+- `load_memory`：检索长期记忆工具，在你给 Agent 传入`long_term_memory`参数后，将会自动挂载`load_memory`工具，Agent 将在运行时自主决定何时查询长期记忆。
diff --git a/docs/docs/tracing.md b/docs/docs/tracing.md
@@ -23,8 +23,8 @@ print(f"Tracing file path: {tracer._trace_file_path}")
 通过设置不同的云端上报器`exporter`，可以将观测数据上传到对应平台：
 
 - [CozeLoop 平台](https://www.coze.cn/loop)：`CozeLoopExporter`
-- [APMPlus 平台](https://console.volcengine.com/apmplus-server/region:apmplus-server+cn-beijing/console/overview/server)： `APMPlusExporter`
-- [TLS 平台](https://console.volcengine.com/tls/region:tls+cn-beijing/v2/trace-service)：`TLSExporter`
+- [APMPlus 平台](https://www.volcengine.com/product/apmplus)： `APMPlusExporter`
+- [TLS 平台](https://www.volcengine.com/product/tls)：`TLSExporter`
 
 示例：配置多个云端 `exporter`
 
@@ -88,4 +88,4 @@ print(f"Tracing file path: {tracer._trace_file_path}")
 ![本地 tracing 文件](/images/tracing-file.png)
 
 APMPlus 平台可视化界面：
-![APMPlusExporter图](/images/tracing-apmplus.png)
+![APMPlusExporter图](/images/tracing-apmplus.png)
