Langchain-Chatchat

环境要求

• Python 环境（以 Python 库形式安装运行）
• 需自行启动模型部署框架：Xinference / LocalAI / Ollama / FastChat，或通过 One API 接入在线 API
• pip 安装时建议使用官方 Pypi 源或清华源，以保证库为最新版
• Docker 部署需已安装 Docker，官方强烈建议配合 docker-compose 使用

安装与启动步骤

1. 1安装主程序

   以 Python 库形式安装 Langchain-Chatchat，0.3.0 起支持该安装方式，建议使用官方 Pypi 源或清华源。

   pip install langchain-chatchat -U

   复制

2. 2（可选）装 Xinference 依赖

   若要搭配 Xinference 模型部署框架使用，需额外安装对应 Python 依赖库，用带 extra 的方式安装。

   pip install "langchain-chatchat[xinference]" -U

   复制

3. 3初始化配置与数据目录

   0.3.1 起使用本地 yaml 文件配置，可设置存放配置文件和数据文件的根目录（可选），服务器会自动更新无需重启。

4. 4启动服务

   执行启动命令拉起服务，README 给出出现对应界面即为启动成功；启动前请确认模型部署框架已就绪。

   chatchat start -a

   复制

5. 5（可选）开放远程访问

   默认监听地址为 127.0.0.1，无法用其他 IP 访问；如需通过机器 IP 访问（如 Linux），修改监听地址为 0.0.0.0。

6. 6（可选）Docker 拉取镜像

   使用 Docker 时拉取官方镜像，国内网络可用腾讯云镜像；强烈建议改用 docker-compose 部署。

   docker pull chatimage/chatchat:0.3.1.3-93e2c87-20240829
   docker pull ccr.ccs.tencentyun.com/langchain-chatchat/chatchat:0.3.1.3-93e2c87-20240829

   复制

7. 7（可选）配置本地模型路径

   Xinference 内置模型会自动下载，若想加载本机已下载模型，启动 Xinference 后到 tools/model_loaders 执行该脚本按提示设置。

   streamlit run xinference_manager.py

   复制

关键配置

如何确认成功

执行 chatchat start -a 后，出现 README 所示启动成功界面即表示服务已启动。默认仅监听 127.0.0.1。

常见问题

注意事项

• README 节选中 pip 安装的“初始化项目配置与数据目录”部分代码块被截断，具体命令请以仓库原文档为准。
• 本项目不内置模型，需先自行启动 Xinference、LocalAI、Ollama、FastChat 等部署框架，或通过 One API 接入在线 API。
• 除本地模型框架外，还可通过 One API 接入 OpenAI、Azure OpenAI、Anthropic Claude、智谱清言、百川等在线 API。
• 数据库对话需额外配置，参见 docs/install/README_text2sql.md。