From 17ea48f25d4dfe97d61725458e34b1387994f5ba Mon Sep 17 00:00:00 2001 From: zhayujie Date: Sat, 25 Mar 2023 00:22:27 +0800 Subject: [PATCH] docs: update README for plugins --- README.md | 8 ++++---- config-template.json | 30 +++++++++++++++--------------- plugins/role/README.md | 2 +- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4a773c9..d3639da 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,16 @@ # 更新日志 +>**2023.03.25：** 支持插件化开发，目前已实现 多角色切换、文字冒险游戏、管理员指令、Stable Diffusion等插件，使用参考 [#578](https://github.com/zhayujie/chatgpt-on-wechat/issues/578)。(contributed by [@lanvent](https://github.com/lanvent) in [#565](https://github.com/zhayujie/chatgpt-on-wechat/pull/565)) + >**2023.03.09：** 基于 `whisper API` 实现对微信语音消息的解析和回复，添加配置项 `"speech_recognition":true` 即可启用，使用参考 [#415](https://github.com/zhayujie/chatgpt-on-wechat/issues/415)。(contributed by [wanggang1987](https://github.com/wanggang1987) in [#385](https://github.com/zhayujie/chatgpt-on-wechat/pull/385)) >**2023.03.02：** 接入[ChatGPT API](https://platform.openai.com/docs/guides/chat) (gpt-3.5-turbo)，默认使用该模型进行对话，需升级openai依赖 (`pip3 install --upgrade openai`)。网络问题参考 [#351](https://github.com/zhayujie/chatgpt-on-wechat/issues/351) ->**2023.02.20：** 增加 [python-wechaty](https://github.com/wechaty/python-wechaty) 作为可选渠道，使用Pad协议，但Token收费 (使用参考[#244](https://github.com/zhayujie/chatgpt-on-wechat/pull/244)，contributed by [ZQ7](https://github.com/ZQ7)) - >**2023.02.09：** 扫码登录存在封号风险，请谨慎使用，参考[#58](https://github.com/AutumnWhj/ChatGPT-wechat-bot/issues/158) >**2023.02.05：** 在openai官方接口方案中 (GPT-3模型) 实现上下文对话 ->**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的内容，劣势是暂不支持有上下文记忆的对话，优势是稳定性和响应速度较好。 @@ -102,6 +100,7 @@ pip3 install --upgrade openai "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, # 是否开启语音识别 @@ -120,6 +119,7 @@ pip3 install --upgrade openai + 群组聊天中，群名称需配置在 `group_name_white_list ` 中才能开启群聊自动回复。如果想对所有群聊生效，可以直接填写 `"group_name_white_list": ["ALL_GROUP"]` + 默认只要被人 @ 就会触发机器人自动回复；另外群聊天中只要检测到以 "@bot" 开头的内容，同样会自动回复（方便自己触发），这对应配置项 `group_chat_prefix` + 可选配置: `group_name_keyword_white_list`配置项支持模糊匹配群名称，`group_chat_keyword`配置项则支持模糊匹配群消息内容，用法与上述两个配置项相同。（Contributed by [evolay](https://github.com/evolay)) ++ `group_chat_in_one_session`：使群聊共享一个会话上下文，配置 `["ALL_GROUP"]` 则作用于所有群聊 **3.语音识别** diff --git a/config-template.json b/config-template.json index 902f290..9c6476e 100644 --- a/config-template.json +++ b/config-template.json @@ -1,16 +1,16 @@ { - "open_ai_api_key": "YOUR API KEY", - "model": "gpt-3.5-turbo", - "proxy": "", - "single_chat_prefix": ["bot", "@bot"], - "single_chat_reply_prefix": "[bot] ", - "group_chat_prefix": ["@bot"], - "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], - "image_create_prefix": ["画", "看", "找"], - "speech_recognition": false, - "voice_reply_voice": false, - "conversation_max_tokens": 1000, - "expires_in_seconds": 3600, - "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。" -} - + "open_ai_api_key": "YOUR API KEY", + "model": "gpt-3.5-turbo", + "proxy": "", + "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": ["画", "看", "找"], + "speech_recognition": false, + "voice_reply_voice": false, + "conversation_max_tokens": 1000, + "expires_in_seconds": 3600, + "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。" +} \ No newline at end of file diff --git a/plugins/role/README.md b/plugins/role/README.md index 4aa5b44..59ddb75 100644 --- a/plugins/role/README.md +++ b/plugins/role/README.md @@ -20,5 +20,5 @@ "descn": "作为一名中文写作改进助理，你的任务是改进所提供文本的拼写、语法、清晰、简洁和整体可读性，同时分解长句，减少重复，并提供改进建议。请只提供文本的更正版本，避免包括解释。请把我之后的每一条消息都当作文本内容。", "wrapper": "内容是:\n\"%s\"", "remark": "最常使用的角色，用于优化文本的语法、清晰度和简洁度，提高可读性。" - }, + } ```