项目简介
本项目是基于Python的多平台智能对话机器人系统,支持微信、企业微信、公众号、飞书、钉钉等多平台接入。可选用GPT3.5、GPT4.0、Claude、文心一言、讯飞星火、通义千问、Gemini、LinkAI等多种大模型,具备处理文本、语音和图片的能力,还能通过插件访问操作系统和互联网等外部资源,支持基于自有知识库定制企业AI应用。
项目的主要特性和功能
- 多端部署:支持个人微信、微信公众号、企业微信、飞书、钉钉等多种部署方式,功能完备。
- 基础对话:支持私聊及群聊的消息智能回复,具备多轮会话上下文记忆功能,支持GPT - 3.5、GPT - 4、claude、Gemini、文心一言、讯飞星火、通义千问等多种模型。
- 语音能力:可识别语音消息,并通过文字或语音回复,支持azure、baidu、google、openai(whisper/tts)等多种语音模型。
- 图像能力:支持图片生成、图片识别、图生图(如照片修复),可选择Dall - E - 3、stable diffusion、replicate、midjourney、vision等模型。
- 丰富插件:支持个性化插件扩展,已实现多角色切换、文字冒险、敏感词过滤、聊天记录总结、文档总结和对话、联网搜索等插件。
- 知识库:可通过上传知识库文件自定义专属机器人,可作为数字分身、智能客服、私域助手使用,基于LinkAI实现。
安装使用步骤
假设用户已经下载了本项目的源码文件,按照以下步骤进行安装和使用:
准备运行环境
支持Linux、MacOS、Windows系统,需安装Python,建议Python版本在3.7.1~3.9.X之间,推荐3.8版本,3.10及以上版本在MacOS可用,其他系统上不确定能否正常运行。
1. 复制项目代码:
bash
cd chatgpt-on-wechat/
注: 如遇到网络问题可选择国内镜像https://gitee.com/zhayujie/chatgpt-on-wechat。
2. 安装核心依赖 (必选):
bash
pip3 install -r requirements.txt
3. 拓展依赖 (可选,建议安装):
bash
pip3 install -r requirements-optional.txt
如果某项依赖安装失败可注释掉对应的行再继续。
配置
配置文件的模板在根目录的config-template.json
中,需复制该模板创建最终生效的config.json
文件:
bash
cp config-template.json config.json
然后在config.json
中填入配置,可根据需要进行自定义修改(请去掉注释)。
运行
1. 本地运行
在项目根目录下执行:
bash
python3 app.py # windows环境下该命令通常为 python app.py
终端输出二维码后,使用微信进行扫码,当输出 "Start auto replying" 时表示自动回复程序已经成功运行(用于登录的微信需要在支付处已完成实名认证)。
2. 服务器部署
使用nohup命令在后台运行程序:
bash
touch nohup.out
nohup python3 app.py & tail -f nohup.out
扫码登录后程序即可运行于服务器后台,可通过ctrl+c
关闭日志,不影响后台程序运行。使用ps -ef | grep app.py | grep -v grep
命令可查看运行于后台的进程,若要重新启动程序可先kill
掉对应的进程。日志关闭后若想再次打开只需输入tail -f nohup.out
。此外,scripts
目录下有一键运行、关闭程序的脚本供使用。
3. Docker部署
前提是需要安装好docker
及docker-compose
。
- 下载docker-compose.yml
文件:
bash
wget https://open-1317903499.cos.ap-guangzhou.myqcloud.com/docker-compose.yml
下载完成后打开docker-compose.yml
修改所需配置,如OPEN_AI_API_KEY
和GROUP_NAME_WHITE_LIST
等。
- 启动容器:
bash
sudo docker compose up -d
运行sudo docker ps
能查看到NAMES为chatgpt - on - wechat的容器即表示运行成功。
- 查看容器运行日志,扫描日志中的二维码即可完成登录:
bash
sudo docker logs -f chatgpt-on-wechat
4. Railway部署
- 进入Railway。
- 点击
Deploy Now
按钮。 - 设置环境变量来重载程序运行的参数,例如
open_ai_api_key
、character_desc
。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】