Skip to content

Latest commit

 

History

History
112 lines (81 loc) · 3.77 KB

README_dev_install.md

File metadata and controls

112 lines (81 loc) · 3.77 KB
Raw

LangGraph-Chatchat 源代码部署/开发部署指南

Important

开始源码部署前, 请先阅读容器化部署文档 README_docker_install 来简单了解各配置文件的主要作用以及前端使用.

Warning

为避免依赖冲突, 请将 LangGraph-Chatchat 和模型部署框架如 Xinference 等放在不同的 Python 虚拟环境中, 比如 conda, venv, virtualenv 等.

0. 拉取项目代码

如果您是想要使用源码启动的用户，请直接拉取 master 分支代码

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

1. 初始化开发环境

LangGraph-Chatchat 使用 Poetry 进行环境管理。

1.1 创建虚拟环境(推荐使用 python=3.12)

conda create -n chatchat python=3.12

1.2 安装 Poetry

pip install poetry

如果有问题, 请查看文档: Poetry 安装文档

1.3 安装源代码/开发部署所需依赖库

进入主项目目录，并安装 LangGraph-Chatchat 依赖

cd LangGraph-Chatchat/chatchat-server
poetry install --with lint,test -E xinference
pip install -e .
# 如果要用 text2sql 的 graph, 需要安装 `mysqlclient` 此其他虚拟环境请按照各自支持的方式下载 mysqlclient
#conda install mysqlclient

Note

Poetry install 后会在你的虚拟环境中 site-packages 路径下生成一个 chatchat-<version>.dist-info 文件夹带有 direct_url.json 文件，这个文件指向你的开发环境

1.4 更新开发部署环境依赖库

当开发环境中所需的依赖库发生变化时，一般按照更新主项目目录(LangGraph-Chatchat/chatchat-server/)下的 pyproject.toml 再进行 poetry update 的顺序执行。

2. 设置源代码根目录

2.1 如果您在开发时所使用的 IDE 需要指定项目源代码根目录，请将主项目目录(LangGraph-Chatchat/chatchat-server/)设置为源代码根目录。

2.2 执行下面命令之前，请先创建数据目录(存知识库数据和配置文件), 例如: /path/to/chatchat_data, 然后执行下面命令配置环境变量.

# linux 或 macos
export CHATCHAT_ROOT=/path/to/chatchat_data
# windows
set CHATCHAT_ROOT=/path/to/chatchat_data

3. 初始化知识库和配置文件

配置项均为 yaml 文件，具体作用参考 README_docker_install。

Warning

这个命令会清空数据库、删除已有的配置文件，如果您有重要数据，请备份。

执行以下命令初始化项目配置文件和数据目录：

cd LangGraph-Chatchat/chatchat-server
python chatchat/cli.py init

4. 初始化 samples 知识库(老用户可跳过)

cd LangGraph-Chatchat/chatchat-server
python chatchat/cli.py kb --recreate-vs

如需使用其它 Embedding 模型，或者重建特定的知识库，请查看 python chatchat/cli.py kb --help 了解更多的参数。

Warning

进行知识库初始化前，请确保已经启动模型推理框架及对应 embedding 模型, 且已完成模型接入配置.

出现以下日志即为成功:


----------------------------------------------------------------------------------------------------
知识库名称      ：samples
知识库类型      ：faiss
向量模型：      ：bge-large-zh-v1.5
知识库路径      ：/Users/chatchat/Desktop/chatchat_data/data/knowledge_base/samples
文件总数量      ：12
入库文件数      ：12
知识条目数      ：755
用时            ：0:00:40.071413
----------------------------------------------------------------------------------------------------

总计用时        ：0:00:40.074613

5. 启动服务

cd LangGraph-Chatchat/chatchat-server
python chatchat/cli.py start -a