项目简介
本项目借助OpenAI强大的对话模型,将微信转变为智能机器人。支持个人微信、微信公众号和企业微信应用等多端部署方式。该机器人具备基础对话、语音识别、图片生成等功能,还支持丰富的插件扩展。
项目的主要特性和功能
- 多端部署:支持个人微信、微信公众号和企业微信应用等多种部署方式。
- 基础对话:可对私聊及群聊消息进行智能回复,支持多轮会话上下文记忆,支持GPT - 3、GPT - 3.5、GPT - 4模型。
- 语音识别:能识别语音消息,通过文字或语音回复,支持Azure、Baidu、Google、OpenAI等多种语音模型。
- 图片生成:支持图片生成和图生图(如照片修复),可选择DALL - E、Stable Diffusion、Replicate模型。
- 丰富插件:支持个性化插件扩展,已实现多角色切换、文字冒险、敏感词过滤、聊天记录总结等插件。
- Tool工具:与操作系统和互联网交互,支持最新信息搜索、数学计算、天气和资讯查询、网页总结,基于chatgpt - tool - hub实现。
安装使用步骤
1. 准备
1.1 OpenAI账号注册
前往 OpenAI注册页面 创建账号,参考 教程 可通过虚拟手机号接收验证码。创建完账号后,前往 API管理页面 创建一个 API Key 并保存,后续项目配置会用到。
1.2 运行环境
支持 Linux、MacOS、Windows 系统(可在Linux服务器上长期运行),需安装 Python
。建议Python版本在 3.7.1~3.9.X 之间,推荐3.8版本,3.10及以上版本在 MacOS 可用,其他系统不确定能否正常运行。
2. 复制项目代码
bash
cd chatgpt-on-wechat/
3. 安装依赖
3.1 安装核心依赖
bash
pip3 install -r requirements.txt
3.2 安装拓展依赖(可选,建议安装)
bash
pip3 install -r requirements-optional.txt
4. 配置
配置文件模板在根目录的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": "127.0.0.1:7890",
"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,
"character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。",
"subscribe_msg": "感谢您的关注!\n这里是ChatGPT,可以自由对话。\n支持语音对话。\n支持图片输出,画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。"
}
5. 运行
5.1 本地运行
若在开发机本地运行,直接在项目根目录下执行:
bash
python3 app.py
终端输出二维码后,用微信扫码,当输出 "Start auto replying" 时,表示自动回复程序已成功运行。
5.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
目录下有一键运行、关闭程序的脚本。
6. Docker部署
暂无详细步骤说明。
7. Railway部署
Railway每月提供5刀和最多500小时的免费额度。
1. 进入 Railway。
2. 点击 Deploy Now
按钮。
3. 设置环境变量来重载程序运行的参数,例如open_ai_api_key
, character_desc
。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】