Merge branch 'volcengine:main' into main

Author: feng-95

.gitignore

@@ -167,6 +167,13 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
 # Ruff stuff:
 .ruff_cache/
 

.python-version

@@ -15,6 +15,17 @@ A [tutorial](https://github.com/volcengine/veadk-python/blob/main/veadk_tutorial
 
 ## Installation
 
+### From PyPI
+
+```python
+pip install veadk-python
+
+# install extensions
+pip install veadk-python[extensions]
+```
+
+### Build from source
+
 We use `uv` to build this project ([how-to-install-uv](https://docs.astral.sh/uv/getting-started/installation/)).
 
 ```bash

README.md

@@ -17,7 +17,7 @@ model:
   embedding:
     name: doubao-embedding-text-240715
     dim: 2560
-    api_base: https://ark.cn-beijing.volces.com/api/v3/embeddings
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
     api_key:
   video:
     name: doubao-seedance-1-0-pro-250528
@@ -119,6 +119,10 @@ database:
     endpoint: tos-cn-beijing.volces.com # default Volcengine TOS endpoint
     region: cn-beijing                  # default Volcengine TOS region
     bucket:
+  mem0:
+    base_url:
+    api_key:
+    
 
 
 # [optional] for prompt optimization in cli/app

config.yaml.full

@@ -9,17 +9,17 @@ seo:
     effortlessly with Docus.
 ---
 
-欢迎使用火山引擎智能体框架 **VeADK（Volcengine Agent Development Kit）**，是由[火山引擎](https://www.volcengine.com/)推出的为 Agent 智能体的应用构建提供开发、部署、观测、评测等全流程云原生解决方案。
+火山引擎智能体框架 **VeADK（Volcengine Agent Development Kit）**，是由[火山引擎](https://www.volcengine.com/)推出的为 Agent 智能体的应用构建提供开发、部署、观测、评测等全流程云原生解决方案。
 
-相较于现有的智能体开发框架，具备与火山引擎产品体系深度融合的优势，帮助开发者更高效地构建企业级 AI 智能体应用。
+相较于现有的智能体开发框架，VeADK 具备与火山引擎产品体系深度融合的优势，帮助开发者更高效地构建企业级 AI 智能体应用。
 
-## 特性
+## 核心能力
 
 - **生态兼容**：与 Google ADK 完全兼容
-- **快速部署**：本地项目部署到云端的时延在分钟级别，并提供镜像部署、代码部署等多种部署形式
-- **一证通行**：基于火山引擎AK/SK进行企业级统一密钥管理
+- **快速部署**：本地项目分钟级部署云端，提供代码打包、镜像构建等多种部署形式
+- **一证通行**：基于火山引擎AK/SK进行企业级统一身份和密钥管理
 
-## 核心能力
+## 特性
 
 ### 更快速的企业级部署
 

docs/content/1.introduction/1.overview.md

@@ -1,6 +1,6 @@
 ---
 title: 安装
-description: VeADK安装方式
+description: VeADK 安装方式
 navigation:
   icon: i-lucide-download
 ---
@@ -21,19 +21,19 @@ pip install veadk-python==0.2.7
 
 :::
 
-<!-- 如果您使用知识库、长期记忆等进阶功能，请进一步安装 `veadk-python` 中的扩展包：
+如果您使用知识库、长期记忆等进阶功能，请进一步安装 `veadk-python` 中的扩展包：
 
 ```bash [Terminal]
 pip install veadk-python[extensions]
-``` -->
+```
 
 ## 从源码构建
 
 ::steps
 
 ### 下载源码至本地
 
-将VeADK的代码包从Github下载到本地：
+将 VeADK 的代码包从 Github 下载到本地：
 
 ```bash [Terminal]
 git clone https://github.com/volcengine/veadk-python.git

docs/content/1.introduction/2.installation.md

@@ -19,19 +19,58 @@ import asyncio
 from veadk import Agent
 
 agent = Agent()
-asyncio.run(agent.run("Hello world!"))
+response = asyncio.run(agent.run("Hello world!"))
+
+print(response)
 ```
 
 ### 执行
 
-您需要通过环境变量方式，来设置能够调用大模型的 API Key 或者其它身份验证信息。
+您需要通过环境变量方式，来设置能够调用大模型的 API Key 或者其它身份验证信息。例如，通过火山引擎方舟大模型平台的API Key：
 
 ```bash [Terminal]
-# 通过 API Key
 MODEL_AGENT_API_KEY=... python agent.py
+```
+
+或者通过火山引擎 AK/SK：
 
-# 通过火山引擎 AK/SK
+```bash [Terminal]
 VOLCENGINE_ACCESS_KEY=... VOLCENGINE_SECRET_KEY=... python agent.py
 ```
 
+::warning
+通过火山引擎 AK/SK 来运行智能体时，将会自动从您的方舟平台获取 API Key，这要求您在方舟平台至少已经创建一个 API Key。[了解如何创建方舟大模型平台API Key](https://www.volcengine.com/docs/82379/1361424)。
+::
+
+### 进阶
+
+您也可以在项目根目录下创建一个 `config.yaml` 来填入相关配置。
+
+::tip
+VeADK 可以自动将您根目录下的 `config.yaml` 文件根据层次使用下划线铺平，转为大写后设置为环境变量，详见[这里](../configurations/system)。
+::
+
+::code-tree{default-value="app/config.yaml"}
+
+```yaml [app/config.yaml]
+volcengine:
+  access_key:
+  secret_key:
+```
+
+```python [app/agent.py]
+import asyncio
+
+from veadk import Agent
+
+agent = Agent()
+response = asyncio.run(agent.run("Hello world!"))
+
+print(response)
+```
+
+::
+
+完整的配置项可以参考[这里](../configurations/envs)。
+
 ::

docs/content/1.introduction/3.quickstart.md

@@ -2,7 +2,7 @@
 title: Troubleshooting
 description: 安装、运行以及使用中的各类常见问题汇总
 navigation:
-  icon: i-lucide-wrench
+  icon: i-lucide-file-question-mark
 ---
 
 ## 安装
@@ -24,3 +24,12 @@ navigation:
 
 1. **卡在 release 阶段**
    - 请先在 VeFaaS 平台开通权限。
+
+   - ![开通权限](/images/troubleshooting-01.png)
+
+   - 新账号开通后，缺少ServerlessApplicationRole授权
+      - 前往火山引擎函数服务官网，进入创建应用页面（例如[这里](https://console.volcengine.com/vefaas/region:vefaas+cn-beijing/application/create?templateId=67f7b4678af5a6000850556c)）点击「一键授权」即可
+      - ![角色授权](/images/troubleshooting-02.png)
+
+2. **安装依赖失败，显示依赖安装空间不足**
+   - VeFaaS 最大依赖安装大小默认为 250 MB，若需更大空间，请联系 VeFaaS 产品团队扩容。

docs/content/1.introduction/4.troubleshooting.md

@@ -2,7 +2,7 @@
 title: 配置管理系统
 description: 实现自动身份管理、云上资源设施管理等
 navigation:
-  icon: i-lucide-heading-1
+  icon: i-lucide-settings
 ---
 
 VeADK 内置了一套配置管理系统，您能够通过定义一个 `config.yaml` 文件来管理您的各项配置。文件中的配置项将会在运行时被自动加载为对应的环境变量。

docs/content/2.configurations/1.system.md

@@ -2,7 +2,7 @@
 title: 环境变量
 description: 更安全、更快捷的配置入口
 navigation:
-  icon: i-lucide-heading-1
+  icon: i-lucide-settings
 ---
 
 ## 火山引擎生态