+
🎉 Langchain-Chatchat 项目微信交流群，如果你也对本项目感兴趣，欢迎加入群聊参与讨论交流。
### 公众号
-
+
🎉 Langchain-Chatchat 项目官方公众号，欢迎扫码关注。
-
-
-## 引用
-
-如果本项目有帮助到您的研究，请引用我们：
-
-```
-@software{langchain_chatchat,
- title = {{langchain-chatchat}},
- author = {Liu, Qian and Song, Jinke, and Huang, Zhiguo, and Zhang, Yuxuan, and glide-the, and liunux4odoo},
- year = 2024,
- journal = {GitHub repository},
- publisher = {GitHub},
- howpublished = {\url{https://github.com/chatchat-space/Langchain-Chatchat}}
-}
-```
\ No newline at end of file
diff --git a/README_en.md b/README_en.md
index 5959b0fcb6..f1d0100d8b 100644
--- a/README_en.md
+++ b/README_en.md
@@ -1,511 +1,207 @@
-
+
-🌍 [READ THIS IN CHINESE](README.md)
+🌍 [中文文档](README.md)
+🌍 [日本語で読む](README_ja.md)
-📃 **LangChain-Chatchat** (formerly Langchain-ChatGLM)
+📃 **LangChain-Chatchat** (formerly Langchain-ChatGLM):
-An open-source, offline-deployable RAG and Agent application project based on large language models like ChatGLM and
-application frameworks like Langchain.
+A LLM application aims to implement knowledge and search engine based QA based on Langchain and open-source or remote
+LLM API.
----
-
-## Contents
-
-* [Overview](README_en.md#Overview)
-* [Features](README_en.md#What-Does-Langchain-Chatchat-Offer)
-* [Quick Start](README_en.md#Quick-Start)
- * [Installation](README_en.md#Installation)
-* [Contact Us](README_en.md#Contact-Us)
-
-## Overview
-
-🤖️ A question-answering application based on local knowledge bases using
-the [langchain](https://github.com/langchain-ai/langchain) concept. The goal is to create a friendly and
-offline-operable knowledge base Q&A solution that supports Chinese scenarios and open-source models.
-
-💡 Inspired by [GanymedeNil](https://github.com/GanymedeNil)'s
-project [document.ai](https://github.com/GanymedeNil/document.ai) and [AlexZhangji](https://github.com/AlexZhangji)'
-s [ChatGLM-6B Pull Request](https://github.com/THUDM/ChatGLM-6B/pull/216), this project aims to establish a local
-knowledge base Q&A application fully utilizing open-source models. The latest version of the project
-uses [FastChat](https://github.com/lm-sys/FastChat) to integrate models like Vicuna, Alpaca, LLaMA, Koala, and RWKV,
-leveraging the [langchain](https://github.com/langchain-ai/langchain) framework to support API calls provided
-by [FastAPI](https://github.com/tiangolo/fastapi) or operations using a WebUI based
-on [Streamlit](https://github.com/streamlit/streamlit).
-
-
-
-✅ This project supports mainstream open-source LLMs, embedding models, and vector databases, allowing full **open-source
-** model **offline private deployment**. Additionally, the project supports OpenAI GPT API
-calls and will continue to expand access to various models and model APIs.
-
-⛓️ The implementation principle of this project is as shown below, including loading files -> reading text -> text
-segmentation -> text vectorization -> question vectorization -> matching the `top k` most similar text vectors with the
-question vector -> adding the matched text as context along with the question to the `prompt` -> submitting to the `LLM`
-for generating answers.
-
-📺 [Introduction Video](https://www.bilibili.com/video/BV13M4y1e7cN/?share_source=copy_web&vd_source=e6c5aafe684f30fbe41925d61ca6d514)
-
-
-
-From the document processing perspective, the implementation process is as follows:
-
-
-
-🚩 This project does not involve fine-tuning or training processes but can utilize fine-tuning or training to optimize
-the project's performance.
-
-🌐 The `0.3.0` version code used in
-the [AutoDL Mirror](https://www.codewithgpu.com/i/chatchat-space/Langchain-Chatchat/Langchain-Chatchat) has been updated
-to version `v0.3.0` of this project.
-
-🐳 Docker images will be updated soon.
-
-🧑💻 If you want to contribute to this project, please refer to the [Developer Guide](docs/contributing/README_dev.md)
-for more information on development and deployment.
-
-## What Does Langchain-Chatchat Offer
-
-### Features of Version 0.3.x
-
-| Features | 0.2.x | 0.3.x |
-|---------------------------------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Model Integration | Local: fastchat
+[](https://t.me/+RjliQ3jnJ1YyN2E9)
-🎉 Langchain-Chatchat project WeChat exchange group, if you are also interested in this project, welcome to join the group chat to participate in the discussion.
+### WeChat Group
-### Official Account
+
-
+### WeChat Official Account
-🎉 Langchain-Chatchat project official public account, welcome to scan the code to follow.
+
diff --git a/README_ja.md b/README_ja.md
new file mode 100644
index 0000000000..350d127bd3
--- /dev/null
+++ b/README_ja.md
@@ -0,0 +1,200 @@
+
+
+🌍 [中文文档](README.md)
+🌍 [READ THIS IN ENGLISH](README_en.md)
+
+📃 **LangChain-Chatchat** (旧名 Langchain-ChatGLM)
+
+ChatGLM などの大規模な言語モデルや Langchain などのアプリケーション フレームワークに基づいた、オープン
+ソースのオフライン展開可能な検索拡張生成 (RAG) 大規模モデル ナレッジ ベース プロジェクトです。
+
+⚠️`0.2.10` は `0.2.x` シリーズの最終バージョンとなり、`0.2.x`
+シリーズはアップデートと技術サポートを終了し、より適用性の高い `Langchain-Chachat 0.3.x` の開発に努めます。 。
+`0.2.10` のその後のバグ修正は、バージョン更新なしで `master` ブランチに直接プッシュされます。
+
+---
+
+## 目次
+
+- [イントロ](README_ja.md#イントロ)
+- [ペインポイントへの対応](README_ja.md#ペインポイントへの対応)
+- [クイックスタート](README_ja.md#クイックスタート)
+ - [1. 環境セットアップ](README_ja.md#環境セットアップ)
+ - [2. モデルをダウンロード](README_ja.md#モデルをダウンロード)
+ - [3. ナレッジベースと設定ファイルの初期化](README_ja.md#ナレッジベースと設定ファイルの初期化)
+ - [4. ワンクリック起動](README_ja.md#ワンクリック起動)
+ - [5. 起動インターフェースの例](README_ja.md#起動インターフェースの例)
+- [お問い合わせ](README_ja.md#お問い合わせ)
+
+## イントロ
+
+🤖️ [langchain](https://github.com/hwchase17/langchain) のアイデアを用いて実装された、ローカルナレッジベースに基づく Q&A
+アプリケーション。
+目標は、中国のシナリオとオープンソースモデルに親和性があり、オフラインとオンラインの両方で実行可能な KBQA（ナレッジベースの
+Q&A）ソリューションを構築することです。
+
+💡 [document.ai](https://github.com/GanymedeNil/document.ai)
+と [ChatGLM-6B Pull Request](https://github.com/THUDM/ChatGLM-6B/pull/216) に触発され、
+プロセス全体を通してオープンソースモデルまたはリモート LLM api を使用して実装することができるローカルナレッジベースの質問応答アプリケーションを構築します。
+このプロジェクトの最新バージョンでは、[FastChat](https://github.com/lm-sys/FastChat)
+を使用して、Vicuna、Alpaca、LLaMA、Koala、RWKV、その他多くのモデルにアクセスしています。
+このプロジェクトは [langchain](https://github.com/langchain-ai/langchain)
+に依存し、[FastAPI](https://github.com/tiangolo/fastapi) に基づいて提供されるAPIを通してサービスを呼び出したり、
+[Streamlit](https://github.com/streamlit/streamlit) に基づいて WebUI を使ったりすることをサポートしています。
+
+✅ オープンソースの LLM と Embedding モデルに依存して、このプロジェクトはフルプロセスの **オフラインプライベートデプロイメント
+** を実現することができます。
+同時に、本プロジェクトは OpenAI GPT API や Zhipu API の呼び出しにも対応しており、今後も様々な機種やリモート API
+へのアクセスを拡大していきます。
+
+⛓️ このプロジェクトの実施原則を下のグラフに示します。主なプロセスは以下の通りです:
+ファイルの読み込み -> テキストの読み込み -> テキストのセグメンテーション -> テキストのベクトル化 -> 質問のベクトル化 ->
+質問ベクトルと最も似ている `top-k` をテキストベクトルでマッチング ->
+マッチしたテキストをコンテキストと質問として `prompt` に追加 -> 回答を生成するために `LLM` に送信。
+
+📺[video introduction](https://www.bilibili.com/video/BV13M4y1e7cN/?share_source=copy_web&vd_source=e6c5aafe684f30fbe41925d61ca6d514)
+
+
+
+文書プロセスの側面からの主なプロセス分析:
+
+
+
+🚩 トレーニングやファインチューニングはプロジェクトには含まれないが、これらを行うことで必ずパフォーマンスを向上させることができます。
+
+🌐 [AutoDL イメージ](registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.5)がサポートされ、`0.2.10` では v0.2.10
+にアップデートされました。
+
+🐳 [Docker イメージ](isafetech/chatchat:0.2.10)
+
+🌲 今回のアップデートにより、DockerHub、阿里雲、騰訊のクラウドにも対応しました。より広範なクラウド環境で利用可能となりました。
+
+```shell
+docker run -d --gpus all -p 80:8501 isafetech/chatchat:0.2.10
+docker run -d --gpus all -p 80:8501 uswccr.ccs.tencentyun.com/chatchat/chatchat:0.2.10
+docker run -d --gpus all -p 80:8501 registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.10
+```
+
+## ペインポイントへの対応
+
+このプロジェクトは、完全にローカライズされた推論によってナレッジベースを強化するソリューションであり、特にデータセキュリティと企業向けのプライベートな展開の問題に取り組んでいます。
+このオープンソースソリューションは Apache ライセンスに基づき、無償で商用利用できます。
+私たちは、市場で入手可能な主流のローカル大予言モデルや Embedding モデル、オープンソースのローカルベクターデータベースをサポートしています。
+対応機種とデータベースの詳細については、[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) をご参照ください。
+
+## クイックスタート
+
+### 環境セットアップ
+
+まず、マシンにPython 3.10がインストールされていることを確認してください。
+
+```
+$ python --version
+Python 3.11.7
+```
+
+次に、仮想環境を作成し、プロジェクトの依存関係を仮想環境内にインストールする。
+
+```shell
+
+# リポジトリをクローン
+$ git clone https://github.com/chatchat-space/Langchain-Chatchat.git
+
+# ディレクトリに移動
+$ cd Langchain-Chatchat
+
+# すべての依存関係をインストール
+$ pip install -r requirements.txt
+$ pip install -r requirements_api.txt
+$ pip install -r requirements_webui.txt
+
+# デフォルトの依存関係には、基本的な実行環境(FAISS ベクターライブラリ)が含まれます。milvus/pg_vector などのベクターライブラリを使用する場合は、requirements.txt 内の対応する依存関係のコメントを解除してからインストールしてください。
+```
+
+LangChain-Chachat `0.2.x` シリーズは Langchain `0.0.x` シリーズ用です。Langchain `0.1.x` シリーズをお使いの場合は、ダウングレードする必要があります。
+
+### モデルをダウンロード
+
+このプロジェクトをローカルまたはオフライン環境で実行する必要がある場合は、まずプロジェクトに必要なモデルをダウンロードする必要があります。
+通常、オープンソースの LLM と Embedding モデルは Hugging Face からダウンロードできる。
+
+このプロジェクトで使用されているデフォルトの LLM
+モデルである [THUDM/chatglm2-6b](https://huggingface.co/THUDM/chatglm2-6b)と、Embedding
+モデル [moka-ai/m3e-base](https://huggingface.co/moka-ai/m3e-base) を例にとると、次のようになります:
+
+モデルをダウンロードするには、まず [Git LFS](https://docs.github.com/zh/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
+をインストールし、次のように実行する必要があります:
+
+```Shell
+$ git lfs install
+$ git clone https://huggingface.co/THUDM/chatglm2-6b
+$ git clone https://huggingface.co/moka-ai/m3e-base
+```
+
+### ナレッジベースと設定ファイルの初期化
+
+以下の手順に従って、ナレッジベースと設定ファイルを初期化してください:
+
+```shell
+$ python copy_config_example.py
+$ python init_database.py --recreate-vs
+ ```
+
+### ワンクリック起動
+
+プロジェクトを開始するには、次のコマンドを実行します:
+
+```shell
+$ python startup.py -a
+```
+
+### 起動インターフェースの例
+
+1. FastAPI docs インターフェース
+
+
+
+2. webui ページ
+
+- Web UI ダイアログページ:
+
+
+
+- Web UI ナレッジベースマネジメントページ:
+
+
+
+### 注
+
+上記の手順はクイックスタートのために提供されています。より多くの機能が必要な場合や、起動方法をカスタマイズしたい場合は、[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/)
+を参照してください。
+
+---
+
+## プロジェクトのマイルストーン
+
++ `2023 年 4 月`: `Langchain-ChatGLM 0.1.0` がリリースされ、ChatGLM-6B モデルに基づくローカル ナレッジ ベースの質問と回答がサポートされました。
++ `2023 年 8 月`: `Langchain-ChatGLM` は `Langchain-Chatchat` に名前変更され、モデル読み込みソリューションとして `fastchat` を使用し、より多くのモデルとデータベースをサポートする `0.2.0` がリリースされました。
++ `2023 年 10 月`: `Langchain-Chachat 0.2.5` リリース、エージェント コンテンツ、オープンソース プロジェクトを`Founder Park & Zhipu AI & Zilliz`で開始
+ 開催したハッカソンでは3位に入賞しました。
++ `2023 年 12 月`: `Langchain-Chachat`オープンソース プロジェクトは **20,000** つ以上のスターを獲得しました。
++ `2024 年 1 月`: `LangChain 0.1.x` がリリースされ、`Langchain-Chachat 0.2.x` が安定版 `0.2.10` をリリースしました。
+ 今後はアップデートと技術サポートを停止し、より適用性の高い`Langchain-Chachat 0.3.x`の開発に努める予定です。
+
++ 🔥 これからのChatchatストーリーを一緒に楽しみにしましょう···
+
+---
+
+## お問い合わせ
+
+### Telegram
+
+[](https://t.me/+RjliQ3jnJ1YyN2E9)
+
+### WeChat グループ
+
+
+
+### WeChat 公式アカウント
+
+
diff --git a/chains/llmchain_with_history.py b/chains/llmchain_with_history.py
new file mode 100644
index 0000000000..2a84508617
--- /dev/null
+++ b/chains/llmchain_with_history.py
@@ -0,0 +1,22 @@
+from server.utils import get_ChatOpenAI
+from configs.model_config import LLM_MODELS, TEMPERATURE
+from langchain.chains import LLMChain
+from langchain.prompts.chat import (
+ ChatPromptTemplate,
+ HumanMessagePromptTemplate,
+)
+
+model = get_ChatOpenAI(model_name=LLM_MODELS[0], temperature=TEMPERATURE)
+
+
+human_prompt = "{input}"
+human_message_template = HumanMessagePromptTemplate.from_template(human_prompt)
+
+chat_prompt = ChatPromptTemplate.from_messages(
+ [("human", "我们来玩成语接龙，我先来，生龙活虎"),
+ ("ai", "虎头虎脑"),
+ ("human", "{input}")])
+
+
+chain = LLMChain(prompt=chat_prompt, llm=model, verbose=True)
+print(chain({"input": "恼羞成怒"}))
\ No newline at end of file
diff --git a/libs/chatchat-server/chatchat/server/__init__.py b/common/__init__.py
similarity index 100%
rename from libs/chatchat-server/chatchat/server/__init__.py
rename to common/__init__.py
diff --git a/configs/__init__.py b/configs/__init__.py
new file mode 100644
index 0000000000..e4f5f1d049
--- /dev/null
+++ b/configs/__init__.py
@@ -0,0 +1,8 @@
+from .basic_config import *
+from .model_config import *
+from .kb_config import *
+from .server_config import *
+from .prompt_config import *
+
+
+VERSION = "v0.2.10"
diff --git a/configs/basic_config.py b/configs/basic_config.py.example
similarity index 100%
rename from configs/basic_config.py
rename to configs/basic_config.py.example
diff --git a/configs/kb_config.py b/configs/kb_config.py.example
similarity index 100%
rename from configs/kb_config.py
rename to configs/kb_config.py.example
diff --git a/configs/model_config.py b/configs/model_config.py
deleted file mode 100644
index 0667eac74d..0000000000
--- a/configs/model_config.py
+++ /dev/null
@@ -1,328 +0,0 @@
-import os
-
-# 可以指定一个绝对路径，统一存放所有的Embedding和LLM模型。
-# 每个模型可以是一个单独的目录，也可以是某个目录下的二级子目录。
-# 如果模型目录名称和 MODEL_PATH 中的 key 或 value 相同，程序会自动检测加载，无需修改 MODEL_PATH 中的路径。
-MODEL_ROOT_PATH = ""
-
-# 选用的 Embedding 名称
-EMBEDDING_MODEL = "bge-large-zh-v1.5"
-
-# Embedding 模型运行设备。设为 "auto" 会自动检测(会有警告)，也可手动设定为 "cuda","mps","cpu","xpu" 其中之一。
-EMBEDDING_DEVICE = "auto"
-
-# 选用的reranker模型
-RERANKER_MODEL = "bge-reranker-large"
-# 是否启用reranker模型
-USE_RERANKER = False
-RERANKER_MAX_LENGTH = 1024
-
-# 如果需要在 EMBEDDING_MODEL 中增加自定义的关键字时配置
-EMBEDDING_KEYWORD_FILE = "keywords.txt"
-EMBEDDING_MODEL_OUTPUT_PATH = "output"
-
-# 要运行的 LLM 名称，可以包括本地模型和在线模型。列表中本地模型将在启动项目时全部加载。
-# 列表中第一个模型将作为 API 和 WEBUI 的默认模型。
-# 在这里，我们使用目前主流的两个离线模型，其中，chatglm3-6b 为默认加载模型。
-# 如果你的显存不足，可使用 Qwen-1_8B-Chat, 该模型 FP16 仅需 3.8G显存。
-
-# LLM_MODELS = ["chatglm3-6b", "zhipu-api", "openai-api"]
-LLM_MODELS = ["Qwen1.5-4B-Chat"]
-Agent_MODEL = None
-
-# LLM 模型运行设备。设为"auto"会自动检测(会有警告)，也可手动设定为 "cuda","mps","cpu","xpu" 其中之一。
-LLM_DEVICE = "auto"
-
-HISTORY_LEN = 3
-
-MAX_TOKENS = 2048
-
-TEMPERATURE = 0.7
-
-ONLINE_LLM_MODEL = {
- "openai-api": {
- "model_name": "gpt-4",
- "api_base_url": "https://api.openai.com/v1",
- "api_key": "",
- "openai_proxy": "",
- },
-
- # 智谱AI API,具体注册及api key获取请前往 http://open.bigmodel.cn
- "zhipu-api": {
- "api_key": "",
- "version": "glm-4",
- "provider": "ChatGLMWorker",
- },
-
- # 具体注册及api key获取请前往 https://api.minimax.chat/
- "minimax-api": {
- "group_id": "",
- "api_key": "",
- "is_pro": False,
- "provider": "MiniMaxWorker",
- },
-
- # 具体注册及api key获取请前往 https://xinghuo.xfyun.cn/
- "xinghuo-api": {
- "APPID": "",
- "APISecret": "",
- "api_key": "",
- "version": "v3.5", # 你使用的讯飞星火大模型版本，可选包括 "v3.5","v3.0", "v2.0", "v1.5"
- "provider": "XingHuoWorker",
- },
-
- # 百度千帆 API，申请方式请参考 https://cloud.baidu.com/doc/WENXINWORKSHOP/s/4lilb2lpf
- "qianfan-api": {
- "version": "ERNIE-Bot", # 注意大小写。当前支持 "ERNIE-Bot" 或 "ERNIE-Bot-turbo"， 更多的见官方文档。
- "version_url": "", # 也可以不填写version，直接填写在千帆申请模型发布的API地址
- "api_key": "",
- "secret_key": "",
- "provider": "QianFanWorker",
- },
-
- # 火山方舟 API，文档参考 https://www.volcengine.com/docs/82379
- "fangzhou-api": {
- "version": "", # 对应火山方舟的 endpoint_id
- "version_url": "",
- "api_key": "",
- "secret_key": "",
- "provider": "FangZhouWorker",
- },
-
- # 阿里云通义千问 API，文档参考 https://help.aliyun.com/zh/dashscope/developer-reference/api-details
- "qwen-api": {
- "version": "qwen-max",
- "api_key": "",
- "provider": "QwenWorker",
- "embed_model": "text-embedding-v1" # embedding 模型名称
- },
-
- # 百川 API，申请方式请参考 https://www.baichuan-ai.com/home#api-enter
- "baichuan-api": {
- "version": "Baichuan2-53B",
- "api_key": "",
- "secret_key": "",
- "provider": "BaiChuanWorker",
- },
-
- # Azure API
- "azure-api": {
- "deployment_name": "", # 部署容器的名字
- "resource_name": "", # https://{resource_name}.openai.azure.com/openai/ 填写resource_name的部分，其他部分不要填写
- "api_version": "", # API的版本，不是模型版本
- "api_key": "",
- "provider": "AzureWorker",
- },
-
- # 昆仑万维天工 API https://model-platform.tiangong.cn/
- "tiangong-api": {
- "version": "SkyChat-MegaVerse",
- "api_key": "",
- "secret_key": "",
- "provider": "TianGongWorker",
- },
-
- # Gemini API https://makersuite.google.com/app/apikey
- "gemini-api": {
- "api_key": "",
- "provider": "GeminiWorker",
- },
-
- # Claude API : https://www.anthropic.com/api
- # Available models:
- # Claude 3 Opus: claude-3-opus-20240229
- # Claude 3 Sonnet claude-3-sonnet-20240229
- # Claude 3 Haiku claude-3-haiku-20240307
- "claude-api": {
- "api_key": "",
- "version": "2023-06-01",
- "model_name":"claude-3-opus-20240229",
- "provider": "ClaudeWorker",
- }
-
-}
-
-# 在以下字典中修改属性值，以指定本地embedding模型存储位置。支持3种设置方法：
-# 1、将对应的值修改为模型绝对路径
-# 2、不修改此处的值（以 text2vec 为例）：
-# 2.1 如果{MODEL_ROOT_PATH}下存在如下任一子目录：
-# - text2vec
-# - GanymedeNil/text2vec-large-chinese
-# - text2vec-large-chinese
-# 2.2 如果以上本地路径不存在，则使用huggingface模型
-
-MODEL_PATH = {
- "embed_model": {
- "ernie-tiny": "nghuyong/ernie-3.0-nano-zh",
- "ernie-base": "nghuyong/ernie-3.0-base-zh",
- "text2vec-base": "shibing624/text2vec-base-chinese",
- "text2vec": "GanymedeNil/text2vec-large-chinese",
- "text2vec-paraphrase": "shibing624/text2vec-base-chinese-paraphrase",
- "text2vec-sentence": "shibing624/text2vec-base-chinese-sentence",
- "text2vec-multilingual": "shibing624/text2vec-base-multilingual",
- "text2vec-bge-large-chinese": "shibing624/text2vec-bge-large-chinese",
- "m3e-small": "moka-ai/m3e-small",
- "m3e-base": "moka-ai/m3e-base",
- "m3e-large": "moka-ai/m3e-large",
-
- "bge-small-zh": "BAAI/bge-small-zh",
- "bge-base-zh": "BAAI/bge-base-zh",
- "bge-large-zh": "BAAI/bge-large-zh",
- "bge-large-zh-noinstruct": "BAAI/bge-large-zh-noinstruct",
- "bge-base-zh-v1.5": "BAAI/bge-base-zh-v1.5",
- "bge-large-zh-v1.5": "BAAI/bge-large-zh-v1.5",
-
- "bge-m3": "BAAI/bge-m3",
-
- "piccolo-base-zh": "sensenova/piccolo-base-zh",
- "piccolo-large-zh": "sensenova/piccolo-large-zh",
- "nlp_gte_sentence-embedding_chinese-large": "damo/nlp_gte_sentence-embedding_chinese-large",
- "text-embedding-ada-002": "your OPENAI_API_KEY",
- },
-
- "llm_model": {
- "chatglm2-6b": "THUDM/chatglm2-6b",
- "chatglm2-6b-32k": "THUDM/chatglm2-6b-32k",
- "chatglm3-6b": "THUDM/chatglm3-6b",
- "chatglm3-6b-32k": "THUDM/chatglm3-6b-32k",
-
- "Orion-14B-Chat": "OrionStarAI/Orion-14B-Chat",
- "Orion-14B-Chat-Plugin": "OrionStarAI/Orion-14B-Chat-Plugin",
- "Orion-14B-LongChat": "OrionStarAI/Orion-14B-LongChat",
-
- "Llama-2-7b-chat-hf": "meta-llama/Llama-2-7b-chat-hf",
- "Llama-2-13b-chat-hf": "meta-llama/Llama-2-13b-chat-hf",
- "Llama-2-70b-chat-hf": "meta-llama/Llama-2-70b-chat-hf",
-
- "Qwen-1_8B-Chat": "Qwen/Qwen-1_8B-Chat",
- "Qwen-7B-Chat": "Qwen/Qwen-7B-Chat",
- "Qwen-14B-Chat": "Qwen/Qwen-14B-Chat",
- "Qwen-72B-Chat": "Qwen/Qwen-72B-Chat",
-
- # Qwen1.5 模型 VLLM可能出现问题
- "Qwen1.5-0.5B-Chat": "Qwen/Qwen1.5-0.5B-Chat",
- "Qwen1.5-1.8B-Chat": "Qwen/Qwen1.5-1.8B-Chat",
- "Qwen1.5-4B-Chat": "Qwen/Qwen1.5-4B-Chat",
- "Qwen1.5-7B-Chat": "Qwen/Qwen1.5-7B-Chat",
- "Qwen1.5-14B-Chat": "Qwen/Qwen1.5-14B-Chat",
- "Qwen1.5-72B-Chat": "Qwen/Qwen1.5-72B-Chat",
-
- "baichuan-7b-chat": "baichuan-inc/Baichuan-7B-Chat",
- "baichuan-13b-chat": "baichuan-inc/Baichuan-13B-Chat",
- "baichuan2-7b-chat": "baichuan-inc/Baichuan2-7B-Chat",
- "baichuan2-13b-chat": "baichuan-inc/Baichuan2-13B-Chat",
-
- "internlm-7b": "internlm/internlm-7b",
- "internlm-chat-7b": "internlm/internlm-chat-7b",
- "internlm2-chat-7b": "internlm/internlm2-chat-7b",
- "internlm2-chat-20b": "internlm/internlm2-chat-20b",
-
- "BlueLM-7B-Chat": "vivo-ai/BlueLM-7B-Chat",
- "BlueLM-7B-Chat-32k": "vivo-ai/BlueLM-7B-Chat-32k",
-
- "Yi-34B-Chat": "https://huggingface.co/01-ai/Yi-34B-Chat",
-
- "agentlm-7b": "THUDM/agentlm-7b",
- "agentlm-13b": "THUDM/agentlm-13b",
- "agentlm-70b": "THUDM/agentlm-70b",
-
- "falcon-7b": "tiiuae/falcon-7b",
- "falcon-40b": "tiiuae/falcon-40b",
- "falcon-rw-7b": "tiiuae/falcon-rw-7b",
-
- "aquila-7b": "BAAI/Aquila-7B",
- "aquilachat-7b": "BAAI/AquilaChat-7B",
- "open_llama_13b": "openlm-research/open_llama_13b",
- "vicuna-13b-v1.5": "lmsys/vicuna-13b-v1.5",
- "koala": "young-geng/koala",
- "mpt-7b": "mosaicml/mpt-7b",
- "mpt-7b-storywriter": "mosaicml/mpt-7b-storywriter",
- "mpt-30b": "mosaicml/mpt-30b",
- "opt-66b": "facebook/opt-66b",
- "opt-iml-max-30b": "facebook/opt-iml-max-30b",
- "gpt2": "gpt2",
- "gpt2-xl": "gpt2-xl",
- "gpt-j-6b": "EleutherAI/gpt-j-6b",
- "gpt4all-j": "nomic-ai/gpt4all-j",
- "gpt-neox-20b": "EleutherAI/gpt-neox-20b",
- "pythia-12b": "EleutherAI/pythia-12b",
- "oasst-sft-4-pythia-12b-epoch-3.5": "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
- "dolly-v2-12b": "databricks/dolly-v2-12b",
- "stablelm-tuned-alpha-7b": "stabilityai/stablelm-tuned-alpha-7b",
- },
-
- "reranker": {
- "bge-reranker-large": "BAAI/bge-reranker-large",
- "bge-reranker-base": "BAAI/bge-reranker-base",
- }
-}
-
-# 通常情况下不需要更改以下内容
-
-# nltk 模型存储路径
-NLTK_DATA_PATH = os.path.join(os.path.dirname(os.path.dirname(__file__)), "nltk_data")
-
-# 使用VLLM可能导致模型推理能力下降，无法完成Agent任务
-VLLM_MODEL_DICT = {
- "chatglm2-6b": "THUDM/chatglm2-6b",
- "chatglm2-6b-32k": "THUDM/chatglm2-6b-32k",
- "chatglm3-6b": "THUDM/chatglm3-6b",
- "chatglm3-6b-32k": "THUDM/chatglm3-6b-32k",
-
- "Llama-2-7b-chat-hf": "meta-llama/Llama-2-7b-chat-hf",
- "Llama-2-13b-chat-hf": "meta-llama/Llama-2-13b-chat-hf",
- "Llama-2-70b-chat-hf": "meta-llama/Llama-2-70b-chat-hf",
-
- "Qwen-1_8B-Chat": "Qwen/Qwen-1_8B-Chat",
- "Qwen-7B-Chat": "Qwen/Qwen-7B-Chat",
- "Qwen-14B-Chat": "Qwen/Qwen-14B-Chat",
- "Qwen-72B-Chat": "Qwen/Qwen-72B-Chat",
-
- "baichuan-7b-chat": "baichuan-inc/Baichuan-7B-Chat",
- "baichuan-13b-chat": "baichuan-inc/Baichuan-13B-Chat",
- "baichuan2-7b-chat": "baichuan-inc/Baichuan-7B-Chat",
- "baichuan2-13b-chat": "baichuan-inc/Baichuan-13B-Chat",
-
- "BlueLM-7B-Chat": "vivo-ai/BlueLM-7B-Chat",
- "BlueLM-7B-Chat-32k": "vivo-ai/BlueLM-7B-Chat-32k",
-
- "internlm-7b": "internlm/internlm-7b",
- "internlm-chat-7b": "internlm/internlm-chat-7b",
- "internlm2-chat-7b": "internlm/Models/internlm2-chat-7b",
- "internlm2-chat-20b": "internlm/Models/internlm2-chat-20b",
-
- "aquila-7b": "BAAI/Aquila-7B",
- "aquilachat-7b": "BAAI/AquilaChat-7B",
-
- "falcon-7b": "tiiuae/falcon-7b",
- "falcon-40b": "tiiuae/falcon-40b",
- "falcon-rw-7b": "tiiuae/falcon-rw-7b",
- "gpt2": "gpt2",
- "gpt2-xl": "gpt2-xl",
- "gpt-j-6b": "EleutherAI/gpt-j-6b",
- "gpt4all-j": "nomic-ai/gpt4all-j",
- "gpt-neox-20b": "EleutherAI/gpt-neox-20b",
- "pythia-12b": "EleutherAI/pythia-12b",
- "oasst-sft-4-pythia-12b-epoch-3.5": "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
- "dolly-v2-12b": "databricks/dolly-v2-12b",
- "stablelm-tuned-alpha-7b": "stabilityai/stablelm-tuned-alpha-7b",
- "open_llama_13b": "openlm-research/open_llama_13b",
- "vicuna-13b-v1.3": "lmsys/vicuna-13b-v1.3",
- "koala": "young-geng/koala",
- "mpt-7b": "mosaicml/mpt-7b",
- "mpt-7b-storywriter": "mosaicml/mpt-7b-storywriter",
- "mpt-30b": "mosaicml/mpt-30b",
- "opt-66b": "facebook/opt-66b",
- "opt-iml-max-30b": "facebook/opt-iml-max-30b",
-
-}
-
-SUPPORT_AGENT_MODEL = [
- "openai-api", # GPT4 模型
- "qwen-api", # Qwen Max模型
- "zhipu-api", # 智谱AI GLM4模型
- "Qwen", # 所有Qwen系列本地模型
- "chatglm3-6b",
- "internlm2-chat-20b",
- "Orion-14B-Chat-Plugin",
-]
diff --git a/configs/model_config.py.example b/configs/model_config.py.example
new file mode 100644
index 0000000000..af8f35ae10
--- /dev/null
+++ b/configs/model_config.py.example
@@ -0,0 +1,327 @@
+import os
+
+# 可以指定一个绝对路径，统一存放所有的Embedding和LLM模型。
+# 每个模型可以是一个单独的目录，也可以是某个目录下的二级子目录。
+# 如果模型目录名称和 MODEL_PATH 中的 key 或 value 相同，程序会自动检测加载，无需修改 MODEL_PATH 中的路径。
+MODEL_ROOT_PATH = ""
+
+# 选用的 Embedding 名称
+EMBEDDING_MODEL = "bge-large-zh-v1.5"
+
+# Embedding 模型运行设备。设为 "auto" 会自动检测(会有警告)，也可手动设定为 "cuda","mps","cpu","xpu" 其中之一。
+EMBEDDING_DEVICE = "auto"
+
+# 选用的reranker模型
+RERANKER_MODEL = "bge-reranker-large"
+# 是否启用reranker模型
+USE_RERANKER = False
+RERANKER_MAX_LENGTH = 1024
+
+# 如果需要在 EMBEDDING_MODEL 中增加自定义的关键字时配置
+EMBEDDING_KEYWORD_FILE = "keywords.txt"
+EMBEDDING_MODEL_OUTPUT_PATH = "output"
+
+# 要运行的 LLM 名称，可以包括本地模型和在线模型。列表中本地模型将在启动项目时全部加载。
+# 列表中第一个模型将作为 API 和 WEBUI 的默认模型。
+# 在这里，我们使用目前主流的两个离线模型，其中，chatglm3-6b 为默认加载模型。
+# 如果你的显存不足，可使用 Qwen-1_8B-Chat, 该模型 FP16 仅需 3.8G显存。
+
+LLM_MODELS = ["chatglm3-6b", "zhipu-api", "openai-api"]
+Agent_MODEL = None
+
+# LLM 模型运行设备。设为"auto"会自动检测(会有警告)，也可手动设定为 "cuda","mps","cpu","xpu" 其中之一。
+LLM_DEVICE = "auto"
+
+HISTORY_LEN = 3
+
+MAX_TOKENS = 2048
+
+TEMPERATURE = 0.7
+
+ONLINE_LLM_MODEL = {
+ "openai-api": {
+ "model_name": "gpt-4",
+ "api_base_url": "https://api.openai.com/v1",
+ "api_key": "",
+ "openai_proxy": "",
+ },
+
+ # 智谱AI API,具体注册及api key获取请前往 http://open.bigmodel.cn
+ "zhipu-api": {
+ "api_key": "",
+ "version": "glm-4",
+ "provider": "ChatGLMWorker",
+ },
+
+ # 具体注册及api key获取请前往 https://api.minimax.chat/
+ "minimax-api": {
+ "group_id": "",
+ "api_key": "",
+ "is_pro": False,
+ "provider": "MiniMaxWorker",
+ },
+
+ # 具体注册及api key获取请前往 https://xinghuo.xfyun.cn/
+ "xinghuo-api": {
+ "APPID": "",
+ "APISecret": "",
+ "api_key": "",
+ "version": "v3.5", # 你使用的讯飞星火大模型版本，可选包括 "v3.5","v3.0", "v2.0", "v1.5"
+ "provider": "XingHuoWorker",
+ },
+
+ # 百度千帆 API，申请方式请参考 https://cloud.baidu.com/doc/WENXINWORKSHOP/s/4lilb2lpf
+ "qianfan-api": {
+ "version": "ERNIE-Bot", # 注意大小写。当前支持 "ERNIE-Bot" 或 "ERNIE-Bot-turbo"， 更多的见官方文档。
+ "version_url": "", # 也可以不填写version，直接填写在千帆申请模型发布的API地址
+ "api_key": "",
+ "secret_key": "",
+ "provider": "QianFanWorker",
+ },
+
+ # 火山方舟 API，文档参考 https://www.volcengine.com/docs/82379
+ "fangzhou-api": {
+ "version": "", # 对应火山方舟的 endpoint_id
+ "version_url": "",
+ "api_key": "",
+ "secret_key": "",
+ "provider": "FangZhouWorker",
+ },
+
+ # 阿里云通义千问 API，文档参考 https://help.aliyun.com/zh/dashscope/developer-reference/api-details
+ "qwen-api": {
+ "version": "qwen-max",
+ "api_key": "",
+ "provider": "QwenWorker",
+ "embed_model": "text-embedding-v1" # embedding 模型名称
+ },
+
+ # 百川 API，申请方式请参考 https://www.baichuan-ai.com/home#api-enter
+ "baichuan-api": {
+ "version": "Baichuan2-53B",
+ "api_key": "",
+ "secret_key": "",
+ "provider": "BaiChuanWorker",
+ },
+
+ # Azure API
+ "azure-api": {
+ "deployment_name": "", # 部署容器的名字
+ "resource_name": "", # https://{resource_name}.openai.azure.com/openai/ 填写resource_name的部分，其他部分不要填写
+ "api_version": "", # API的版本，不是模型版本
+ "api_key": "",
+ "provider": "AzureWorker",
+ },
+
+ # 昆仑万维天工 API https://model-platform.tiangong.cn/
+ "tiangong-api": {
+ "version": "SkyChat-MegaVerse",
+ "api_key": "",
+ "secret_key": "",
+ "provider": "TianGongWorker",
+ },
+
+ # Gemini API https://makersuite.google.com/app/apikey
+ "gemini-api": {
+ "api_key": "",
+ "provider": "GeminiWorker",
+ },
+
+ # Claude API : https://www.anthropic.com/api
+ # Available models:
+ # Claude 3 Opus: claude-3-opus-20240229
+ # Claude 3 Sonnet claude-3-sonnet-20240229
+ # Claude 3 Haiku claude-3-haiku-20240307
+ "claude-api": {
+ "api_key": "",
+ "version": "2023-06-01",
+ "model_name":"claude-3-opus-20240229",
+ "provider": "ClaudeWorker",
+ }
+
+}
+
+# 在以下字典中修改属性值，以指定本地embedding模型存储位置。支持3种设置方法：
+# 1、将对应的值修改为模型绝对路径
+# 2、不修改此处的值（以 text2vec 为例）：
+# 2.1 如果{MODEL_ROOT_PATH}下存在如下任一子目录：
+# - text2vec
+# - GanymedeNil/text2vec-large-chinese
+# - text2vec-large-chinese
+# 2.2 如果以上本地路径不存在，则使用huggingface模型
+
+MODEL_PATH = {
+ "embed_model": {
+ "ernie-tiny": "nghuyong/ernie-3.0-nano-zh",
+ "ernie-base": "nghuyong/ernie-3.0-base-zh",
+ "text2vec-base": "shibing624/text2vec-base-chinese",
+ "text2vec": "GanymedeNil/text2vec-large-chinese",
+ "text2vec-paraphrase": "shibing624/text2vec-base-chinese-paraphrase",
+ "text2vec-sentence": "shibing624/text2vec-base-chinese-sentence",
+ "text2vec-multilingual": "shibing624/text2vec-base-multilingual",
+ "text2vec-bge-large-chinese": "shibing624/text2vec-bge-large-chinese",
+ "m3e-small": "moka-ai/m3e-small",
+ "m3e-base": "moka-ai/m3e-base",
+ "m3e-large": "moka-ai/m3e-large",
+
+ "bge-small-zh": "BAAI/bge-small-zh",
+ "bge-base-zh": "BAAI/bge-base-zh",
+ "bge-large-zh": "BAAI/bge-large-zh",
+ "bge-large-zh-noinstruct": "BAAI/bge-large-zh-noinstruct",
+ "bge-base-zh-v1.5": "BAAI/bge-base-zh-v1.5",
+ "bge-large-zh-v1.5": "BAAI/bge-large-zh-v1.5",
+
+ "bge-m3": "BAAI/bge-m3",
+
+ "piccolo-base-zh": "sensenova/piccolo-base-zh",
+ "piccolo-large-zh": "sensenova/piccolo-large-zh",
+ "nlp_gte_sentence-embedding_chinese-large": "damo/nlp_gte_sentence-embedding_chinese-large",
+ "text-embedding-ada-002": "your OPENAI_API_KEY",
+ },
+
+ "llm_model": {
+ "chatglm2-6b": "THUDM/chatglm2-6b",
+ "chatglm2-6b-32k": "THUDM/chatglm2-6b-32k",
+ "chatglm3-6b": "THUDM/chatglm3-6b",
+ "chatglm3-6b-32k": "THUDM/chatglm3-6b-32k",
+
+ "Orion-14B-Chat": "OrionStarAI/Orion-14B-Chat",
+ "Orion-14B-Chat-Plugin": "OrionStarAI/Orion-14B-Chat-Plugin",
+ "Orion-14B-LongChat": "OrionStarAI/Orion-14B-LongChat",
+
+ "Llama-2-7b-chat-hf": "meta-llama/Llama-2-7b-chat-hf",
+ "Llama-2-13b-chat-hf": "meta-llama/Llama-2-13b-chat-hf",
+ "Llama-2-70b-chat-hf": "meta-llama/Llama-2-70b-chat-hf",
+
+ "Qwen-1_8B-Chat": "Qwen/Qwen-1_8B-Chat",
+ "Qwen-7B-Chat": "Qwen/Qwen-7B-Chat",
+ "Qwen-14B-Chat": "Qwen/Qwen-14B-Chat",
+ "Qwen-72B-Chat": "Qwen/Qwen-72B-Chat",
+
+ # Qwen1.5 模型 VLLM可能出现问题
+ "Qwen1.5-0.5B-Chat": "Qwen/Qwen1.5-0.5B-Chat",
+ "Qwen1.5-1.8B-Chat": "Qwen/Qwen1.5-1.8B-Chat",
+ "Qwen1.5-4B-Chat": "Qwen/Qwen1.5-4B-Chat",
+ "Qwen1.5-7B-Chat": "Qwen/Qwen1.5-7B-Chat",
+ "Qwen1.5-14B-Chat": "Qwen/Qwen1.5-14B-Chat",
+ "Qwen1.5-72B-Chat": "Qwen/Qwen1.5-72B-Chat",
+
+ "baichuan-7b-chat": "baichuan-inc/Baichuan-7B-Chat",
+ "baichuan-13b-chat": "baichuan-inc/Baichuan-13B-Chat",
+ "baichuan2-7b-chat": "baichuan-inc/Baichuan2-7B-Chat",
+ "baichuan2-13b-chat": "baichuan-inc/Baichuan2-13B-Chat",
+
+ "internlm-7b": "internlm/internlm-7b",
+ "internlm-chat-7b": "internlm/internlm-chat-7b",
+ "internlm2-chat-7b": "internlm/internlm2-chat-7b",
+ "internlm2-chat-20b": "internlm/internlm2-chat-20b",
+
+ "BlueLM-7B-Chat": "vivo-ai/BlueLM-7B-Chat",
+ "BlueLM-7B-Chat-32k": "vivo-ai/BlueLM-7B-Chat-32k",
+
+ "Yi-34B-Chat": "https://huggingface.co/01-ai/Yi-34B-Chat",
+
+ "agentlm-7b": "THUDM/agentlm-7b",
+ "agentlm-13b": "THUDM/agentlm-13b",
+ "agentlm-70b": "THUDM/agentlm-70b",
+
+ "falcon-7b": "tiiuae/falcon-7b",
+ "falcon-40b": "tiiuae/falcon-40b",
+ "falcon-rw-7b": "tiiuae/falcon-rw-7b",
+
+ "aquila-7b": "BAAI/Aquila-7B",
+ "aquilachat-7b": "BAAI/AquilaChat-7B",
+ "open_llama_13b": "openlm-research/open_llama_13b",
+ "vicuna-13b-v1.5": "lmsys/vicuna-13b-v1.5",
+ "koala": "young-geng/koala",
+ "mpt-7b": "mosaicml/mpt-7b",
+ "mpt-7b-storywriter": "mosaicml/mpt-7b-storywriter",
+ "mpt-30b": "mosaicml/mpt-30b",
+ "opt-66b": "facebook/opt-66b",
+ "opt-iml-max-30b": "facebook/opt-iml-max-30b",
+ "gpt2": "gpt2",
+ "gpt2-xl": "gpt2-xl",
+ "gpt-j-6b": "EleutherAI/gpt-j-6b",
+ "gpt4all-j": "nomic-ai/gpt4all-j",
+ "gpt-neox-20b": "EleutherAI/gpt-neox-20b",
+ "pythia-12b": "EleutherAI/pythia-12b",
+ "oasst-sft-4-pythia-12b-epoch-3.5": "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
+ "dolly-v2-12b": "databricks/dolly-v2-12b",
+ "stablelm-tuned-alpha-7b": "stabilityai/stablelm-tuned-alpha-7b",
+ },
+
+ "reranker": {
+ "bge-reranker-large": "BAAI/bge-reranker-large",
+ "bge-reranker-base": "BAAI/bge-reranker-base",
+ }
+}
+
+# 通常情况下不需要更改以下内容
+
+# nltk 模型存储路径
+NLTK_DATA_PATH = os.path.join(os.path.dirname(os.path.dirname(__file__)), "nltk_data")
+
+# 使用VLLM可能导致模型推理能力下降，无法完成Agent任务
+VLLM_MODEL_DICT = {
+ "chatglm2-6b": "THUDM/chatglm2-6b",
+ "chatglm2-6b-32k": "THUDM/chatglm2-6b-32k",
+ "chatglm3-6b": "THUDM/chatglm3-6b",
+ "chatglm3-6b-32k": "THUDM/chatglm3-6b-32k",
+
+ "Llama-2-7b-chat-hf": "meta-llama/Llama-2-7b-chat-hf",
+ "Llama-2-13b-chat-hf": "meta-llama/Llama-2-13b-chat-hf",
+ "Llama-2-70b-chat-hf": "meta-llama/Llama-2-70b-chat-hf",
+
+ "Qwen-1_8B-Chat": "Qwen/Qwen-1_8B-Chat",
+ "Qwen-7B-Chat": "Qwen/Qwen-7B-Chat",
+ "Qwen-14B-Chat": "Qwen/Qwen-14B-Chat",
+ "Qwen-72B-Chat": "Qwen/Qwen-72B-Chat",
+
+ "baichuan-7b-chat": "baichuan-inc/Baichuan-7B-Chat",
+ "baichuan-13b-chat": "baichuan-inc/Baichuan-13B-Chat",
+ "baichuan2-7b-chat": "baichuan-inc/Baichuan-7B-Chat",
+ "baichuan2-13b-chat": "baichuan-inc/Baichuan-13B-Chat",
+
+ "BlueLM-7B-Chat": "vivo-ai/BlueLM-7B-Chat",
+ "BlueLM-7B-Chat-32k": "vivo-ai/BlueLM-7B-Chat-32k",
+
+ "internlm-7b": "internlm/internlm-7b",
+ "internlm-chat-7b": "internlm/internlm-chat-7b",
+ "internlm2-chat-7b": "internlm/Models/internlm2-chat-7b",
+ "internlm2-chat-20b": "internlm/Models/internlm2-chat-20b",
+
+ "aquila-7b": "BAAI/Aquila-7B",
+ "aquilachat-7b": "BAAI/AquilaChat-7B",
+
+ "falcon-7b": "tiiuae/falcon-7b",
+ "falcon-40b": "tiiuae/falcon-40b",
+ "falcon-rw-7b": "tiiuae/falcon-rw-7b",
+ "gpt2": "gpt2",
+ "gpt2-xl": "gpt2-xl",
+ "gpt-j-6b": "EleutherAI/gpt-j-6b",
+ "gpt4all-j": "nomic-ai/gpt4all-j",
+ "gpt-neox-20b": "EleutherAI/gpt-neox-20b",
+ "pythia-12b": "EleutherAI/pythia-12b",
+ "oasst-sft-4-pythia-12b-epoch-3.5": "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
+ "dolly-v2-12b": "databricks/dolly-v2-12b",
+ "stablelm-tuned-alpha-7b": "stabilityai/stablelm-tuned-alpha-7b",
+ "open_llama_13b": "openlm-research/open_llama_13b",
+ "vicuna-13b-v1.3": "lmsys/vicuna-13b-v1.3",
+ "koala": "young-geng/koala",
+ "mpt-7b": "mosaicml/mpt-7b",
+ "mpt-7b-storywriter": "mosaicml/mpt-7b-storywriter",
+ "mpt-30b": "mosaicml/mpt-30b",
+ "opt-66b": "facebook/opt-66b",
+ "opt-iml-max-30b": "facebook/opt-iml-max-30b",
+
+}
+
+SUPPORT_AGENT_MODEL = [
+ "openai-api", # GPT4 模型
+ "qwen-api", # Qwen Max模型
+ "zhipu-api", # 智谱AI GLM4模型
+ "Qwen", # 所有Qwen系列本地模型
+ "chatglm3-6b",
+ "internlm2-chat-20b",
+ "Orion-14B-Chat-Plugin",
+]
diff --git a/configs/prompt_config.py b/configs/prompt_config.py
deleted file mode 100644
index 442b5a08a6..0000000000
--- a/configs/prompt_config.py
+++ /dev/null
@@ -1,135 +0,0 @@
-# prompt模板使用Jinja2语法，简单点就是用双大括号代替f-string的单大括号
-# 本配置文件支持热加载，修改prompt模板后无需重启服务。
-
-# LLM对话支持的变量：
-# - input: 用户输入内容
-
-# 知识库和搜索引擎对话支持的变量：
-# - context: 从检索结果拼接的知识文本
-# - question: 用户提出的问题
-
-# Agent对话支持的变量：
-
-# - tools: 可用的工具列表
-# - tool_names: 可用的工具名称列表
-# - history: 用户和Agent的对话历史
-# - input: 用户输入内容
-# - agent_scratchpad: Agent的思维记录
-
-PROMPT_TEMPLATES = {
- "llm_chat": {
- "default":
- '{{ input }}',
-
- "with_history":
- 'The following is a friendly conversation between a human and an AI. '
- 'The AI is talkative and provides lots of specific details from its context. '
- 'If the AI does not know the answer to a question, it truthfully says it does not know.\n\n'
- 'Current conversation:\n'
- '{history}\n'
- 'Human: {input}\n'
- 'AI:',
-
- "py":
- '你是一个聪明的代码助手，请你给我写出简单的py代码。 \n'
- '{{ input }}',
- },
-
-
- "knowledge_base_chat": {
- "userDefault":
- '<指令>Answer the questions based on the information in the provided context by quoting the original words of the provided context.'
- 'If the context does not contain the answers to the questions, say "I do not know the answer".'
- 'Do not make up things. \n'
- '<已知信息>{{ context }}\n'
- '<问题>{{ question }}\n',
-
- "default":
- '<指令>根据已知信息，简洁和专业的来回答问题。如果无法从中得到答案，请说 “根据已知信息无法回答该问题”，'
- ## '不允许在答案中添加编造成分，答案请使用中文。 \n'
- '不允许在答案中添加编造成分，英文问题清使用英文回答，中文问题请使用中文回答。 \n'
- '<已知信息>{{ context }}\n'
- '<问题>{{ question }}\n',
-
- # "text":
- # '<指令>根据已知信息，简洁和专业的来回答问题。如果无法从中得到答案，请说 “根据已知信息无法回答该问题”，答案请使用中文。 \n'
- # '<已知信息>{{ context }}\n'
- # '<问题>{{ question }}\n',
-
- "empty": # 搜不到知识库的时候使用
- '请你回答我的问题:\n'
- '{{ question }}\n\n',
- },
-
-
- "search_engine_chat": {
- "default":
- '<指令>这是我搜索到的互联网信息，请你根据这些信息进行提取并有调理，简洁的回答问题。'
- '如果无法从中得到答案，请说 “无法搜索到能回答问题的内容”。 \n'
- '<已知信息>{{ context }}\n'
- '<问题>{{ question }}\n',
-
- "search":
- '<指令>根据已知信息，简洁和专业的来回答问题。如果无法从中得到答案，请说 “根据已知信息无法回答该问题”，答案请使用中文。 \n'
- '<已知信息>{{ context }}\n'
- '<问题>{{ question }}\n',
- },
-
-
- "agent_chat": {
- "default":
- 'Answer the following questions as best you can. If it is in order, you can use some tools appropriately. '
- 'You have access to the following tools:\n\n'
- '{tools}\n\n'
- 'Use the following format:\n'
- 'Question: the input question you must answer1\n'
- 'Thought: you should always think about what to do and what tools to use.\n'
- 'Action: the action to take, should be one of [{tool_names}]\n'
- 'Action Input: the input to the action\n'
- 'Observation: the result of the action\n'
- '... (this Thought/Action/Action Input/Observation can be repeated zero or more times)\n'
- 'Thought: I now know the final answer\n'
- 'Final Answer: the final answer to the original input question\n'
- 'Begin!\n\n'
- 'history: {history}\n\n'
- 'Question: {input}\n\n'
- 'Thought: {agent_scratchpad}\n',
-
- "ChatGLM3":
- 'You can answer using the tools, or answer directly using your knowledge without using the tools. '
- 'Respond to the human as helpfully and accurately as possible.\n'
- 'You have access to the following tools:\n'
- '{tools}\n'
- 'Use a json blob to specify a tool by providing an action key (tool name) '
- 'and an action_input key (tool input).\n'
- 'Valid "action" values: "Final Answer" or [{tool_names}]'
- 'Provide only ONE action per $JSON_BLOB, as shown:\n\n'
- '```\n'
- '{{{{\n'
- ' "action": $TOOL_NAME,\n'
- ' "action_input": $INPUT\n'
- '}}}}\n'
- '```\n\n'
- 'Follow this format:\n\n'
- 'Question: input question to answer\n'
- 'Thought: consider previous and subsequent steps\n'
- 'Action:\n'
- '```\n'
- '$JSON_BLOB\n'
- '```\n'
- 'Observation: action result\n'
- '... (repeat Thought/Action/Observation N times)\n'
- 'Thought: I know what to respond\n'
- 'Action:\n'
- '```\n'
- '{{{{\n'
- ' "action": "Final Answer",\n'
- ' "action_input": "Final response to human"\n'
- '}}}}\n'
- 'Begin! Reminder to ALWAYS respond with a valid json blob of a single action. Use tools if necessary. '
- 'Respond directly if appropriate. Format is Action:```$JSON_BLOB```then Observation:.\n'
- 'history: {history}\n\n'
- 'Question: {input}\n\n'
- 'Thought: {agent_scratchpad}',
- }
-}
diff --git a/configs/prompt_config.py.example b/configs/prompt_config.py.example
new file mode 100644
index 0000000000..6fb6996c1c
--- /dev/null
+++ b/configs/prompt_config.py.example
@@ -0,0 +1,127 @@
+# prompt模板使用Jinja2语法，简单点就是用双大括号代替f-string的单大括号
+# 本配置文件支持热加载，修改prompt模板后无需重启服务。
+
+# LLM对话支持的变量：
+# - input: 用户输入内容
+
+# 知识库和搜索引擎对话支持的变量：
+# - context: 从检索结果拼接的知识文本
+# - question: 用户提出的问题
+
+# Agent对话支持的变量：
+
+# - tools: 可用的工具列表
+# - tool_names: 可用的工具名称列表
+# - history: 用户和Agent的对话历史
+# - input: 用户输入内容
+# - agent_scratchpad: Agent的思维记录
+
+PROMPT_TEMPLATES = {
+ "llm_chat": {
+ "default":
+ '{{ input }}',
+
+ "with_history":
+ 'The following is a friendly conversation between a human and an AI. '
+ 'The AI is talkative and provides lots of specific details from its context. '
+ 'If the AI does not know the answer to a question, it truthfully says it does not know.\n\n'
+ 'Current conversation:\n'
+ '{history}\n'
+ 'Human: {input}\n'
+ 'AI:',
+
+ "py":
+ '你是一个聪明的代码助手，请你给我写出简单的py代码。 \n'
+ '{{ input }}',
+ },
+
+
+ "knowledge_base_chat": {
+ "default":
+ '<指令>根据已知信息，简洁和专业的来回答问题。如果无法从中得到答案，请说 “根据已知信息无法回答该问题”，'
+ '不允许在答案中添加编造成分，答案请使用中文。 \n'
+ '<已知信息>{{ context }}\n'
+ '<问题>{{ question }}\n',
+
+ "text":
+ '<指令>根据已知信息，简洁和专业的来回答问题。如果无法从中得到答案，请说 “根据已知信息无法回答该问题”，答案请使用中文。 \n'
+ '<已知信息>{{ context }}\n'
+ '<问题>{{ question }}\n',
+
+ "empty": # 搜不到知识库的时候使用
+ '请你回答我的问题:\n'
+ '{{ question }}\n\n',
+ },
+
+
+ "search_engine_chat": {
+ "default":
+ '<指令>这是我搜索到的互联网信息，请你根据这些信息进行提取并有调理，简洁的回答问题。'
+ '如果无法从中得到答案，请说 “无法搜索到能回答问题的内容”。 \n'
+ '<已知信息>{{ context }}\n'
+ '<问题>{{ question }}\n',
+
+ "search":
+ '<指令>根据已知信息，简洁和专业的来回答问题。如果无法从中得到答案，请说 “根据已知信息无法回答该问题”，答案请使用中文。 \n'
+ '<已知信息>{{ context }}\n'
+ '<问题>{{ question }}\n',
+ },
+
+
+ "agent_chat": {
+ "default":
+ 'Answer the following questions as best you can. If it is in order, you can use some tools appropriately. '
+ 'You have access to the following tools:\n\n'
+ '{tools}\n\n'
+ 'Use the following format:\n'
+ 'Question: the input question you must answer1\n'
+ 'Thought: you should always think about what to do and what tools to use.\n'
+ 'Action: the action to take, should be one of [{tool_names}]\n'
+ 'Action Input: the input to the action\n'
+ 'Observation: the result of the action\n'
+ '... (this Thought/Action/Action Input/Observation can be repeated zero or more times)\n'
+ 'Thought: I now know the final answer\n'
+ 'Final Answer: the final answer to the original input question\n'
+ 'Begin!\n\n'
+ 'history: {history}\n\n'
+ 'Question: {input}\n\n'
+ 'Thought: {agent_scratchpad}\n',
+
+ "ChatGLM3":
+ 'You can answer using the tools, or answer directly using your knowledge without using the tools. '
+ 'Respond to the human as helpfully and accurately as possible.\n'
+ 'You have access to the following tools:\n'
+ '{tools}\n'
+ 'Use a json blob to specify a tool by providing an action key (tool name) '
+ 'and an action_input key (tool input).\n'
+ 'Valid "action" values: "Final Answer" or [{tool_names}]'
+ 'Provide only ONE action per $JSON_BLOB, as shown:\n\n'
+ '```\n'
+ '{{{{\n'
+ ' "action": $TOOL_NAME,\n'
+ ' "action_input": $INPUT\n'
+ '}}}}\n'
+ '```\n\n'
+ 'Follow this format:\n\n'
+ 'Question: input question to answer\n'
+ 'Thought: consider previous and subsequent steps\n'
+ 'Action:\n'
+ '```\n'
+ '$JSON_BLOB\n'
+ '```\n'
+ 'Observation: action result\n'
+ '... (repeat Thought/Action/Observation N times)\n'
+ 'Thought: I know what to respond\n'
+ 'Action:\n'
+ '```\n'
+ '{{{{\n'
+ ' "action": "Final Answer",\n'
+ ' "action_input": "Final response to human"\n'
+ '}}}}\n'
+ 'Begin! Reminder to ALWAYS respond with a valid json blob of a single action. Use tools if necessary. '
+ 'Respond directly if appropriate. Format is Action:```$JSON_BLOB```then Observation:.\n'
+ 'history: {history}\n\n'
+ 'Question: {input}\n\n'
+ 'Thought: {agent_scratchpad}',
+ }
+}
diff --git a/configs/server_config.py b/configs/server_config.py.example
similarity index 100%
rename from configs/server_config.py
rename to configs/server_config.py.example
diff --git a/copy_config_example.py b/copy_config_example.py
new file mode 100644
index 0000000000..91f34542de
--- /dev/null
+++ b/copy_config_example.py
@@ -0,0 +1,12 @@
+# 用于批量将configs下的.example文件复制并命名为.py文件
+import os
+import shutil
+
+if __name__ == "__main__":
+ files = os.listdir("configs")
+
+ src_files = [os.path.join("configs", file) for file in files if ".example" in file]
+
+ for src_file in src_files:
+ tar_file = src_file.replace(".example", "")
+ shutil.copy(src_file, tar_file)
diff --git a/docker/Dockerfile b/docker/Dockerfile
deleted file mode 100644
index 057c0abe69..0000000000
--- a/docker/Dockerfile
+++ /dev/null
@@ -1,28 +0,0 @@
-# Base Image
-FROM python:3.11
-# Labels
-LABEL maintainer=chatchat
-# Environment Variables
-ENV HOME=/usr/local/lib/python3.11/site-packages/chatchat
-# Init Environment
-RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && \
- echo "Asia/Shanghai" > /etc/timezone
-# Install Dependencies
-RUN apt-get update -y && \
- apt-get install -y --no-install-recommends libgl1 libglib2.0-0 && \
- apt-get clean && \
- rm -rf /var/lib/apt/lists/*
-RUN pip install openpyxl networkx faiss-cpu jq unstructured[pdf] \
- opencv-python rapidocr-onnxruntime PyMuPDF rank_bm25 youtube_search python-docx
-# Install Chatchat
-RUN pip install --index-url https://pypi.python.org/simple/ langchain-chatchat -U
-# Install ModelProvider
-RUN pip install xinference-client
-# Make Custom Settings
-RUN chatchat-config server --default_bind_host=0.0.0.0 && \
- chatchat-config model --default_llm_model qwen2-instruct
-# Copy Data
-ADD /docker/data.tar.gz $HOME/
-WORKDIR $HOME
-EXPOSE 7861 8501
-ENTRYPOINT ["chatchat", "-a"]
diff --git "a/docker/Image Build \357\274\206 YAML Setup.md" "b/docker/Image Build \357\274\206 YAML Setup.md"
deleted file mode 100644
index e21d08dd55..0000000000
--- "a/docker/Image Build \357\274\206 YAML Setup.md"
+++ /dev/null
@@ -1,29 +0,0 @@
-# 创建代码根目录
-mkdir /home/langchain
-
-## 切换代码根目录
-cd /home/langchain
-
-## 拉取仓库代码
-git clone https://github.com/chatchat-space/Langchain-Chatchat.git .
-
-## 切换Configs文件夹，复制所有的配置档并去除文档后缀.example
-/home/langchain/configs/
-
-## 配置key
-/home/langchain/configs/model_config.py
-
-## 切换代码根目录
-cd /home/langchain
-
-## 制作镜像（自行修改镜像名称与版本号）
-docker build -t {image_name}:{image_tag} .
-
-## 修改YAML里的镜像名称与版本号
-langchain_sample.yaml
-
-## 创建K8S资源
-kubectl apply -f langchain_sample.yaml
-
-## 删除K8S资源
-kubectl delete -f langchain_sample.yaml
diff --git a/docker/data.tar.gz b/docker/data.tar.gz
deleted file mode 100644
index c6a7fe4f29..0000000000
Binary files a/docker/data.tar.gz and /dev/null differ
diff --git a/docker/docker-compose.yaml b/docker/docker-compose.yaml
deleted file mode 100644
index 95d341eeb1..0000000000
--- a/docker/docker-compose.yaml
+++ /dev/null
@@ -1,36 +0,0 @@
-version: '3.9'
-services:
- xinference:
- image: xprobe/xinference:v0.12.1
- restart: always
- command: xinference-local -H 0.0.0.0
- # ports: # 不使用 host network 时可打开.
- # - "9997:9997"
- network_mode: "host"
- # 将本地路径(~/xinference)挂载到容器路径(/root/.xinference)中,
- # 详情见: https://inference.readthedocs.io/zh-cn/latest/getting_started/using_docker_image.html
- volumes:
- - ~/xinference:/root/.xinference
- # - ~/xinference/cache/huggingface:/root/.cache/huggingface
- # - ~/xinference/cache/modelscope:/root/.cache/modelscope
- deploy:
- resources:
- reservations:
- devices:
- - driver: nvidia
- count: all
- capabilities: [gpu]
- runtime: nvidia
- # 模型源更改为 ModelScope, 默认为 HuggingFace
- # environment:
- # - XINFERENCE_MODEL_SRC=modelscope
- chatchat:
- image: chatimage/chatchat:0.3.0-2024-0624
- restart: always
- # ports: # 不使用 host network 时可打开.
- # - "7861:7861"
- # - "8501:8501"
- network_mode: "host"
- # 将本地路径(~/chatchat/data)挂载到容器默认数据路径(/usr/local/lib/python3.11/site-packages/chatchat/data)中
- # volumes:
- # - ~/chatchat/data:/usr/local/lib/python3.11/site-packages/chatchat/data
diff --git a/docker/langchain_sample.yaml b/docker/langchain_sample.yaml
deleted file mode 100644
index 7d543cd5b9..0000000000
--- a/docker/langchain_sample.yaml
+++ /dev/null
@@ -1,91 +0,0 @@
-apiVersion: v1
-kind: PersistentVolume
-metadata:
- name: langchain-pv
-spec:
- capacity:
- storage: 10Gi
- accessModes:
- - ReadWriteMany
- persistentVolumeReclaimPolicy: Retain
- storageClassName: standard
- local:
- path: /home/langchain #填入代码所在的目录
- nodeAffinity:
- required:
- nodeSelectorTerms:
- - matchExpressions:
- - key: kubernetes.io/hostname
- operator: In
- values:
- - instance-1
----
-apiVersion: v1
-kind: PersistentVolumeClaim
-metadata:
- name: langchain-pvc
-spec:
- accessModes:
- - ReadWriteMany
- storageClassName: standard
- resources:
- requests:
- storage: 10Gi
- volumeName: langchain-pv
----
-apiVersion: apps/v1
-kind: Deployment
-metadata:
- name: langchain
-spec:
- replicas: 1
- selector:
- matchLabels:
- app: langchain
- template:
- metadata:
- labels:
- app: langchain
- spec:
- securityContext:
- fsGroup: 101
- containers:
- - name: langchain
- image:{image_name}:{image_tag} #填入镜像名称与版本号
- command: ["python"]
- args: ["startup.py","-a"] #启动命令
- ports:
- - containerPort: 8501
- - containerPort: 7861
- - containerPort: 20000
- volumeMounts:
- - name: langchain-vol
- mountPath: /Langchain-Chatchat
- nodeSelector:
- kubernetes.io/hostname: instance-1
- volumes:
- - name: langchain-vol
- persistentVolumeClaim:
- claimName: langchain-pvc
----
-apiVersion: v1
-kind: Service
-metadata:
- name: langchain-service
-spec:
- selector:
- app: langchain
- type: NodePort
- ports:
- - name: webui
- port: 8501
- targetPort: 8501
- nodePort: 8501
- - name: api
- port: 7861
- targetPort: 7861
- nodePort: 7861
- - name: fastchat
- port: 20000
- targetPort: 20000
- nodePort: 20000
\ No newline at end of file
diff --git "a/docs/ES\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/ES\351\203\250\347\275\262\346\214\207\345\215\227.md"
new file mode 100644
index 0000000000..f461582675
--- /dev/null
+++ "b/docs/ES\351\203\250\347\275\262\346\214\207\345\215\227.md"
@@ -0,0 +1,29 @@
+
+# 实现基于ES的数据插入、检索、删除、更新
+```shell
+author: 唐国梁Tommy
+e-mail: flytang186@qq.com
+
+如果遇到任何问题，可以与我联系，我这边部署后服务是没有问题的。
+```
+
+## 第1步：ES docker部署
+```shell
+docker network create elastic
+docker run -id --name elasticsearch --net elastic -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -e "xpack.security.enabled=false" -e "xpack.security.http.ssl.enabled=false" -t docker.elastic.co/elasticsearch/elasticsearch:8.8.2
+```
+
+### 第2步：Kibana docker部署
+**注意：Kibana版本与ES保持一致**
+```shell
+docker pull docker.elastic.co/kibana/kibana:{version}
+docker run --name kibana --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{version}
+```
+
+### 第3步：核心代码
+```shell
+1. 核心代码路径
+server/knowledge_base/kb_service/es_kb_service.py
+
+2. 需要在 configs/model_config.py 中 配置 ES参数（IP， PORT）等；
+```
\ No newline at end of file
diff --git a/docs/contributing/README.md b/docs/contributing/README.md
deleted file mode 100644
index a8e9b969ff..0000000000
--- a/docs/contributing/README.md
+++ /dev/null
@@ -1,34 +0,0 @@
-### 贡献指南
-
-各位开发者，chatchat由个人组织经过了不断地迭代和完善，作为一个不断进化的项目，
-我们欢迎您的参与，无论是提交bug报告、功能请求、代码贡献、文档编写、测试、或者其他形式的贡献。
-
-#### 贡献方式
-
-这里列出了一些您可以为chatchat做出贡献的方式:
-
-- [Code](code.md): 帮助我们编写代码，修复bug，或者改进基础设施。
-- Documentation: 帮助我们编写文档，使chatchat更容易使用。
-- Discussions: 帮助回答用户的使用问题，讨论问题。
- 当您的贡献被接受后，我们会将您的名字添加到贡献者列表中。
- 在功能贡献达到2次以上，我们会考虑将您加入到chatchat的开发团队中。
-
-#### Github Issue
-
-我们需要跟踪功能请求与bug报告
-
-目前我们有使用Issue默认模板来让用户更好的描述问题，但是目前这个大部分issue的用户可能依然选择只回复一句话，
-
-对于这样的情况我们需要告知用户如何更好的描述问题。在15天内没有回复的issue我们会关闭issue。
-
-关于功能请求，备受关注的RAG话题我们会考虑加入到我们的开发计划中。
-
-我们努力保持issue的更新，但是我们也需要您的帮助，如果您发现有问题没有得到及时回复，请在issue下@我们。
-
-#### 寻求帮助
-
-我们尽量使开发者更容易上手，当您遇到问题时，请联系维护人员，我们会尽力帮助您。
-
-类似的 diff、formatting、linting、testing等问题，如果您不确定如何解决，请随时联系我们，
-很多时候规则校验会阻碍一些开发者，您的思路如果足够优秀，我们会考虑调整规则。
-
diff --git a/docs/contributing/README_dev.md b/docs/contributing/README_dev.md
deleted file mode 100644
index e60e4e1987..0000000000
--- a/docs/contributing/README_dev.md
+++ /dev/null
@@ -1,51 +0,0 @@
-#### 源码启动chatchat-server
-
-- 安装chatchat
-
-```shell
-git clone https://github.com/chatchat-space/Langchain-Chatchat.git
-```
-
-- 初始化开发环境
-
-> [Code](code.md): 源码配置可以帮助我们更快的寻找bug，或者改进基础设施。
-
-- 关于chatchat-config
-
-> chatchat-config由ConfigWorkSpace接口提供知识库配置载入存储
->
-> 具体实现可以参考basic_config.py
->
-
-- ConfigWorkSpace接口说明
-
-```text
-ConfigWorkSpace是一个配置工作空间的抽象类，提供基础的配置信息存储和读取功能。
-提供ConfigFactory建造方法产生实例。
-该类的实例对象用于存储工作空间的配置信息，如工作空间的路径等
-工作空间的配置信息存储在用户的家目录下的.chatchat/workspace/workspace_config.json文件中。
-注意：不存在则读取默认
-```
-
-- 初始化仓库(使用默认 embedding 模型)
-
-> 请注意：这个命令会清空数据库，如果您有重要数据，请备份
-
-```shell
-cd Langchain-Chatchat/libs/chatchat-server/chatchat
-python init_database.py --recreate-vs
-```
-
-- 初始化仓库(指定 embedding 模型)
-
-```shell
-cd Langchain-Chatchat/libs/chatchat-server/chatchat
-python init_database.py --recreate-vs --embed-model=text-embedding-3-small # embedding 模型名称
-```
-
-- 启动服务
-
-```shell
-cd Langchain-Chatchat/libs/chatchat-server/chatchat
-python startup.py -a
-```
diff --git a/docs/contributing/code.md b/docs/contributing/code.md
deleted file mode 100644
index b6c8f8a319..0000000000
--- a/docs/contributing/code.md
+++ /dev/null
@@ -1,60 +0,0 @@
-
-### 代码贡献
-贡献此仓库的代码时，请查阅 ["fork and pull request"](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) 流程，除非您是项目的维护者。请不要直接提交到主分支。
-在提交PR之前，请检查按照pull request模板的指导进行操作。注意，我们的CI系统会自动运行linting和测试，以确保您的代码符合我们的标准。
-更重要的是，我们需要保持良好的单元测试和文档，如果你做了如下操作：
-- 添加新功能
-更新受影响的操作文档
-- 修复bug
-尽可能添加一个单元测试，在tests/integration_tests或tests/unit_tests中
-
-
-#### 依赖管理：Poetry与env/dependency管理方法
-这个项目使用 Poetry 来管理依赖。
-> 注意：在安装Poetry之前，如果您使用Conda，请创建并激活一个新的Conda env（例如，`conda create -n chatchat python=3.9`）
-
-Install Poetry: [documentation on how to install it.](https://python-poetry.org/docs/#installing-with-pipx)
-
-> 友情提示 不想安装pipx可以用pip安装poetry，（Tips:如果你没有其它poetry的项目
-> 注意: 如果您使用 Conda 或 Pyenv 作为您的环境/包管理器，在安装Poetry之后，
-> 使用如下命令使 Poetry 使用 virtualenv python environment (`poetry config virtualenvs.prefer-active-python true`)
-
-
-#### 本地开发环境安装
-
-- 选择主项目目录
-```shell
-cd Langchain-Chatchat/libs/chatchat-server/
-```
-
-- 安装chatchat依赖(for running chatchat lint\tests):
-
-```shell
-poetry install --with lint,test
-```
-> Poetry install后会在你的site-packages安装一个chatchat-`|
- - |
- |
|---|---|
- 
- |
-
- 
- |
-
- 
- |
- |
- 
| 
| 
|
-
-- 将此 API Key 填写到 LobeChat 的 API Key 配置中，即可开始使用。
-
-> \[!TIP]
->
-> 账户注册后，一般有 5 美元的免费额度，但有效期只有三个月。
-> 如果你希望长期使用你的 API Key，你需要完成支付的信用卡绑定。由于 OpenAI 只支持外币信用卡，因此你需要找到合适的支付渠道，此处不再详细展开。
-
-
| **AiHubMix** | 使用 OpenAI 企业接口，全站模型价格为官方 **6 折**（含 GPT-4 ） | `https://aihubmix.com/v1` | [获取](https://lobe.li/XHnZIUP) |
-
-> \[!WARNING]
->
-> **免责申明**: 在此推荐的 OpenAI API Key 由第三方代理商提供，所以我们不对 API Key 的 **有效性** 和 **安全性** 负责，请你自行承担购买和使用 API Key 的风险。
-
-> \[!NOTE]
->
-> 如果你是模型服务商，并认为自己的服务足够稳定且价格实惠，欢迎联系我们，我们会在自行体验和测试后酌情推荐。
-
-|
- - |
- |
|---|---|
|
-
- |
-
-
- |
-
|
-
- |
- |
- 
-
-
-
-