Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shibing624/chatpilot
ChatPilot: 实现AgentChat对话，支持Google搜索、文件网址对话（RAG）、代码解释器功能，复现了Kimi Chat(文件，拖进来；网址，发出来)。
https://github.com/shibing624/chatpilot
agent chat chatbot chatgpt chatpdf chatpilot kimi langchain llm
Last synced: 3 days ago
JSON representation
ChatPilot: 实现AgentChat对话，支持Google搜索、文件网址对话（RAG）、代码解释器功能，复现了Kimi Chat(文件，拖进来；网址，发出来)。
- Host: GitHub
- URL: https://github.com/shibing624/chatpilot
- Owner: shibing624
- License: apache-2.0
- Created: 2024-03-10T10:06:42.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-10T08:48:32.000Z (7 months ago)
- Last Synced: 2024-04-11T07:29:10.090Z (7 months ago)
- Topics: agent, chat, chatbot, chatgpt, chatpdf, chatpilot, kimi, langchain, llm
- Language: Svelte
- Homepage: https://chat.mulanai.com
- Size: 3.55 MB
- Stars: 54
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
- Security: docs/SECURITY.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - ChatPilot - ChatPilot: 实现AgentChat对话，支持Google搜索、文件网址对话（RAG）、代码解释器功能，复现了Kimi Chat(文件，拖进来；网址，发出来)。 (Chatbots)
README
[**🇨🇳中文**](https://github.com/shibing624/ChatPilot/blob/main/README.md) | [**🌐English**](https://github.com/shibing624/ChatPilot/blob/main/README_EN.md)
-----------------
# ChatPilot: Chat Agent Web UI
[](https://badge.fury.io/py/ChatPilot)
[](https://pepy.tech/project/ChatPilot)
[](CONTRIBUTING.md)
[](LICENSE)
[](requirements.txt)
[](https://github.com/shibing624/ChatPilot/issues)
[](#Contact)
**ChatPilot**: Chat Agent WebUI, 实现了AgentChat对话，支持Google搜索、文件网址对话（RAG）、代码解释器功能，复现Kimi Chat(文件，拖进来；网址，发出来)，支持OpenAI/Azure API。
## Features
- 本项目基于[Agentica](https://github.com/shibing624/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
- 支持语音输入输出，支持图像生成
- 支持用户管理，权限控制，支持聊天记录导入导出
## Demo
Official Demo: https://chat.mulanai.com
## Getting Started
### Run ChatPilot in Docker
```shell
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
```
You'll find ChatPilot running at http://0.0.0.0:8080 Enjoy! 😄
### 本地启动服务
```shell
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. 下载打包并编译好的前端 [buid.zip](https://github.com/shibing624/ChatPilot/releases/download/0.1.2/build.zip) 解压到项目web目录下。
2. 如果修改了web前端代码，需要自己使用npm重新构建前端：
```sh
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，配置环境变量：
```shell
export OPENAI_API_KEY=xxx
export OPENAI_BASE_URL=https://api.openai.com/v1
export MODEL_TYPE="openai"
```
- 如果使用Azure OpenAI API，需要配置如下环境变量：
```shell
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`包：
```shell
pip install litellm -U
```
2. 修改配置文件
`chatpilot`默认的litellm config文件在`~/.cache/chatpilot/data/litellm/config.yaml`
修改其内容如下：
```yaml
model_list:
# - model_name: moonshot-v1-auto ### RECEIVED MODEL NAME ###
# 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
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
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
```
## Contact
- Issue(建议)：[](https://github.com/shibing624/ChatPilot/issues)
- 邮件我：xuming: [email protected]
- 微信我：加我*微信号：xuming624, 备注：姓名-公司-NLP* 进NLP交流群。
## Citation
如果你在研究中使用了ChatPilot，请按如下格式引用：
APA:
```latex
Xu, M. ChatPilot: LLM agent toolkit (Version 0.0.2) [Computer software]. https://github.com/shibing624/ChatPilot
```
BibTeX:
```latex
@misc{ChatPilot,
author = {Ming Xu},
title = {ChatPilot: llm agent},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/shibing624/ChatPilot}},
}
```
## License
授权协议为 [The Apache License 2.0](LICENSE)，可免费用做商业用途。请在产品说明中附加ChatPilot的链接和授权协议。
## Contribute
项目代码还很粗糙，如果大家对代码有所改进，欢迎提交回本项目，在提交之前，注意以下两点：
- 在`tests`添加相应的单元测试
- 使用`python -m pytest -v`来运行所有单元测试，确保所有单测都是通过的
之后即可提交PR。
## Reference
- [Open WebUI](https://github.com/shibing624/ChatPilot)
- [langchain-ai/langchain](https://github.com/langchain-ai/langchain)
- [shibing624/agentica](https://github.com/shibing624/agentica)