Browse Source

update README

ling 3 months ago
parent
commit
a9266b9268
1 changed files with 13 additions and 28 deletions
  1. 13 28
      README.md

+ 13 - 28
README.md

@@ -4,17 +4,13 @@
 
 ## 目錄
 - [專案概述](#專案概述)
-- [主要組件](#主要組件)
-- [安裝](#安裝)
 - [使用方式](#使用方式)
 - [檔案說明](#檔案說明)
-- [貢獻](#貢獻)
-- [授權](#授權)
 
 ## 專案概述
 此 multi-agent 系統旨在透過判斷使用者提問而選擇使用客戶自有資料庫或外部專業知識來源,回答使用者提問。系統包含兩個主要代理:
 1. 客戶自有資料 agent:使用 **Text-to-SQL** 技術,用於處理客戶自有的結構化數據。
-2. 外部專業知識 agent:使用 **RAG** 技術,並以 **FAISS** 實現 RAG 的 retriever,用於從外部非結構化知識中檢索並生成答案。
+2. 外部專業知識 agent:使用 **RAG** 技術,並以 **FAISS** 實現 RAG 的 retriever 功能,用於從外部非結構化知識中檢索並生成答案。
 
 ## 使用方式
 
@@ -26,26 +22,15 @@ python systex_app.py
 FastAPI Link: https://cmm.ai:8989/docs
 
 共有四個 API,如下:
-1. `/agent`:
-2. `/knowledge`
-3. `local_agents`
-4. `history`
-
-## 檔案說明
-
-- **`app.py`**:運行多代理系統的主入口。
-- **`ai_agent.py`**:定義多代理架構,包括 Text-to-SQL 和 RAG 代理。該架構由 `langgraph` 驅動。
-- **`faiss_index.py`**:管理 FAISS 檢索器,為 RAG 提供文件檢索功能。
-- **`tex_to_sql_private.py`**:包含將自然語言轉換為 SQL 查詢的邏輯,負責處理客戶自有資料。
-
-## 貢獻
-
-歡迎任何貢獻!如有改進建議或發現錯誤,請提交 Pull Request 或開啟 Issue。
-
-## 授權
-
-此專案依據 MIT 授權條款發布 - 詳情請參閱 [LICENSE](LICENSE) 檔案。
-
----
-
-這樣的 README 是否符合你的需求?如果有其他資訊要補充,隨時告訴我!
+1. `/agent`: 完整的 multi-agent 架構,包含自有數據與知識問答,使用的 LLM 是 GPT-4o-mini
+2. `/knowledge`: 僅有知識問答,使用的 LLM 是 GPT-4o-mini
+3. `/local_agents`: 完整的 multi-agent 架構,包含自有數據與知識問答,使用的 LLM 是 local LLM,根據不同任務選擇使用不同的 local LLM
+4. `/history`: 所有問答紀錄(使用前三個 API 的問答紀錄)
+
+## 主要檔案說明
+
+- **`systex_app.py`**:API file。
+- **`ai_agent.py`**:定義 multi-agent 架構,包括 Text-to-SQL 和 RAG agent。該架構使用 `langgraph` 框架建立。
+- **`ai_agent_llama.py`**:同 `ai_agent.py`,改為使用 local LLM
+- **`faiss_index.py`**:處理 RAG 所需的 retriever 功能,用來處理文字向量資料。
+- **`tex_to_sql_private.py`**:將自然語言轉換為 SQL query,用來處理客戶自有資料。