GitHub

简介

近期以强大的对话和信息整合能力风靡全网，可以写代码、改论文、讲故事，几乎无所不能，这让人不禁有个大胆的想法，能否用他的对话模型把我们的微信打造成一个智能机器人，可以在与好友对话中给出意想不到的回应，而且再也不用担心女朋友影响我们 打游戏 工作了。

最新版本支持的功能如下：

欢迎接入更多应用，参考 代码实现接收和发送消息逻辑即可接入。 同时欢迎增加新的插件，参考 插件说明文档。

演示

-on--demo-0422.mp4

Demo made by

交流群

添加小助手微信进群，请备注 ""：

更新日志

2023.09.01： 增加 通道，，讯飞星火模型

2023.08.08： 接入百度文心一言模型，通过 插件 支持 绘图

2023.06.12： 接入 平台，可在线创建个人知识库，并接入微信、公众号及企业微信中，打造专属客服机器人。使用参考 接入文档。

2023.04.26： 支持企业微信应用号部署，兼容插件，并支持语音图片交互，私人助理理想选择，使用文档。( by @ in #944)

2023.04.05： 支持微信公众号部署，兼容插件，并支持语音图片交互，使用文档。( by @ in #686)

2023.04.05： 增加能让使用工具的tool插件，使用文档。工具相关issue可反馈至-tool-hub。( by @ in #663)

2023.03.25： 支持插件化开发，目前已实现 多角色切换、文字冒险游戏、管理员指令、 等插件，使用参考 #578。( by @ in #565)

2023.03.09： 基于 API(后续已接入更多的语音API服务) 实现对微信语音消息的解析和回复，添加配置项 "":true 即可启用，使用参考 #415。( by in #385)

2023.03.02： 接入 API (gpt-3.5-turbo)，默认使用该模型进行对话，需升级依赖 (pip3 -- )。网络问题参考 #351

2023.02.09： 扫码登录存在账号限制风险，请谨慎使用，参考#58

快速开始

准备

1. 账号注册

前往 注册页面 创建账号，参考这篇 教程 可以通过虚拟手机号来接收验证码。创建完账号则前往 API管理页面 创建一个 API Key 并保存下来，后面需要在项目中配置这个key。

项目中默认使用的对话模型是 gpt3.5 turbo，计费方式是约每 500 汉字 (包含请求和回复) 消耗 $0.002，图片生成是每张消耗 $0.016。

2.运行环境

支持 Linux、MacOS、 系统（可在Linux服务器上长期运行)，同时需安装 。

建议版本在 3.7.1~3.9.X 之间，推荐3.8版本，3.10及以上版本在 MacOS 可用，其他系统上不确定能否正常运行。

注意： 或 部署无需安装环境和下载源码，可直接快进到下一节。

(1) 克隆项目代码：

git clone https://github.com/zhayujie/chatgpt-on-wechat
cd chatgpt-on-wechat/

(2) 安装核心依赖 (必选)：

能够使用创建机器人，并具有文字交流功能所需的最小依赖集合。

pip3 install -r requirements.txt

(3) 拓展依赖 (可选，建议安装)：

pip3 install -r requirements-optional.txt

如果某项依赖安装失败请注释掉对应的行再继续。

其中要求版本在3.8以上，它用于精确计算会话使用的数量，强烈建议安装。

使用或baidu语音识别需安装，

默认的语音识别不需要安装。

参考#415

使用azure语音功能需安装依赖，并参考文档的环境要求。:

pip3 install azure-cognitiveservices-speech

配置

配置文件的模板在根目录的-.json中，需复制该模板创建最终生效的 .json 文件：

  cp config-template.json config.json

然后在.json中填入配置，以下是对默认配置的说明，可根据需要进行自定义修改（请去掉注释）：

# config.json文件内容示例
{
  "open_ai_api_key": "YOUR API KEY",                          # 填入上面创建的 OpenAI API KEY
  "model": "gpt-3.5-turbo",                                   # 模型名称, 支持 gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, wenxin, xunfei
  "proxy": "",                                                # 代理客户端的ip和端口，国内环境开启代理的需要填写该项，如 "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,                                 # 是否使用Azure ChatGPT service代替openai ChatGPT service. 当设置为true时需要设置 open_ai_api_base，如 https://xxx.openai.azure.com/
  "azure_deployment_id": "",                                  # 采用Azure ChatGPT时，模型部署名称
  "azure_api_version": "",                                    # 采用Azure ChatGPT时，API版本
  "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。",  # 人格描述
  # 订阅消息，公众号和企业微信channel中请填写，当被订阅时会自动回复，可使用特殊占位符。目前支持的占位符有{trigger_prefix}，在程序中它会自动替换成bot的触发词。
  "subscribe_msg": "感谢您的关注！\n这里是ChatGPT，可以自由对话。\n支持语音对话。\n支持图片输出，画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。",
  "use_linkai": false,                                        # 是否使用LinkAI接口，默认关闭，开启后可国内访问，使用知识库和MJ
  "linkai_api_key": "",                                       # LinkAI Api Key
  "linkai_app_code": ""                                       # LinkAI 应用code
}

配置说明：

1.个人聊天

2.群组聊天

3.语音识别

4.其他配置

5.配置 (可选)

本说明文档可能会未及时更新，当前所有可选的配置项均在该.py中列出。

运行

1.本地运行

如果是开发机 本地运行，直接在项目根目录下执行：

python3 app.py

终端输出二维码后，使用微信进行扫码，当输出 "Start auto " 时表示自动回复程序已经成功运行了（注意：用于登录的微信需要在支付处已完成实名认证）。扫码登录后你的账号就成为机器人了，可以在微信手机端通过配置的关键词触发自动回复 (任意好友发送消息给你，或是自己发消息给好友)，参考#142。

2.服务器部署

使用nohup命令在后台运行程序：

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。此外， 目录下有一键运行、关闭程序的脚本供使用。

多账号支持： 将项目复制多份，分别启动程序，用不同账号扫码登录即可实现同时运行。

特殊指令： 用户向机器人发送 #reset 即可清空该用户的上下文记忆。

3.部署

使用部署无需下载源码和安装依赖，只需要获取 -.yml 配置文件并启动容器即可。

前提是需要安装好 及 -，安装成功的表现是执行 -v 和 - (或 ) 可以查看到版本号，可前往 官网 进行下载。

(1) 下载 -.yml 文件

wget https://open-1317903499.cos.ap-guangzhou.myqcloud.com/docker-compose.yml

下载完成后打开 -.yml 修改所需配置，如 和 T 等。

(2) 启动容器

在 -.yml 所在目录下执行以下命令启动容器：

sudo docker compose up -d

运行 sudo ps 能查看到 NAMES 为 -on- 的容器即表示运行成功。

注意：

最后运行以下命令可查看容器运行日志，扫描日志中的二维码即可完成登录：

sudo docker logs -f chatgpt-on-wechat

(3) 插件使用

如果需要在容器中修改插件配置，可通过挂载的方式完成，将 插件配置文件重命名为 .json，放置于 -.yml 相同目录下，并在 -.yml 中的 -on- 部分下添加 映射:

volumes:
  - ./config.json:/app/plugins/config.json

4. 部署

每月提供5刀和最多500小时的免费额度。 (07.11更新: 目前大部分账号已无法免费部署)

进入 点击 Now 按钮。设置环境变量来重载程序运行的参数，例如, 。

一键部署:

常见问题

FAQs：

或直接在线咨询 项目小助手 (beta版本，语料完善中，回复仅供参考)

联系

欢迎提交PR、，以及Star支持一下。程序运行遇到问题可以查看 常见问题列表 ，其次前往 中搜索。

科技新闻