适配 Sophon BM1684X,集成 FastChat 框架
原始仓库为Langchain-Chatchat
注: 本仓库中通过.gitmodules中的源码来安装适配TPU的 FastChat-TPU,已删除requirements.txt中的公版fastchat
🤖️ 一种利用 langchain **实现的基于本地知识库的问答应用,目标期望建立一套对中文场景与开源模型支持友好、可离线运行的知识库问答解决方案。
💡 受 GanymedeNil 的项目 document.ai 和 AlexZhangji 创建的 ChatGLM-6B Pull Request 启发,建立了全流程可使用开源模型实现的本地知识库问答应用。本项目的最新版本中通过使用 FastChat 接入 Vicuna, Alpaca, LLaMA, Koala, RWKV 等模型,依托于 langchain 框架支持通过基于 FastAPI 提供的 API 调用服务,或使用基于 Streamlit 的 WebUI 进行操作。
✅ 依托于本项目支持的开源 LLM 与 Embedding 模型,本项目可实现全部使用开源模型离线私有部署。与此同时,本项目也支持 OpenAI GPT API 的调用,并将在后续持续扩充对各类模型及模型 API 的接入。
⛓️ 本项目实现原理如下图所示,过程包括加载文件 -> 读取文本 -> 文本分割 -> 文本向量化 -> 问句向量化 ->
在文本向量中匹配出与问句向量最相似的 top k
个 -> 匹配出的文本作为上下文和问题一起添加到 prompt
中 -> 提交给 LLM
生成回答。
📺 原理介绍视频
从文档处理角度来看,实现流程如下:
🧩 本项目有一个非常完整的Wiki , README只是一个简单的介绍,_ 仅仅是入门教程,能够基础运行_。 如果你想要更深入的了解本项目,或者想对本项目做出贡献。请移步 Wiki 界面
该项目是一个可以实现 __完全本地化__推理的知识库增强方案, 重点解决数据安全保护,私域化部署的企业痛点。
本开源方案采用Apache License
,可以免费商用,无需付费。
我们支持市面上主流的本地大语言模型和Embedding模型,支持开源的本地向量数据库。 支持列表详见Wiki
- 首先,确保你的机器安装了 Python 3.8 - 3.11 (我们强烈推荐使用 Python3.11)。
$ python --version
Python 3.10.14
接着,创建一个虚拟环境,并在虚拟环境内安装项目的依赖
# 进入目录
$ cd LangChain-Chatchat-TPU
# 安装tpu版本的FastChat
$ git submodule update --init --recursive
$ cd FastChat-TPU
$ pip install --upgrade pip # enable PEP 660 support
$ pip install -e ".[model_worker]"
$ cd ..
# 安装全部依赖
$ pip install -r requirements.txt
$ pip install -r requirements_api.txt
$ pip install -r requirements_webui.txt
# 默认依赖包括基本运行环境(FAISS向量库)。如果要使用 milvus/pg_vector 等向量库,请将 requirements.txt 中相应依赖取消注释再安装。
# 如果需要在边缘设备启动服务,需要注释掉 requirements.txt 中的 vllm 依赖,且至少保留 2G 设备内存
请注意,LangChain-Chatchat 0.2.x
系列是针对 Langchain 0.0.x
系列版本的,如果你使用的是 Langchain 0.1.x
系列版本,需要降级您的Langchain
版本。
需要安装新版本 SAIL,参考Sail_Install_Guide
本项目中默认使用的 LLM 模型 THUDM/ChatGLM3-6B 与 Embedding 模型 shibing624/text2vec-bge-large-chinese:
# 在工程主目录下
$ pip install dfss -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade
$ python -m dfss [email protected]:ezoo/chatdoc/bmodel.tar.gz
$ tar -zxvf bmodel.tar.gz
下载的文件包括
bmodel
├── chatglm3-6b
│ ├── chatglm3-6b_int4_1dev_2k.bmodel
│ ├── tokenization_chatglm.py
│ ├── tokenizer_config.json
│ └── tokenizer.model
├── codefuse-devops-model-7b-chat
│ ├── codefuse-7b_int4_1dev_2k.bmodel
│ ├── qwen.tiktoken
│ ├── tokenization_qwen.py
│ └── tokenizer_config.json
├── qwen-7b-chat
│ ├── qwen-7b_int4_1dev_2k.bmodel
│ ├── qwen.tiktoken
│ ├── tokenization_qwen.py
│ └── tokenizer_config.json
└── text2vec-bge-large-chinese
├── bge_large_512_fp16_1b.bmodel
├── special_tokens_map.json
├── tokenizer_config.json
└── vocab.txt
按照下列方式初始化自己的知识库和简单的复制配置文件
$ python copy_config_example.py
$ python init_database.py --recreate-vs
按照以下命令启动项目
$ python startup.py -a
- 不同环境下根据配置文件和终端日志查看
- 启动的web界面默认在 http://{host-ip}:8501/
- 启动的api文档默认在 http://{host-ip}:7861/docs
如果正常启动,你将能看到以下界面
- FastAPI Docs 界面
- Web UI 启动界面示例:
- Web UI 对话界面:
- Web UI 知识库管理页面: