🇨🇳中文 | 🌐English

---

ChatPilot: 聊天智能体 Web 用户界面

ChatPilot: 聊天智能体 Web 用户界面，实现了 AgentChat 对话，支持 Google 搜索、文件网址对话（RAG，检索增强生成）、代码解释器功能，复现 Kimi Chat（文件，拖进来；网址，发出来），支持 OpenAI/Azure API（应用程序编程接口）。

功能特点

• 本项目基于 Agentica 实现了智能体助手 (Agent Assistant) 调用，支持如下功能：
  • 工具调用：支持智能体 (Agent) 调用外部工具
    • 联网搜索工具：Google Search API（Serper/DuckDuckGo）
    • URL 自动解析工具：复现了 Kimi Chat 网址发送功能
    • Python 代码解释器：支持 E2B 虚拟环境和本地 python 编译器环境运行代码
  • 多种 LLM（大语言模型）接入：支持多种 LLM 模型以多方式接入，包括使用 Ollama Api 接入各种本地开源模型；使用 litellm Api 接入各云服务部署模型；使用 OpenAI Api 接入 GPT 系列模型
  • RAG（检索增强生成）：支持智能体 (Agent) 调用 RAG 进行文件问答
• 支持前后端服务分离，前端使用 Svelte，后端使用 FastAPI
• 支持语音输入输出，支持图像生成
• 支持用户管理，权限控制，支持聊天记录导入导出

演示

官方演示：https://chat.mulanai.com

开始使用

在 Docker 容器中运行 ChatPilot

export OPENAI_API_KEY=sk-xxx
export OPENAI_BASE_URL=https://xxx/v1

docker run -it \
 -e OPENAI_API_KEY=$WORKSPACE_BASE \
 -e OPENAI_BASE_URL=$OPENAI_BASE_URL \
 -e RAG_EMBEDDING_MODEL="text-embedding-ada-002" \
 -p 8080:8080 --name chatpilot-$(date +%Y%m%d%H%M%S) shibing624/chatpilot:0.0.1

您将在 http://0.0.0.0:8080 找到运行的 ChatPilot。享受吧！😄

本地启动服务

git clone https://github.com/shibing624/ChatPilot.git
cd ChatPilot
pip install -r requirements.txt

# Copying required .env file, and fill in the LLM api key
cp .env.example .env

bash start.sh

好了，现在你的应用正在运行：http://0.0.0.0:8080 Enjoy! 😄

构建前端 web

构建前端有两种方法：

1. 解压打包并编译好的前端 web/build.zip，解压到项目 web 目录下。
2. 如果修改了 web 前端代码，需要自己使用 npm（Node.js 包管理器）重新构建前端：

git clone https://github.com/shibing624/ChatPilot.git
cd ChatPilot/

# Building Frontend Using Node.js >= 20.10
cd web
npm install
npm run build

输出：项目 web 目录产出 build 文件夹，包含了前端编译输出文件。

多种 LLM 接入

使用 OpenAI Api 接入 GPT 系列模型

• 使用 OpenAI API，配置环境变量：

export OPENAI_API_KEY=xxx
export OPENAI_BASE_URL=https://api.openai.com/v1
export MODEL_TYPE="openai"

• 如果使用 Azure OpenAI API，需要配置如下环境变量：

export AZURE_OPENAI_API_KEY=
export AZURE_OPENAI_API_VERSION=
export AZURE_OPENAI_ENDPOINT=
export MODEL_TYPE="azure"

使用 Ollama Api 接入各种本地开源模型

以 ollama serve 启动 ollama 服务，然后配置 OLLAMA_API_URL：export OLLAMA_API_URL=http://localhost:11413

使用 litellm Api 接入各云服务部署模型

1. 安装 litellm 包：

pip install litellm -U

2. 修改配置文件

chatpilot 默认的 litellm 配置文件在 ~/.cache/chatpilot/data/litellm/config.yaml

修改其内容如下：

model_list:
#  - model_name: moonshot-v1-auto # show model name in the UI
#    litellm_params: # all params accepted by litellm.completion() - https://docs.litellm.ai/docs/completion/input
#      model: openai/moonshot-v1-auto # MODEL NAME sent to `litellm.completion()` #
#      api_base: https://api.moonshot.cn/v1
#      api_key: sk-xx
#      rpm: 500      # [OPTIONAL] Rate limit for this deployment: in requests per minute (rpm)

  - model_name: deepseek-ai/DeepSeek-Coder # show model name in the UI
    litellm_params: # all params accepted by litellm.completion() - https://docs.litellm.ai/docs/completion/input
      model: openai/deepseek-coder # MODEL NAME sent to `litellm.completion()` #
      api_base: https://api.deepseek.com/v1
      api_key: sk-xx
      rpm: 500
  - model_name: openai/o1-mini # show model name in the UI
    litellm_params: # all params accepted by litellm.completion() - https://docs.litellm.ai/docs/completion/input
      model: o1-mini # MODEL NAME sent to `litellm.completion()` #
      api_base: https://api.61798.cn/v1
      api_key: sk-xxx
      rpm: 500
