9.2 KiB
🌍 READ THIS IN ENGLISH 🌍 日本語で読む
📃 LangChain-Chatchat (原 Langchain-ChatGLM)
基于 ChatGLM 等大语言模型与 Langchain 等应用框架实现，开源、可离线部署的 RAG 与 Agent 应用项目。
目录
介绍
🤖️ 一种利用 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生成回答。
📺 原理介绍视频
从文档处理角度来看，实现流程如下：
🚩 本项目未涉及微调、训练过程，但可利用微调或训练对本项目效果进行优化。
🌐 AutoDL 镜像 中 0.2.10
版本所使用代码已更新至本项目 v0.2.10 版本。
🐳 Docker 镜像 已经更新到 0.2.7 版本。
🌲 一行命令运行 Docker ：
docker run -d --gpus all -p 80:8501 registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.7
🧩 本项目有一个非常完整的 Wiki ， README只是一个简单的介绍，_ 仅仅是入门教程，能够基础运行_。 如果你想要更深入的了解本项目，或者想对本项目做出贡献。请移步 Wiki 界面
Langchain-Chatchat 提供哪些功能
已支持的模型部署框架与模型
通过一套llm加载器支持模型加载，支持异构部署，有图形操作界面，支持tcp、http形式的客户端，部署方面有很多兼容问题、缺少运维文档 项目架构集成了各种语言（C++，Golang，Python等）通过编写一套GRPC实现不同模型加速服务接入、支持模型特殊token的提示模板配置。 支持目前多种模型推理形式、多端编译支持、 有丰富的调度api，运维层面有一套基于docker构建的系统手册、有windows、linux、mac系统部署手册，项目编译复杂、操作流程繁琐 仅支持本地大型语言模型终端工具。有着完整的社区支持，包括但不限langchain、Transformers、llama-index、idea,在RAG方面提供很多的解决方案、有技术博客提供复现细节,提供多端一键运行脚本、侧重于命令终端管理模型 提供模型服务适配转发功能、支持多端部署、模型服务调度、图形操作界面、计费策略支持,平台推广等toC业务 支持 支持 部分支持 支持 GPT, embeddings、Functions、Image generation 、Audio generation GPT, embeddings、V-GPT,Functions、Audio generation and Voice cloning、Image generation 、Audio generation GPT, Functions,V-GPT,Image generation https://inference.readthedocs.io/zh-cn/latest/models/builtin/index.html https://localai.io/model-compatibility/ https://github.com/ollama/ollama?tab=readme-ov-file#model-library GPTQ、GGML、vllm、TensorRT GPTQ、GGML、vllm、TensorRT GGUF、GGML 支持 支持 不支持 支持 支持 不支持 python、c go、c go、c、shell
| 模型部署框架 | xinference | ollama | oneapi | localAI |
|---|---|---|---|---|
我们支持市面上主流的本地大语言模型和Embedding模型，支持开源的本地向量数据库。 支持列表详见 Wiki
快速上手
旧版本迁移
1. 环境配置
- 首先，确保你的机器安装了 Python 3.8 - 3.11 。
$ python --version
Python 3.11.7
接着，创建一个虚拟环境，并在虚拟环境内安装项目的依赖
# 拉取仓库
$ 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-Chatchat 0.3.x 当前版本是针对 Langchain 0.1.x 系列版本的，如果你使用的是 Langchain 0.2.x
版本，需要降级您的 Langchain 版本。
2. 模型启动
如需在本地或离线环境下运行本项目，需要首先将项目所需的模型下载至本地，通常开源 LLM 与 Embedding 模型可以从 HuggingFace 下载。
以本项目中默认使用的 LLM 模型 THUDM/ChatGLM3-6B 与 Embedding 模型 BAAI/bge-large-zh 为例：
下载模型需要先安装 Git LFS ，然后运行
$ git lfs install
$ git clone https://huggingface.co/THUDM/chatglm3-6b
$ git clone https://huggingface.co/BAAI/bge-large-zh
3. 初始化知识库和配置文件
按照下列方式初始化自己的知识库和简单的复制配置文件
$ python copy_config_example.py
$ python init_database.py --recreate-vs
4. 项目一键启动
按照以下命令启动项目
$ python startup.py -a
5. 启动界面示例
如果正常启动，你将能看到以下界面
- FastAPI Docs 界面
- Web UI 启动界面示例：
- Web UI 对话界面：
- Web UI 知识库管理页面：
注意
以上方式只是为了快速上手，如果需要更多的功能和自定义启动方式，请参考Wiki
项目里程碑
-
2023年4月:Langchain-ChatGLM 0.1.0发布，支持基于 ChatGLM-6B 模型的本地知识库问答。 -
2023年8月:Langchain-ChatGLM改名为Langchain-Chatchat，发布0.2.0版本，使用fastchat作为模型加载方案，支持更多的模型和数据库。 -
2023年10月:Langchain-Chatchat 0.2.5发布，推出 Agent 内容，开源项目在Founder Park & Zhipu AI & Zilliz举办的黑客马拉松获得三等奖。 -
2023年12月:Langchain-Chatchat开源项目获得超过 20K stars. -
2024年6月:Langchain-Chatchat 0.3.0发布，带来全新项目架构。 -
🔥 让我们一起期待未来 Chatchat 的故事 ···
联系我们
Telegram
项目交流群
🎉 Langchain-Chatchat 项目微信交流群，如果你也对本项目感兴趣，欢迎加入群聊参与讨论交流。
公众号
🎉 Langchain-Chatchat 项目官方公众号，欢迎扫码关注。