项目简介
本项目借助Python相关框架与库,融合ChatGPT等强大的对话模型,将微信打造成智能机器人。用户能在微信私聊、群聊场景中,体验智能回复、语音交互、图片生成等功能,还可通过个性化插件扩展机器人能力,实现多角色切换、文字冒险等趣味玩法。
项目的主要特性和功能
- 多端部署:支持个人微信、微信公众号和企业微信应用等部署方式,功能完备。
- 基础对话:支持私聊及群聊消息智能回复,有多轮会话上下文记忆能力,支持GPT - 3、GPT - 3.5、GPT - 4、文心一言等多种模型。
- 语音识别:可识别语音消息,能通过文字或语音回复,支持azure、baidu、google、openai等多种语音模型。
- 图片生成:支持图片生成与图生图(如照片修复),可选择Dell - E、stable diffusion、replicate、midjourney等模型。
- 丰富插件:支持个性化插件扩展,已实现多角色切换、文字冒险、敏感词过滤、聊天记录总结等实用插件。
- 知识库:通过上传知识库文件可自定义专属机器人,可作为数字分身、领域知识库、智能客服使用,基于LinkAI实现。
安装使用步骤
准备
- 前往OpenAI注册页面创建账号,参考教程用虚拟手机号接收验证码。创建完账号后,前往API管理页面创建API Key并保存。
- 本项目支持Linux、MacOS、Windows系统(可在Linux服务器上长期运行),需安装
Python
,建议Python版本在3.7.1 ~ 3.9.X之间,推荐3.8版本,3.10及以上版本在MacOS可用,其他系统不确定能否正常运行。- 复制项目代码:
bash cd chatgpt - on - wechat/
- 安装核心依赖(必选):
bash pip3 install -r requirements.txt
- 拓展依赖(可选,建议安装):
bash pip3 install -r requirements - optional.txt
bash pip3 install azure - cognitiveservices - speech
- 复制项目代码:
配置
配置文件的模板在根目录的config - template.json
中,需复制该模板创建最终生效的config.json
文件:
bash
cp config - template.json config.json
然后在config.json
中填入配置,以下是对默认配置的说明,可根据需要进行自定义修改(请去掉注释):
json
{
"open_ai_api_key": "YOUR API KEY",
"model": "gpt - 3.5 - turbo",
"proxy": "",
"single_chat_prefix": ["bot", "@bot"],
"single_chat_reply_prefix": "[bot] ",
"group_chat_prefix": ["@bot"],
"group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"],
"group_chat_in_one_session": ["ChatGPT测试群"],
"image_create_prefix": ["画", "看", "找"],
"conversation_max_tokens": 1000,
"speech_recognition": false,
"group_speech_recognition": false,
"use_azure_chatgpt": false,
"azure_deployment_id": "",
"azure_api_version": "",
"character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。",
"subscribe_msg": "感谢您的关注!\n这里是ChatGPT,可以自由对话。\n支持语音对话。\n支持图片输出,画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。"
}
运行
- 本地运行:在项目根目录下执行:
bash python3 app.py
终端输出二维码后,使用微信扫码,当输出 "Start auto replying" 时表示自动回复程序已成功运行(用于登录的微信需在支付处完成实名认证)。扫码登录后账号成为机器人,可在微信手机端通过配置的关键词触发自动回复。 - 服务器部署:使用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
目录下有一键运行、关闭程序的脚本供使用。 - 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
等。 - 启动容器:在
docker - compose.yml
所在目录下执行:bash sudo docker compose up -d
运行sudo docker ps
能查看到NAMES为chatgpt - on - wechat的容器即表示运行成功。若docker - compose
是1.X版本,则需执行sudo docker - compose up -d
启动容器。该命令会自动去docker hub拉取latest版本的镜像。最后运行以下命令查看容器运行日志,扫描日志中的二维码完成登录:bash sudo docker logs -f chatgpt - on - wechat
``` volumes:
- 下载
- ./config.json:/app/plugins/config.json ```
- Railway部署:
- 进入Railway。
- 点击
Deploy Now
按钮。 - 设置环境变量来重载程序运行的参数,例如
open_ai_api_key
、character_desc
。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】