LangChain-Chatchat 本地知识库部署与避坑指南

LangChain-Chatchat

概述

LangChain-Chatchat 是一个基于 ChatGLM 大语言模型与 Langchain 应用框架实现的开源、可离线部署的检索增强生成 (RAG) 大模型的本地知识库问答应用项目。

GitHub：https://github.com/chatchat-space/Langchain-Chatchat

实现原理

本项目实现原理过程包括加载文件 -> 读取文本 -> 文本分割 -> 文本向量化 -> 问句向量化 -> 在文本向量中匹配出与问句向量最相似的 top k 个 -> 匹配出的文本作为上下文和问题一起添加到 prompt 中 -> 提交给 LLM 生成回答。

开发环境准备

软件要求

使用 Ubuntu 系统，其他系统可能出现系统兼容性问题。

Linux Ubuntu 22.04.5 kernel version 6.7

最低要求

该要求仅针对标准模式，轻量模式使用在线模型，不需要安装 torch 等库，也不需要显卡即可运行。

Python 版本：>= 3.8(很不稳定), < 3.11
CUDA 版本：>= 12.1

推荐要求

开发者在以下环境下进行代码调试，在该环境下能够避免最多环境问题。

Python 版本 == 3.10.12
CUDA 版本：== 12.3

硬件要求

如果为了体验使用该项目，可以使用线上模型，不需要太高的硬件要求。

如果想要顺利在 GPU 运行本地模型的 int4 量化版本，至少需要以下的硬件配置。

ChatGLM2-6B & LLaMA-7B

最低显存要求：7GB
推荐显卡：RTX 3060, RTX 2060

LLaMA-13B

最低显存要求：11GB
推荐显卡：RTX 2060 12GB, RTX 3060 12GB, RTX 3080, RTX A2000

Qwen-14B-Chat

最低显存要求：13GB
推荐显卡：RTX 3090

LLaMA-30B

最低显存要求：22GB
推荐显卡：RTX A5000, RTX 3090, RTX 4090, RTX 6000, Tesla V100, RTX Tesla P40

LLaMA-65B

最低显存要求：40GB
推荐显卡：A100, A40, A6000

注意：

若使用 int8 推理，则显存大致为 int4 推理要求的 1.5 倍
若使用 fp16 推理，则显存大致为 int4 推理要求的 2.5 倍
数据仅为估算，实际情况以 nvidia-smi 占用为准。
同时，Embedding 模型将会占用 1-2G 的显存，历史记录最多会占用数 G 显存，因此，需要多冗余一些显存。
内存最低要求：内存要求至少应该比模型运行的显存大。

部署

拉取仓库

git clone https://github.com/chatchat-space/Langchain-Chatchat.git

# 进入目录
cd Langchain-Chatchat

创建虚拟环境

创建一个虚拟环境，使项目与项目间进行软件版本隔离。

conda create -n chat python=3.10

# 激活使用虚拟环境
conda activate chat

安装全部依赖

在虚拟环境内安装项目的依赖。

pip install -r requirements.txt 
pip install -r requirements_api.txt
pip install -r requirements_webui.txt

默认依赖包括基本运行环境（FAISS 向量库）。如果要使用 milvus/pg_vector 等向量库，请将 requirements.txt 中相应依赖取消注释再安装。

初始化配置文件

python copy_config_example.py

脚本将会将所有 config 目录下的配置文件样例复制一份到 config 目录下，方便开发者进行配置。接着，开发者可以根据自己的需求，对配置文件进行修改。

basic_config.py：基础配置项：配置记录日志的格式和储存路径，通常不需要修改。
kb_config.py：数据库配置：配置分词器、知识库、向量数据库等信息
model_config.py：模型配置项：包含本地 LLM 模型、本地 Embeddings 模型、在线 LLM 模型 API 的相关配置
prompt_config.py：提示词配置项：提示词配置分为三个板块，分别对应三种聊天类型：基础的对话提示词、与知识库对话的提示词、与 Agent 对话的提示词。
server_config.py：服务和端口配置项：不需要进行大量的修改，仅需确保对应的端口打开，并不互相冲突即可。server_config.py 中的配置优先于 startup.py 中的默认值，注意避免配置文件覆盖

模型下载

模型下载取决于自己的网络情况，这里需要提前下载 THUDM/chatglm2-6b 与 BAAI/bge-large-zh 到本地，然后在 model_config.py 中配置。

若网络良好 (全球畅通无阻) 则完全不需要先下载模型，在执行过程中会自动下载相关模型。

如果网络存在问题，则可以事先下载好需要的模型，然后在 model_config.py 文件中配置，具体配置参考异常 3 中的处理办法

注意：

Windows 环境下，会默认自动将该模型下载到 C:\Users\Admin\.cache\torch\sentence_transformers 目录下，若下载失败，参考异常 3 中的处理办法

