项目简介
此项目借助Python语言,结合ChatGPT强大的对话与信息整合能力,将微信打造成智能机器人。用户在与好友对话时,机器人能给出智能回应,还支持多轮会话上下文记忆。项目具备多端部署能力,可在个人微信、微信公众号和企业微信应用等场景使用,同时支持语音识别、图片生成等功能,还能通过插件扩展实现更多个性化交互。
项目的主要特性和功能
- 多端部署:支持个人微信、微信公众号和企业微信应用等多种部署方式,功能完备。
- 基础对话:可在私聊及群聊中智能回复消息,支持多轮会话上下文记忆,涵盖GPT - 3、GPT - 3.5、GPT - 4等多种模型。
- 语音识别:能识别语音消息,通过文字或语音回复,支持azure、baidu、google、openai等多种语音模型。
- 图片生成:支持图片生成和图生图(如照片修复),可选择Dell - E、stable diffusion、replicate等模型。
- 丰富插件:支持个性化插件扩展,已实现多角色切换、文字冒险、敏感词过滤、聊天记录总结等插件。
安装使用步骤
准备
- OpenAI账号注册:前往 OpenAI注册页面 创建账号,参考 教程 可通过虚拟手机号接收验证码。创建完账号后,前往 API管理页面 创建一个 API Key 并保存。
- 运行环境:支持 Linux、MacOS、Windows 系统(可在 Linux 服务器上长期运行),需安装
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
若某项依赖安装失败,请注释掉对应的行再继续。其中tiktoken
要求python
版本在 3.8 以上,用于精确计算会话使用的 tokens 数量,强烈建议安装。使用google
或baidu
语音识别需安装ffmpeg
,默认的openai
语音识别不需要安装ffmpeg
。使用azure
语音功能需安装依赖,并参考 文档 的环境要求。bash pip3 install azure - cognitiveservices - speech
- 复制项目代码:
配置
配置文件的模板在根目录的 config - template.json
中,需复制该模板创建最终生效的 config.json
文件:
bash
cp config - template.json config.json
然后在 config.json
中填入配置,以下是对默认配置的说明,可根据需要进行自定义修改(请去掉注释):
bash
{
"open_ai_api_key": "YOUR API KEY", # 填入上面创建的 OpenAI API KEY
"model": "gpt - 3.5 - turbo", # 模型名称。当 use_azure_chatgpt 为 true 时,其名称为 Azure 上 model deployment 名称
"proxy": "127.0.0.1:7890", # 代理客户端的 ip 和端口
"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 ChatGPT service 代替 openai ChatGPT service. 当设置为 true 时需要设置 open_ai_api_base,如 https://xxx.openai.azure.com/
"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
目录下有一键运行、关闭程序的脚本供使用。 - Railway部署 (✅推荐):
- 进入 Railway。
- 点击
Deploy Now
按钮。 - 设置环境变量来重载程序运行的参数,例如
open_ai_api_key
、character_desc
。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】