wangtinghu/agentUniverse
1
0
Fork 0
mirror of https://github.com/agentuniverse-ai/agentUniverse.git synced 2026-02-09 01:59:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve zh docs

Browse Source
This commit is contained in:
Jerry Z H
2024-12-02 20:42:18 +08:00
parent 7fb706c5de
commit 82fecafe50
79 changed files with 547 additions and 652 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README_zh.md
View File

@@ -62,7 +62,7 @@ pip install agentUniverse
运行您的第一个案例，您可以通过教程快速体验agentUniverse构建出的智能体(组)运行效果。
详细步骤请阅读文档: [运行第一个教程案例](./docs/guidebook/zh/1_运行第一个教程案例.md) 。
详细步骤请阅读文档: [运行第一个教程案例](./docs/guidebook/zh/开始使用/快速开始.md) 。
****************************************
@@ -71,19 +71,19 @@ pip install agentUniverse
### 工程化搭建
#### 智能体创建与使用
您可以通过 [智能体介绍](./docs/guidebook/zh/2_2_1_智能体.md) 了解智能体的重要组成部分，通过 [智能体创建与使用](./docs/guidebook/zh/2_2_1_智能体创建与使用.md) 了解创建智能体的详细过程。您也可以结合官方案例，如 [Python代码生成与执行Agent](./docs/guidebook/zh/7_1_1_Python自动执行案例.md) 进一步理解智能体创建与使用过程。
您可以通过 [智能体介绍](./docs/guidebook/zh/In-Depth_Guides/原理介绍/智能体/智能体.md) 了解智能体的重要组成部分，通过 [智能体创建与使用](./docs/guidebook/zh/In-Depth_Guides/原理介绍/智能体/智能体创建与使用.md) 了解创建智能体的详细过程。您也可以结合官方案例，如 [Python代码生成与执行Agent](./docs/guidebook/zh/样例文档/Python自动执行案例.md) 进一步理解智能体创建与使用过程。
#### 知识库构建与使用
在智能体应用构建中，知识库构建与召回是不可缺少的，agentUniverse框架以[RAG技术](./docs/guidebook/zh/2_2_4_RAG.md)为基础提供了高效的知识库构建和RAG检索召回环节的标准作业流程。您可以通过[知识介绍](./docs/guidebook/zh/2_2_4_知识.md)与[知识定义与使用](./docs/guidebook/zh/2_2_4_知识定义与使用.md)了解其使用方式，进一步通过[如何构建RAG智能体](./docs/guidebook/zh/2_2_4_如何构建RAG智能体.md)掌握如何快速构建知识库与构建具有召回能力的智能体。
在智能体应用构建中，知识库构建与召回是不可缺少的，agentUniverse框架以[RAG技术](./docs/guidebook/zh/In-Depth_Guides/原理介绍/RAG.md)为基础提供了高效的知识库构建和RAG检索召回环节的标准作业流程。您可以通过[知识介绍](./docs/guidebook/zh/In-Depth_Guides/原理介绍/知识/知识.md)与[知识定义与使用](./docs/guidebook/zh/In-Depth_Guides/原理介绍/知识/知识定义与使用.md)了解其使用方式，进一步通过[如何构建RAG智能体](./docs/guidebook/zh/How-to/如何构建RAG智能体.md)掌握如何快速构建知识库与构建具有召回能力的智能体。
#### 工具自定义与使用
在智能体应用构建中，智能体需要连接各种各样的工具，您需要为其指定可使用的工具范围列表。您可以通过[工具创建与使用](./docs/guidebook/zh/2_2_3_工具创建与使用.md)将各类自有API与服务以工具插件形式接入。目前框架已经集成了LangChain与部分第三方工具包，详细使用法可阅读[集成LangChain工具](./docs/guidebook/zh/2_2_3_集成LangChain工具.md)、[现有集成的工具](./docs/guidebook/zh/2_2_3_集成的工具.md)。
在智能体应用构建中，智能体需要连接各种各样的工具，您需要为其指定可使用的工具范围列表。您可以通过[工具创建与使用](./docs/guidebook/zh/In-Depth_Guides/原理介绍/工具/工具创建与使用.md)将各类自有API与服务以工具插件形式接入。目前框架已经集成了LangChain与部分第三方工具包，详细使用法可阅读[集成LangChain工具](./docs/guidebook/zh/In-Depth_Guides/组件列表/工具列表/集成LangChain工具.md)、[现有集成的工具](./docs/guidebook/zh/In-Depth_Guides/组件列表/工具列表/集成LangChain工具.md)。
#### 效果评估
智能体的效果评估一方面可以通过人工专家评定，另一个方面也可以依托智能体的评估能力。agentUniverse推出了DataAgent（Minimum Viable Product版本）, DataAgent旨在使用智能体能力让您的Agent拥有自我评价与演进的能力，您也可以在其中自定义评估标准。详情见文档: [DataAgent - 数据自治智能体](./docs/guidebook/zh/8_1_1_数据自治智能体.md)。
智能体的效果评估一方面可以通过人工专家评定，另一个方面也可以依托智能体的评估能力。agentUniverse推出了DataAgent（Minimum Viable Product版本）, DataAgent旨在使用智能体能力让您的Agent拥有自我评价与演进的能力，您也可以在其中自定义评估标准。详情见文档: [DataAgent - 数据自治智能体](./docs/guidebook/zh/In-Depth_Guides/原理介绍/数据自治智能体.md)。
#### 服务化
agentUniverse提供多套标准的web serve能力, 同时提供标准的http与rpc协议。您可以进一步关注文档[服务注册与使用](./docs/guidebook/zh/2_4_1_服务注册与使用.md)与[Web_Server](./docs/guidebook/zh/2_4_1_Web_Server.md)部分。
agentUniverse提供多套标准的web serve能力, 同时提供标准的http与rpc协议。您可以进一步关注文档[服务注册与使用](./docs/guidebook/zh/In-Depth_Guides/技术组件/服务化/服务注册与使用.md)与[Web_Server](./docs/guidebook/zh/In-Depth_Guides/技术组件/服务化/Web_Server.md)部分。
### 平台化搭建
@@ -98,8 +98,8 @@ pip install magent-ui ruamel.yaml
运行sample_standard_app/app/boostrap下的[product_application.py](sample_standard_app/app/bootstrap/product_application.py)文件，一键启动。
更多详情参考 [产品化平台快速开始](./docs/guidebook/zh/10_1_1_产品化平台快速开始.md)
与 [产品化平台进阶指南](./docs/guidebook/zh/10_1_2_产品化平台进阶指南.md) 。本功能由 🔗[difizen](https://github.com/difizen/magent) 项目组 X agentUniverse 项目组联合推出。
更多详情参考 [产品化平台快速开始](./docs/guidebook/zh/How-to/画布式研发平台快速开始.md)
与 [产品化平台进阶指南](./docs/guidebook/zh/How-to/画布式研发平台进阶指南.md) 。本功能由 🔗[difizen](https://github.com/difizen/magent) 项目组 X agentUniverse 项目组联合推出。
****************************************
@@ -144,21 +144,21 @@ BibTeX formatted
轻松融入领域经验： 提供领域prompt、知识构建与管理的能力，支持领域级SOP编排与注入，将智能体对齐至领域专家级别；
💡 更多特点见[agentUniverse核心特性](./docs/guidebook/zh/1_核心特性.md)部分。
💡 更多特点见[agentUniverse核心特性](./docs/guidebook/zh/设计理念/核心特性.md)部分。
****************************************
## 案例与样例工程
### 官方案例
🚩 [法律咨询Agent_v2](./docs/guidebook/zh/7_1_1_法律咨询案例.md)
🚩 [法律咨询Agent_v2](./docs/guidebook/zh/样例文档/法律咨询案例.md)
🚩 [Python代码生成与执行Agent](./docs/guidebook/zh/7_1_1_Python自动执行案例.md)
🚩 [Python代码生成与执行Agent](./docs/guidebook/zh/样例文档/Python自动执行案例.md)
🚩 [基于多轮多Agent的讨论小组](./docs/guidebook/zh/6_2_1_讨论组.md)
🚩 [基于多轮多Agent的讨论小组](./docs/guidebook/zh/样例文档/讨论组.md)
🚩 [基于PEER协同模式的金融事件分析](./docs/guidebook/zh/6_4_1_金融事件分析案例.md)
🚩 [基于PEER协同模式的金融事件分析](./docs/guidebook/zh/样例文档/金融事件分析案例.md)
🚩 [吴恩达反思工作流翻译智能体复刻](./docs/guidebook/zh/7_1_1_翻译案例.md)
🚩 [吴恩达反思工作流翻译智能体复刻](./docs/guidebook/zh/样例文档/翻译案例.md)
### 示例工程
⌨️ [agentUniverse 示例项目](sample_standard_app)
@@ -177,7 +177,7 @@ https://private-user-images.githubusercontent.com/39180831/355437700-192f712d-1b
****************************************
## 用户指南手册
💡 更多详细信息，请阅读[用户指南手册](docs/guidebook/zh/0_%E7%9B%AE%E5%BD%95.md) 。
💡 更多详细信息，请阅读[用户指南手册](docs/guidebook/zh/目录.md) 。
****************************************