LangChain-ChatGLM 项目使用与部署指南

LangChain-ChatGLM 项目使用与部署指南

Langchain-Chatchat 项目地址: https://gitcode.com/gh_mirrors/lang/Langchain-Chatchat

1. 项目目录结构及介绍

LangChain-ChatGLM 项目的目录结构如下：

Langchain-ChatGLM/
├── .github/              # GitHub 相关配置
├── docker/               # Docker 相关文件
├── docs/                 # 文档资料
├── frontend/             # 前端代码
├── libs/                 # 项目依赖的库
├── markdown_docs/        # Markdown 文档
├── tools/                # 工具脚本
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置
├── LICENSE              # 开源协议
├── README.md            # 项目说明文件
├── README_en.md          # 项目说明文件（英文版）
├── poetry.toml           # Poetry 包管理配置
├── pyproject.toml        # Pyproject 包管理配置
├── release.py            # 版本发布脚本
└── ...

• .github/: 存放 GitHub Actions 工作流文件等。
• docker/: 包含 Dockerfile 和 docker-compose 文件，用于 Docker 部署。
• docs/: 存储项目的文档资料。
• frontend/: 前端代码，用于构建用户界面。
• libs/: 存放项目依赖的库。
• markdown_docs/: 项目相关的 Markdown 文档。
• tools/: 放置一些辅助性的脚本和工具。
• .gitignore: 指定 Git 忽略的文件。
• .gitmodules: 配置 Git 子模块。
• LICENSE: 项目遵循的开源协议文件。
• README.md 和 README_en.md: 分别是中文和英文的项目说明文件。
• poetry.toml 和 pyproject.toml: 包管理配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 start.py 或 main.py，但在此项目中，启动是通过命令行界面进行的。以下是启动项目的步骤：

1. 首先确保已经安装了项目所需的依赖库。

2. 在项目根目录下，运行以下命令启动服务：

   chatchat start -a
   

这将会启动项目的 Web 服务，默认情况下服务将监听 127.0.0.1 地址。

3. 项目的配置文件介绍

LangChain-ChatGLM 项目使用 YAML 格式的配置文件，配置文件位于项目根目录下，主要包括以下几个文件：

• model_settings.yaml: 模型配置文件，用于设置默认的 LLM 名称、Embedding 名称以及模型平台信息。
• basic_settings.yaml: 基础设置文件，包括服务监听地址、数据库连接信息等。
• kb_settings.yaml: 知识库配置文件，用于设置知识库的类型、路径和其他相关配置。

这些配置文件可以通过文本编辑器直接修改，也可以通过项目提供的命令行工具进行修改。每次修改配置后，无需重启服务，配置会自动更新。

Langchain-Chatchat 项目地址: https://gitcode.com/gh_mirrors/lang/Langchain-Chatchat