From 0fa4b8222c2e7b900151317cf9ce2080ef80f070 Mon Sep 17 00:00:00 2001
From: shanshi <wyp311395@antgroup.com>
Date: Mon, 29 Jan 2024 11:40:31 +0800
Subject: [PATCH] update readmes docs about coagent

---
 README.md                                     | 1 +
 README_en.md                                  | 1 +
 sources/readme_docs/coagent/agent-flow-en.md  | 3 +++
 sources/readme_docs/coagent/agent-flow.md     | 4 ++++
 sources/readme_docs/coagent/coagent-en.md     | 2 +-
 sources/readme_docs/coagent/coagent.md        | 2 +-
 sources/readme_docs/coagent/quick-start-en.md | 5 +++++
 sources/readme_docs/coagent/quick-start.md    | 4 ++++
 8 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 34f5aba..7b04f37 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ DevOps-ChatBot是由蚂蚁CodeFuse团队开发的开源AI智能助手，致力
 
 
 ## 🔔 更新
+- [2024.01.29] 开放可配置化的multi-agent框架：coagent，详情见[使用说明](sources/readme_docs/coagent/coagent.md)
 - [2023.12.26] 基于FastChat接入开源私有化大模型和大模型接口的能力开放
 - [2023.12.14] 量子位公众号专题报道：[文章链接](https://mp.weixin.qq.com/s/MuPfayYTk9ZW6lcqgMpqKA)
 - [2023.12.01] Multi-Agent和代码库检索功能开放
diff --git a/README_en.md b/README_en.md
index c3c6c45..99752eb 100644
--- a/README_en.md
+++ b/README_en.md
@@ -13,6 +13,7 @@ This project is an open-source AI intelligent assistant, specifically designed f
 
 
 ## 🔔 Updates
+- [2024.01.29] A configurational multi-agent framework, CoAgent, has been open-sourced. For more details, please refer to [coagent](sources/readme_docs/coagent/coagent-en.md)
 - [2023.12.26] Opening the capability to integrate with open-source private large models and large model interfaces based on FastChat
 - [2023.12.01] Release of Multi-Agent and codebase retrieval functionalities.
 - [2023.11.15] Addition of Q&A enhancement mode based on the local codebase.
diff --git a/sources/readme_docs/coagent/agent-flow-en.md b/sources/readme_docs/coagent/agent-flow-en.md
index abbb9d7..8f69289 100644
--- a/sources/readme_docs/coagent/agent-flow-en.md
+++ b/sources/readme_docs/coagent/agent-flow-en.md
@@ -1,4 +1,7 @@
 
+## Attention
+Attention：The overall content is not yet complete, and further refinements to the flow and other Agent diagrams will be made in the future.
+
 ## Introduction to Core Connectors
 To facilitate everyone's understanding of the entire CoAgent link, we use a Flow format to detail how to build through configuration settings.
 
diff --git a/sources/readme_docs/coagent/agent-flow.md b/sources/readme_docs/coagent/agent-flow.md
index 39f44f7..bd4cbbb 100644
--- a/sources/readme_docs/coagent/agent-flow.md
+++ b/sources/readme_docs/coagent/agent-flow.md
@@ -1,4 +1,8 @@
 
+
+## 注意
+注意：整体内容未完善，后续还会完善flow和其它Agent的图例
+
 ## 核心Connector介绍
 为了便于大家理解整个 CoAgent 的链路，我们采取 Flow 的形式来详细介绍如何通过配置构建
 
diff --git a/sources/readme_docs/coagent/coagent-en.md b/sources/readme_docs/coagent/coagent-en.md
index f1487ae..e2fef9c 100644
--- a/sources/readme_docs/coagent/coagent-en.md
+++ b/sources/readme_docs/coagent/coagent-en.md
@@ -34,7 +34,7 @@ The following modules will introduce the necessary components of the Multi Agent
 In summary, these five elements together construct a Multi-Agent framework, ensuring closer and more efficient cooperation between Agents while also adapting to more complex task requirements and a variety of interaction scenarios. By combining multiple Agent chains to implement a complete and complex project launch scenario (Dev Phase), such as Demand Chain (CEO), Product Argument Chain (CPO, CFO, CTO), Engineer Group Chain (Selector, Developer1~N), QA Engineer Chain (Developer, Tester), Deploy Chain (Developer, Deployer).
 
 ## 模块分类
-- [connector](/sources/readme_docs/coagent/connector.md)
+- [connector](/sources/readme_docs/coagent/connector/connector_agent.md)
 - document_loaders
 - embeddings
 - llm_models
diff --git a/sources/readme_docs/coagent/coagent.md b/sources/readme_docs/coagent/coagent.md
index 2c02a6a..fb7a5cc 100644
--- a/sources/readme_docs/coagent/coagent.md
+++ b/sources/readme_docs/coagent/coagent.md
@@ -38,7 +38,7 @@
 
 
 ## 模块分类
-- [connector](/sources/readme_docs/coagent/connector.md)
+- [connector](/sources/readme_docs/coagent/connector/connector_agent.md)
 - document_loaders
 - embeddings
 - llm_models
diff --git a/sources/readme_docs/coagent/quick-start-en.md b/sources/readme_docs/coagent/quick-start-en.md
index 9b55912..c4488e5 100644
--- a/sources/readme_docs/coagent/quick-start-en.md
+++ b/sources/readme_docs/coagent/quick-start-en.md
@@ -11,6 +11,11 @@ aliases:
 
 
 ## Quick Start
+Attention：
+Testing has only been conducted on GPT-3.5-turbo and higher models. 
+The models need to possess strong command-following capabilities. 
+It is recommended to test with more powerful models like qwen-72b, openai, etc.
+
 ### First, set up the LLM configuration
 ```
 import os, sys
diff --git a/sources/readme_docs/coagent/quick-start.md b/sources/readme_docs/coagent/quick-start.md
index 604e144..574d2a1 100644
--- a/sources/readme_docs/coagent/quick-start.md
+++ b/sources/readme_docs/coagent/quick-start.md
@@ -10,6 +10,10 @@ aliases:
 
 
 ## 快速使用
+注意：
+只在GPT-3.5-turbo及以上模型进行过测试。需要模型具备较强的指令遵循能力。
+推荐拿qwen-72b、openai等较强的模型进行测试
+
 ### 首先，填写LLM配置
 ```
 import os, sys