diff --git a/README.md b/README.md index 31a990ec..c621edf1 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,18 @@ uv pip install -e . ## Configuration -We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. +We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file: + +```yaml +model: + agent: + provider: openai + name: doubao-seed-1-6-250615 + api_base: https://ark.cn-beijing.volces.com/api/v3/ + api_key: # <-- set your Volcengine ARK api key here +``` -You can refer to the [example config file](config.yaml.example) for more details. +You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details. ## Have a try diff --git a/config.yaml.example b/config.yaml.full similarity index 96% rename from config.yaml.example rename to config.yaml.full index 70e45c59..07063433 100644 --- a/config.yaml.example +++ b/config.yaml.full @@ -2,12 +2,12 @@ model: # [required] for running agent agent: provider: openai - name: doubao-1-5-pro-256k-250115 + name: doubao-seed-1-6-250615 api_base: https://ark.cn-beijing.volces.com/api/v3/ - api_key: + api_key: # [optional] for llm-as-a-judge a evaluation judge: - name: doubao-1-5-pro-256k-250115 + name: doubao-seed-1-6-250615 api_base: https://ark.cn-beijing.volces.com/api/v3/ api_key: # [optional] for knowledgebase diff --git a/config.yaml.simple b/config.yaml.simple new file mode 100644 index 00000000..9476d107 --- /dev/null +++ b/config.yaml.simple @@ -0,0 +1,6 @@ +model: + agent: + provider: openai + name: doubao-seed-1-6-250615 + api_base: https://ark.cn-beijing.volces.com/api/v3/ + api_key: \ No newline at end of file diff --git a/docs/docs/get-started.md b/docs/docs/get-started.md index 36452b79..65f863a8 100644 --- a/docs/docs/get-started.md +++ b/docs/docs/get-started.md @@ -2,7 +2,22 @@ ## 安装 VeADK -参考[安装](./installation.md)文档进行配置,并将`config.yaml`配置文件放在项目根目录。 +您可参考[安装](./installation.md)文档进行安装。 + +## 配置项 + +您需要创建一个`config.yaml`配置文件放在项目根目录。为了运行一个最简 Agent,您只需要在文件中配置写入如下内容: + +```yaml +model: + agent: + provider: openai + name: doubao-seed-1-6-250615 + api_base: https://ark.cn-beijing.volces.com/api/v3/ + api_key: # <-- 在此处填充模型访问的密钥(例如火山方舟的 API KEY) +``` + +完整的配置项,可参考[这里](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE)。 ## 构建 Agent diff --git a/docs/docs/introduction.md b/docs/docs/introduction.md index bc95b72f..5ce53aed 100644 --- a/docs/docs/introduction.md +++ b/docs/docs/introduction.md @@ -6,6 +6,30 @@ VeADK 相较于现有的智能体开发框架,具备与火山引擎产品体系深度融合的优势,帮助开发者更高效地构建企业级 AI 智能体应用。 +VeADK 各组件与火山引擎相关产品的结合矩阵: + +| **组件** | **火山引擎产品** | **说明** | +| :-- | :-- | :-- | +| 大模型 | [火山方舟](https://www.volcengine.com/product/ark) | 提供各类语言模型、多模态模型的推理服务 | +| 提示词工程 | [PromptPilot](https://promptpilot.volcengine.com/) | 提供提示词管理、优化能力 | +| 工具 | [火山方舟大模型生态广场](https://www.volcengine.com/mcp-marketplace) | 提供各类 MCP Server | +| | [Web search](https://www.volcengine.com/docs/85508/1650263) | 提供公域数据搜索功能 | +| | [VeSearch](https://www.volcengine.com/docs/85508/1512748) | 提供信息搜索与云端自动整合功能 | +| | [Web Scraper](https://www.volcengine.com/docs/84296/1545470) | 定制化内容查询(邀测) | +| | 飞书 Lark | 进行飞书相关操作 | +| | [AI 数据湖服务 LAS](https://www.volcengine.com/product/las) | 提供数据湖内的海量数据存储与查询能力 | +| 短期记忆 | Viking Memory 记忆库 | 提供记忆存储、优化、摘要等功能 | +| | [火山引擎云数据库 MySQL 版](https://www.volcengine.com/product/rds-mysql) | 记忆存储 | +| 长期记忆 | [Viking DB](https://www.volcengine.com/docs/84313/1254437) | 记忆向量化存储和检索 | +| | [云搜索服务](https://www.volcengine.com/product/es)(OpenSearch) | 记忆向量化存储和检索 | +| 知识库 | [Viking DB](https://www.volcengine.com/docs/84313/1254437) | 知识向量化存储和检索 | +| | [云搜索服务](https://www.volcengine.com/product/es)(OpenSearch) | 知识向量化存储和检索 | +| 可观测 | [应用性能监控全链路版](https://www.volcengine.com/product/apmplus)(APMPlus) | 调用链路观测 | +| | [扣子罗盘](https://www.coze.cn/loop) (Coze Loop) | 调用链路观测 | +| | [日志服务](https://www.volcengine.com/product/tls) | 调用链路观测、日志存储与检索 | +| 评测 | [扣子罗盘](https://www.coze.cn/loop) (Coze Loop) | 在线评测 | +| 云部署 | [火山引擎函数服务](https://www.volcengine.com/product/vefaas) (VeFaaS) | 提供一键上云能力 | + ## VeADK 核心优势 ### 更快速的企业级部署