From 96393f745d1071352d66a376a120b0a3f398053a Mon Sep 17 00:00:00 2001 From: Jerry Z H Date: Fri, 14 Jun 2024 17:52:58 +0800 Subject: [PATCH] docs: update readme & guidebook --- README.md | 5 +++++ README_jp.md | 5 +++++ README_zh.md | 5 +++++ docs/guidebook/en/0_index.md | 16 +++++++++++++--- docs/guidebook/en/3_1_2_0_List_Of_LLMs.md | 4 +++- ...se .md => 7_1_1_Legal_Consultation_Case.md} | 0 docs/guidebook/zh/0_目录.md | 16 +++++++++++++--- docs/guidebook/zh/3_1_2_0_模型列表.md | 18 ++++++++++-------- 8 files changed, 54 insertions(+), 15 deletions(-) rename docs/guidebook/en/{7_1_1_Legal_Consultation_Case .md => 7_1_1_Legal_Consultation_Case.md} (100%) diff --git a/README.md b/README.md index 977ad774..b09a0f4c 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,11 @@ We will show you how to: * Quickly serve the agent For details, please read [Quick Start](docs/guidebook/en/1_3_Quick_Start.md). +## Use Cases +[Legal Consultation Agent](./docs/guidebook/en/7_1_1_Legal_Consultation_Case.md) +[Python Code Generation and Execution Agent](./docs/guidebook/en/7_1_1_Python_Auto_Runner.md) +[Discussion Group Based on Multi-Turn Multi-Agent Mode](./docs/guidebook/en/6_2_1_Discussion_Group.md) + ## Guidebook For more detailed information, please refer to the [Guidebook](docs/guidebook/en/0_index.md). diff --git a/README_jp.md b/README_jp.md index 967e2154..72168a33 100644 --- a/README_jp.md +++ b/README_jp.md @@ -43,6 +43,11 @@ pip install agentUniverse * エージェントを迅速に提供する 詳細は、[クイックスタート](docs/guidebook/en/1_3_Quick_Start.md)をご覧ください。 +## 使用ケース +[法律相談Agent](./docs/guidebook/en/7_1_1_Legal_Consultation_Case.md) +[Pythonコード生成と実行Agent](./docs/guidebook/en/7_1_1_Python_Auto_Runner.md) +[多回多Agentによるディスカッショングループ](./docs/guidebook/en/6_2_1_Discussion_Group.md) + ## ガイドブック 詳細情報については、[ガイドブック](docs/guidebook/en/0_index.md)を参照してください。 diff --git a/README_zh.md b/README_zh.md index 17763f6e..f7b474b5 100644 --- a/README_zh.md +++ b/README_zh.md @@ -47,6 +47,11 @@ pip install agentUniverse 详情请阅读[快速开始](docs/guidebook/zh/1_3_%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md) 。 +## 使用案例 +[法律咨询Agent](./docs/guidebook/zh/7_1_1_法律咨询案例.md) +[Python代码生成与执行Agent](./docs/guidebook/zh/7_1_1_Python自动执行案例.md) +[基于多轮多Agent的讨论小组](./docs/guidebook/zh/6_2_1_讨论组.md) + ## 用户指南 更多详细信息，请参阅[指南](docs/guidebook/zh/0_%E7%9B%AE%E5%BD%95.md) 。 diff --git a/docs/guidebook/en/0_index.md b/docs/guidebook/en/0_index.md index 36bb852b..6fa4e741 100644 --- a/docs/guidebook/en/0_index.md +++ b/docs/guidebook/en/0_index.md @@ -52,6 +52,8 @@ * 3.1.2.3 [WenXin Usage Instructions](3_1_2_WenXin_LLM_Use.md) * 3.1.2.4 [Kimi Usage Instructions](3_1_2_Kimi_LLM_Use.md) * 3.1.2.5 [BaiChuan Usage Instructions](3_1_2_BaiChuan_LLM_Use.md) + * 3.1.2.6 [Claude Usage Instructions](3_1_2_Claude_LLM_Use.md) + * 3.1.2.7 [Ollama Usage Instructions](3_1_2_Ollama_LLM_Use.md) * 3.1.3 List of Tools * 3.1.4 List of Knowledge * 3.1.5 List of Memories @@ -62,6 +64,7 @@ * 3.2.2 Store * 3.2.2.1 [SQLDBWrapper](2_3_1_SQLDB_WRAPPER.md) * 3.2.2.2 [Milvus](3_3_1_Milvus.md) + * 3.2.2.3 [ChromaDB](3_3_2_ChromaDB.md) * 3.2.3 Msg * 3.2.4 Logging * 3.2.4.1 [Alibaba Cloud SLS](3_2_4_Alibaba_Cloud_SLS.md) @@ -73,8 +76,15 @@ * 5.1.1 [Docker Containerization Solution](5_1_1_Docker_Container_Deployment.md) * 5.1.2 [K8S Solution](5_1_2_K8S_Deployment.md) -**6. Series of Articles** +**6. Use Cases** +* 6.1 RAG-Type Agent Examples + * 6.1.1 [Legal Consultation Agent](7_1_1_Legal_Consultation_Case.md) +* 6.2 ReAct-Type Agent Examples + * 6.2.1 [Python Code Generation and Execution Agent](7_1_1_Python_Auto_Runner.md) +* 6.3 [Discussion Group Based on Multi-Turn Multi-Agent Mode](6_2_1_Discussion_Group.md) -**7. Frequently Asked Questions (FAQ)** +**7. Series of Articles** -**[8. Contact Us](6_1_Contact_Us.md)** +**8. Frequently Asked Questions (FAQ)** + +**[9. Contact Us](6_1_Contact_Us.md)** diff --git a/docs/guidebook/en/3_1_2_0_List_Of_LLMs.md b/docs/guidebook/en/3_1_2_0_List_Of_LLMs.md index 5d5975eb..a56aa83f 100644 --- a/docs/guidebook/en/3_1_2_0_List_Of_LLMs.md +++ b/docs/guidebook/en/3_1_2_0_List_Of_LLMs.md @@ -8,7 +8,9 @@ The platform has currently integrated the following list of models; please refer | [WenXin](3_1_2_WenXin_LLM_Use.md) | | [Kimi](3_1_2_Kimi_LLM_Use.md) | | [BaiChuan](3_1_2_BaiChuan_LLM_Use.md) | +| [Claude](3_1_2_Claude_LLM_Use.md) | +| [ollama](3_1_2_Ollama_LLM_Use.md) | For LLM not included in the list, you can customize the integration of any LLM according to the steps provided in the [LLM definition](2_2_3_Tool_Create_And_Use.md). -At the same time, we are adding the integration methods for common LLMs such as Claude, Gemini, ollama, Llama, ZhipuAI, etc. If you have used these LLMs in your projects and have created your own instances, we welcome you to submit a PR to become a contributor to agentUniverse. \ No newline at end of file +At the same time, we are adding the integration methods for common LLMs such as Gemini, Llama, ZhipuAI, etc. If you have used these LLMs in your projects and have created your own instances, we welcome you to submit a PR to become a contributor to agentUniverse. \ No newline at end of file diff --git a/docs/guidebook/en/7_1_1_Legal_Consultation_Case .md b/docs/guidebook/en/7_1_1_Legal_Consultation_Case.md similarity index 100% rename from docs/guidebook/en/7_1_1_Legal_Consultation_Case .md rename to docs/guidebook/en/7_1_1_Legal_Consultation_Case.md diff --git a/docs/guidebook/zh/0_目录.md b/docs/guidebook/zh/0_目录.md index 4b26c3de..43a9b654 100644 --- a/docs/guidebook/zh/0_目录.md +++ b/docs/guidebook/zh/0_目录.md @@ -56,6 +56,8 @@ * 3.1.2.3 [文心一言使用说明](3_1_2_文心使用.md) * 3.1.2.4 [Kimi使用说明](3_1_2_Kimi使用.md) * 3.1.2.5 [百川使用说明](3_1_2_百川使用.md) + * 3.1.2.6 [Claude使用说明](3_1_2_Claude使用.md) + * 3.1.2.7 [Ollama使用说明](3_1_2_Ollama使用.md) * 3.1.3 工具列表(Tool) * 3.1.4 知识列表(Knowledge) * 3.1.5 记忆列表(Memory) @@ -66,6 +68,7 @@ * 3.2.2 存储 (Store) * 3.2.2.1 [SQLDBWrapper](2_3_1_SQLDB_WRAPPER.md) * 3.2.2.2 [Milvus](3_3_1_Milvus.md) + * 3.2.2.3 [ChromaDB](3_3_2_ChromaDB.md) * 3.2.3 消息(Msg) * 3.2.4 日志(Logging) * 3.2.4.1 [阿里云SLS](3_2_4_阿里云SLS.md) @@ -77,8 +80,15 @@ * 5.1.1 [Docker容器化方案](5_1_1_Docker容器化部署.md) * 5.1.2 [K8S部署方案](5_1_2_K8S部署.md) -**6.系列文章** +**6.使用案例** +* 6.1 RAG类Agent案例 + * 6.1.1 [法律咨询Agent](7_1_1_法律咨询案例.md) +* 6.2 ReAct类Agent案例 + * 6.2.1 [Python代码生成与执行Agent](7_1_1_Python自动执行案例.md) +* 6.3 [基于多轮多Agent的讨论小组](6_2_1_讨论组.md) -**7.常见问题FAQ** +**7.系列文章** -**[8.联系我们](6_1_联系我们.md)** +**8.常见问题FAQ** + +**[9.联系我们](6_1_联系我们.md)** diff --git a/docs/guidebook/zh/3_1_2_0_模型列表.md b/docs/guidebook/zh/3_1_2_0_模型列表.md index 4791894c..5e62a724 100644 --- a/docs/guidebook/zh/3_1_2_0_模型列表.md +++ b/docs/guidebook/zh/3_1_2_0_模型列表.md @@ -1,14 +1,16 @@ # 模型（LLM）列表 目前平台已经接入了如下模型列表，详细使用方式请关注本章节各LLM的说明。 -| 模型LLM(系列)名称 | -|------------------------------| -| [OpenAI](3_1_2_OpenAI使用.md) | -| [通义千问](3_1_2_Qwen使用.md) | -| [文心一言](3_1_2_文心使用.md) | -| [Kimi](3_1_2_Kimi使用.md) | -| [百川](3_1_2_百川使用.md) | +| 模型LLM(系列)名称 | +|----------------------------------| +| [OpenAI](3_1_2_OpenAI使用.md) | +| [通义千问](3_1_2_Qwen使用.md) | +| [文心一言](3_1_2_文心使用.md) | +| [Kimi](3_1_2_Kimi使用.md) | +| [百川](3_1_2_百川使用.md) | +| [Claude](3_1_2_Claude使用.md) | +| [ollama](3_1_2_Ollama使用.md) | 未在列表中的模型您可以根据[模型定义](2_2_2_模型定义与使用.md)中的步骤自定义接入任何模型。 -同时我们正在添加Claude、Gemini、ollama、Llama、ZhipuAI等常见LLM的接入方式，如果您在工程中使用了这些LLM并创建了属于自己的实例，欢迎您提交pr成为agentUniverse的contributor。 \ No newline at end of file +同时我们正在添加Gemini、Llama、ZhipuAI等常见LLM的接入方式，如果您在工程中使用了这些LLM并创建了属于自己的实例，欢迎您提交pr成为agentUniverse的contributor。 \ No newline at end of file