From 05c6973f5f07659ec15cb08c5bfcee5010262c54 Mon Sep 17 00:00:00 2001 From: zhayujie Date: Tue, 20 Dec 2022 10:05:53 +0800 Subject: [PATCH] docs: update README --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2fe68d1..cde5028 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,21 @@ > ChatGPT近期以强大的对话和信息整合能力风靡全网，可以写代码、改论文、讲故事，几乎无所不能，这让人不禁有个大胆的想法，能否用他的对话模型把我们的微信打造成一个智能机器人，可以在与好友对话中给出意想不到的回应，而且再也不用担心女朋友影响我们 ~~打游戏~~ 工作了。 -本项目是基于ChatGPT的微信聊天机器人，通过 [OpenAI](https://github.com/openai/openai-quickstart-python) 接口生成对话内容，使用 [itchat](https://github.com/littlecodersh/ItChat) 实现微信消息的接收和自动回复。已实现的特性如下： +基于ChatGPT的微信聊天机器人，通过 [OpenAI](https://github.com/openai/openai-quickstart-python) 接口生成对话内容，使用 [itchat](https://github.com/littlecodersh/ItChat) 实现微信消息的接收和自动回复。已实现的特性如下： -- [x] **w文本对话：** 接收私聊及群组中的微信消息，使用ChatGPT生成回复内容，完成自动回复 +- [x] **文本对话：** 接收私聊及群组中的微信消息，使用ChatGPT生成回复内容，完成自动回复 - [x] **规则定制化：** 支持私聊中按指定规则触发自动回复，支持对群组设置自动回复白名单 - [x] **多账号：** 支持多微信账号同时运行 -- [x] **图片生成：** 支持根据描述生成图片，并自动发送至个人聊天或群聊 +- [x] **图片生成：** 支持根据描述生成图片，并自动发送至个人聊天或群聊 # 更新日志 ->**2022.12.19：** 引入 [itchat-uos](https://github.com/why2lyj/ItChat-UOS) 替换 itchat，解决由于不能登录网页微信而无法使用的问题，且解决Python版本限制问题 (支持Python3.9) +>**2022.12.19：** 引入 [itchat-uos](https://github.com/why2lyj/ItChat-UOS) 替换 itchat，解决由于不能登录网页微信而无法使用的问题，且解决Python3.9的兼容问题 >**2022.12.18：** 支持根据描述生成图片并发送，openai版本需大于0.25.0 ->**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的内容，劣势是暂不支持有上下文记忆的对话，优势是稳定性和响应速度较好。 +>**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的内容，劣势是暂不支持有上下文记忆的对话，优势是稳定性和响应速度较好。 # 使用效果 @@ -47,15 +47,16 @@ ### 2.运行环境 -支持运行在 Linux、MacOS、Windows 系统上，且安装有 `Python`(版本需在 3.7.1 以上)，推荐使用Linux服务器，可托管于后台长期运行。 +支持运行在 Linux、MacOS、Windows 系统上，且安装有 `Python`(版本在 3.7.1 以上)，推荐使用Linux服务器，可托管于后台长期运行。 -克隆项目代码： +1.克隆项目代码： ```bash -https://github.com/zhayujie/chatgpt-on-wechat +git clone https://github.com/zhayujie/chatgpt-on-wechat +cd chatgpt-on-wechat/ ``` -安装所需核心依赖： +2.安装所需核心依赖： ```bash pip3 install itchat-uos==1.5.0.dev0 @@ -71,7 +72,7 @@ pip3 install openai==0.25.0 cp config-template.json config.json ``` -然后填入自定义配置，各配置项含义如下： +然后在`config.json`中填入自定义配置，各配置项含义如下： ```bash # config.json文件内容示例 @@ -81,12 +82,12 @@ cp config-template.json config.json "single_chat_reply_prefix": "[bot] ", # 私聊时自动回复的前缀，用于区分真人 "group_chat_prefix": ["@bot"], # 群聊时包含该前缀则会触发机器人回复 "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表 - "image_create_prefix": ["画", "看", "找"] # 开启图片生成的前缀 + "image_create_prefix": ["画", "看", "找"] # 开启图片回复的前缀 } ``` **配置说明：** -+ 个人聊天中，会以 "bot" 或 "@bot" 为开头的内容触发机器人，对应配置中的 `single_chat_prefix`；机器人回复的内容会以 "[bot]" 作为前缀， 以区分真人，对应的配置为 `single_chat_reply_prefix` ++ 个人聊天中，需要以 "bot" 或 "@bot" 为开头的内容触发机器人，对应配置中的 `single_chat_prefix`；机器人回复的内容会以 "[bot]" 作为前缀， 以区分真人，对应的配置为 `single_chat_reply_prefix` + 群组聊天中，群名称需配置在 `group_name_white_list ` 中才能开启群聊自动回复，默认只要被@就会触发机器人自动回复，另外群聊天中只要检测到以 "@bot" 开头的内容，同样会自动回复，这对应配置 `group_chat_prefix` + 对于图像生成，在满足个人或群组触发条件外，还需要额外的关键词，对应配置 `image_create_prefix ` + 关于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` 中进行调整。