litellm_settings: # module level litellm settings - https://github.com/BerriAI/litellm/blob/main/litellm/__init__.py
  drop_params: True
  set_verbose: False

联系方式

• Issue（建议）：
• 邮件我：xuming: xuming624@qq.com
• 微信我：加我微信号：xuming624, 备注：姓名 - 公司-NLP 进 NLP 交流群。

引用

如果你在研究中使用了 ChatPilot，请按如下格式引用：

APA:

Xu, M. ChatPilot: LLM agent toolkit (Version 0.0.2) [Computer software]. https://github.com/shibing624/ChatPilot

BibTeX:

@misc{ChatPilot,
  author = {Ming Xu},
  title = {ChatPilot: llm agent},
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/shibing624/ChatPilot}},
}

许可证

授权协议为 The Apache License 2.0，可免费用做商业用途。请在产品说明中附加 ChatPilot 的链接和授权协议。

贡献

项目代码还很粗糙，如果大家对代码有所改进，欢迎提交回本项目，在提交之前，注意以下两点：

• 在 tests 中添加相应的单元测试 (Unit Test)
• 使用 python -m pytest -v（pytest 测试框架）来运行所有单元测试，确保所有测试均通过

之后即可提交 PR（拉取请求）。

参考

• Open WebUI
• langchain-ai/langchain
• shibing624/agentica

ChatPilot 快速上手指南

ChatPilot 是一款基于 Agent 的聊天机器人 Web UI，支持联网搜索、RAG 文件问答、代码解释器等功能，兼容 OpenAI/Azure API 及多种本地模型。

环境准备

• 系统要求: Linux / macOS / Windows
• Python: 3.9+
• Docker: 推荐使用 Docker 方式部署（可选）
• Node.js: >= 20.10（仅当需要手动编译前端时使用）
• Git: 用于克隆项目代码

安装步骤

方法一：Docker 部署（推荐）

直接使用官方镜像启动服务，无需配置本地 Python 环境。

export OPENAI_API_KEY=sk-xxx
export OPENAI_BASE_URL=https://xxx/v1

docker run -it \
 -e OPENAI_API_KEY=$WORKSPACE_BASE \
 -e OPENAI_BASE_URL=$OPENAI_BASE_URL \
 -e RAG_EMBEDDING_MODEL="text-embedding-ada-002" \
 -p 8080:8080 --name chatpilot-$(date +%Y%m%d%H%M%S) shibing624/chatpilot:0.0.1

方法二：本地源码部署

适用于需要深度定制或调试的场景。

git clone https://github.com/shibing624/ChatPilot.git
cd ChatPilot
pip install -r requirements.txt

# 复制并配置环境变量文件
cp .env.example .env

# 启动服务
bash start.sh

基本使用

1. 访问服务

安装完成后，在浏览器打开以下地址：

http://0.0.0.0:8080

2. 配置大模型接入

根据需求修改 .env 文件或 Docker 环境变量，支持多种接入方式：

• OpenAI/GPT 系列

  export OPENAI_API_KEY=xxx
  export OPENAI_BASE_URL=https://api.openai.com/v1
  export MODEL_TYPE="openai"
  

• Azure OpenAI

  export AZURE_OPENAI_API_KEY=
  export AZURE_OPENAI_API_VERSION=
  export AZURE_OPENAI_ENDPOINT=
  export MODEL_TYPE="azure"
  

• 本地开源模型 (Ollama) 确保已启动 ollama serve，然后配置：

  export OLLAMA_API_URL=http://localhost:11413
  

• 多模型接入 (LiteLLM) 编辑配置文件 ~/.cache/chatpilot/data/litellm/config.yaml，添加模型列表配置（如 DeepSeek、Moonshot 等）。

3. 核心功能体验

• 联网搜索: 启用后自动调用 Google Search API 获取实时信息。
• 文件对话 (RAG): 拖入文件即可进行问答（类似 Kimi Chat 体验）。
• 代码解释器: 支持运行 Python 代码，可配置 E2B 虚拟环境或本地编译器。
• 语音与图像: 支持语音输入输出及图像生成功能。