You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 5.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. # 简介
  2. > ChatGPT近期以强大的对话和信息整合能力风靡全网,可以写代码、改论文、讲故事,几乎无所不能,这让人不禁有个大胆的想法,能否用他的对话模型把我们的微信打造成一个智能机器人,可以在与好友对话中给出意想不到的回应,而且再也不用担心女朋友影响我们 ~~打游戏~~ 工作了。
  3. 基于ChatGPT的微信聊天机器人,通过 [OpenAI](https://github.com/openai/openai-quickstart-python) 接口生成对话内容,使用 [itchat](https://github.com/littlecodersh/ItChat) 实现微信消息的接收和自动回复。已实现的特性如下:
  4. - [x] **文本对话:** 接收私聊及群组中的微信消息,使用ChatGPT生成回复内容,完成自动回复
  5. - [x] **规则定制化:** 支持私聊中按指定规则触发自动回复,支持对群组设置自动回复白名单
  6. - [x] **多账号:** 支持多微信账号同时运行
  7. - [x] **图片生成:** 支持根据描述生成图片,并自动发送至个人聊天或群聊
  8. # 更新日志
  9. >**2022.12.19:** 引入 [itchat-uos](https://github.com/why2lyj/ItChat-UOS) 替换 itchat,解决由于不能登录网页微信而无法使用的问题,且解决Python3.9的兼容问题
  10. >**2022.12.18:** 支持根据描述生成图片并发送,openai版本需大于0.25.0
  11. >**2022.12.17:** 原来的方案是从 [ChatGPT页面](https://chat.openai.com/chat) 获取session_token,使用 [revChatGPT](https://github.com/acheong08/ChatGPT) 直接访问web接口,但随着ChatGPT接入Cloudflare人机验证,这一方案难以在服务器顺利运行。 所以目前使用的方案是调用 OpenAI 官方提供的 [API](https://beta.openai.com/docs/api-reference/introduction),回复质量上基本接近于ChatGPT的内容,劣势是暂不支持有上下文记忆的对话,优势是稳定性和响应速度较好。
  12. # 使用效果
  13. ### 个人聊天
  14. ![single-chat-sample.jpg](docs/images/single-chat-sample.jpg)
  15. ### 群组聊天
  16. ![group-chat-sample.jpg](docs/images/group-chat-sample.jpg)
  17. ### 图片生成
  18. ![group-chat-sample.jpg](docs/images/image-create-sample.jpg)
  19. # 快速开始
  20. ## 准备
  21. ### 1. OpenAI账号注册
  22. 前往 [OpenAI注册页面](https://beta.openai.com/signup) 创建账号,参考这篇 [博客](https://www.cnblogs.com/damugua/p/16969508.html) 可以通过虚拟手机号来接收验证码。创建完账号则前往 [API管理页面](https://beta.openai.com/account/api-keys) 创建一个 API Key 并保存下来,后面需要在项目中配置这个key。
  23. > 项目中使用的对话模型是 davinci,计费方式是每1k字 (包含请求和回复) 消耗 $0.02,图片生成是每张消耗 $0.016,账号创建有免费的 $18 额度,使用完可以更换邮箱重新注册。
  24. ### 2.运行环境
  25. 支持运行在 Linux、MacOS、Windows 系统上,且安装有 `Python`(版本在 3.7.1 以上),推荐使用Linux服务器,可托管于后台长期运行。
  26. 1.克隆项目代码:
  27. ```bash
  28. git clone https://github.com/zhayujie/chatgpt-on-wechat
  29. cd chatgpt-on-wechat/
  30. ```
  31. 2.安装所需核心依赖:
  32. ```bash
  33. pip3 install itchat-uos==1.5.0.dev0
  34. pip3 install openai==0.25.0
  35. ```
  36. ## 配置
  37. 配置文件的模板在根目录的`config-template.json`中,需复制该模板创建最终生效的 `config.json` 文件:
  38. ```bash
  39. cp config-template.json config.json
  40. ```
  41. 然后在`config.json`中填入自定义配置,各配置项含义如下:
  42. ```bash
  43. # config.json文件内容示例
  44. {
  45. "open_ai_api_key": "${YOUR API KEY}$" # 必填,上面创建的 OpenAI API KEY
  46. "single_chat_prefix": ["bot", "@bot"], # 私聊时文本需要包含该前缀才能触发机器人回复
  47. "single_chat_reply_prefix": "[bot] ", # 私聊时自动回复的前缀,用于区分真人
  48. "group_chat_prefix": ["@bot"], # 群聊时包含该前缀则会触发机器人回复
  49. "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
  50. "image_create_prefix": ["画", "看", "找"] # 开启图片回复的前缀
  51. }
  52. ```
  53. **配置说明:**
  54. + 个人聊天中,需要以 "bot" 或 "@bot" 为开头的内容触发机器人,对应配置中的 `single_chat_prefix`;机器人回复的内容会以 "[bot]" 作为前缀, 以区分真人,对应的配置为 `single_chat_reply_prefix`
  55. + 群组聊天中,群名称需配置在 `group_name_white_list ` 中才能开启群聊自动回复,默认只要被@就会触发机器人自动回复,另外群聊天中只要检测到以 "@bot" 开头的内容,同样会自动回复,这对应配置 `group_chat_prefix`
  56. + 对于图像生成,在满足个人或群组触发条件外,还需要额外的关键词,对应配置 `image_create_prefix `
  57. + 关于OpenAI对话及图片接口的参数配置(内容自由度、回复字数限制、图片大小等),可以参考 [对话接口](https://beta.openai.com/docs/api-reference/completions) 和 [图像接口](https://beta.openai.com/docs/api-reference/completions) 文档直接在 [代码](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/bot/openai/open_ai_bot.py) `bot\openai\open_ai_bot.py` 中进行调整。
  58. ## 运行
  59. 1.如果是开发机本地调试,直接在项目根目录下执行:
  60. ```bash
  61. python3 app.py
  62. ```
  63. 终端输出二维码后,使用微信进行扫码,当输出 "Start auto replying" 时表示自动回复程序已经成功运行了。
  64. 2.如果是服务器部署,则使用nohup命令在后台运行:
  65. ```bash
  66. touch nohup.out # 首次运行需要新建日志文件
  67. nohup python3 app.py & tail -f nohup.out # 后台运行程序并输出日志
  68. ```
  69. 同样在扫码后程序即可成功运行于服务器后台。