初始化知识库

第一次运行本项目，知识库尚未建立，或者配置文件中的知识库类型、嵌入模型发生变化，需要以下命令初始化或重建知识库：

python init_database.py --recreate-vs

如果已经有创建过知识库，可以先执行以下命令创建或更新数据库表：

$ python init_database.py --create-tables

第一次使用时，会自动下载 BAAI/bge-large-zh 模型，用于知识库的初始化构建。

(Log output truncated for brevity)

启动项目

启动项目整个过程中，坑也比较多，参考异常 2 与异常 3 中的处理办法。

一键启动脚本 startup.py，一键启动所有 Fastchat 服务、API 服务、WebUI 服务。

python startup.py -a

启动时，如果没用在 model_config.py 中配置配置模型信息，则会自动模型下载 THUDM/chatglm3-6b 到本地使用。

服务端运行信息： OpenAI API Server: http://127.0.0.1:20000/v1 Chatchat API Server: http://127.0.0.1:7861 Chatchat WEBUI Server: http://0.0.0.0:8501

访问 Web UI

Web UI 地址：http://127.0.0.1:8501

API 服务

不是一键启动，则可以单独启动 API 服务：

python server/api.py

访问：http://0.0.0.0:7861/docs

Web UI 服务

不是一键启动，则可以单独启动 Web UI 服务：

streamlit run webui.py

访问：http://localhost:8501/

使用

对话功能

可以选择本地模型，线上模型，然后进行对话。

知识库管理

可以新建知识库，上传相关资料信息。

上传后会建立向量数据库。

进行提问，回答基于知识库进行回答。

文件对话

上传一个报销制度文件，然后提问。

搜索引擎问答

异常集合

异常 1

场景：

初始化配置文件

python init_database.py --recreate-vs

问题：

 cannot import name 'Doc' from 'typing_extensions'

解决：

因为安装的 typing_extensions 版本不正确，需要重新安装。

pip install typing_extensions==4.8.0

异常 2

场景：

启动项目

python startup.py -a

问题：

OMP: Error #15: Initializing libiomp5md.dll, but found libiomp5md.dll already initialized.
OMP: Hint This means that multiple copies of the OpenMP runtime have been linked into the program. That is dangerous, since it can degrade performance or cause incorrect results. The best thing to do is to ensure that only a single OpenMP runtime is linked into the process, e.g. by avoiding static linking of the OpenMP runtime in any library. As an unsafe, unsupported, undocumented workaround you can set the environment variable KMP_DUPLICATE_LIB_OK=TRUE to allow the program to continue to execute, but that may cause crashes or silently produce incorrect results. For more information, please see http://www.intel.com/software/products/support/.

解决 1：

这里使用 Anaconda 创建虚拟环境，其中有 ibiomp5md.dll 文件，重命名以备份该文件，如：libiomp5md.dll.back

解决 2：

在 startup.py 文件上方设置环境变量，保证前后顺序。

import os
os.environ['KMP_DUPLICATE_LIB_OK']='True'

异常 3

场景：

启动项目过程中

python startup.py -a

问题：

| OSError: We couldn't connect to 'https://huggingface.co' to load this file, couldn't find it in the cached files and it looks like THUDM/chatglm3-6b is not the path to a directory containing a file named config.json.

解决：

默认使用的 LLM 模型 THUDM/ChatGLM3-6B 与 Embedding 模型 BAAI/bge-large-zh，会远程连接模型网站。这里使用魔法也不得行，不知为啥，具体模型网站能访问的。

下载 LLM 模型 THUDM/ChatGLM3-6B 与 Embedding 模型 BAAI/bge-large-zh。

访问 https://huggingface.co/BAAI/bge-large-zh 下载
访问 https://huggingface.co/THUDM/chatglm3-6b 下载

然后修改 configs/model_config.py 文件，指定模型存放位置与使用模型名称，需保证存放模型目录下的模型文件名与 model_config.py 文件使用的名称一致。

# 统一存放模型位置
MODEL_ROOT_PATH = "../../../models"

# 选用的 Embedding 名称
EMBEDDING_MODEL = "bge-large-zh"

# 要运行的 LLM 名称，可以包括本地模型和在线模型
LLM_MODELS = ["chatglm3-6b", "zhipu-api", "openai-api"]

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",
         # 如果模型目录名称和 MODEL_PATH 中的 key 或 value 相同，程序会自动检测加载，无需修改 MODEL_PATH 中的路径。
        "bge-large-zh": "bge-large-zh",
        "bge-large-zh-noinstruct": "BAAI/bge-large-zh-noinstruct",
        "bge-base-zh-v1.5": ,
        : ,
        : ,
        : ,
        : ,
        : ,
    },

    : {
        
        
        
        : ,
        : ,

        : ,
        : ,
        : ,
    },

}

LangChain-Chatchat 本地知识库部署与避坑指南