**Table of Content**
- [插件化初衷](#插件化初衷)
- [插件安装方法](#插件安装方法)
- [插件化实现](#插件化实现)
- [插件编写示例](#插件编写示例)
- [插件设计建议](#插件设计建议)
## 插件化初衷
之前未插件化的代码耦合程度高,如果要定制一些个性化功能(如流量控制、接入`NovelAI`画图平台等),需要了解代码主体,避免影响到其他的功能。多个功能同时存在时,无法调整功能的优先级顺序,功能配置项也非常混乱。
此时插件化应声而出。
**插件化**: 在保证主体功能是ChatGPT的前提下,我们推荐将主体功能外的功能利用插件的方式实现。
- [x] 可根据功能需要,下载不同插件。
- [x] 插件开发成本低,仅需了解插件触发事件,并按照插件定义接口编写插件。
- [x] 插件化能够自由开关和调整优先级。
- [x] 每个插件可在插件文件夹内维护独立的配置文件,方便代码的测试和调试,可以在独立的仓库开发插件。
## 插件安装方法
在本仓库中预置了一些插件,如果要安装其他仓库的插件,有两种方法。
- 第一种方法是在将下载的插件文件都解压到"plugins"文件夹的一个单独的文件夹,最终插件的代码都位于"plugins/PLUGIN_NAME/*"中。启动程序后,如果插件的目录结构正确,插件会自动被扫描加载。除此以外,注意你还需要安装文件夹中`requirements.txt`中的依赖。
- 第二种方法是`Godcmd`插件,它是预置的管理员插件,能够让程序在运行时就能安装插件,它能够自动安装依赖。
安装插件的命令是"#installp [仓库源](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/plugins/source.json)记录的插件名/仓库地址"。这是管理员命令,认证方法在[这里](https://github.com/zhayujie/chatgpt-on-wechat/tree/master/plugins/godcmd)。
- 安装[仓库源](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/plugins/source.json)记录的插件:#installp sdwebui
- 安装指定仓库的插件:#installp https://github.com/lanvent/plugin_sdwebui.git
在安装之后,需要执行"#scanp"命令来扫描加载新安装的插件(或者重新启动程序)。
安装插件后需要注意有些插件有自己的配置模板,一般要去掉".template"新建一个配置文件。
## 插件化实现
插件化实现是在收到消息到发送回复的各个步骤之间插入触发事件实现的。
### 消息处理过程
在了解插件触发事件前,首先需要了解程序收到消息到发送回复的整个过程。
插件化版本中,消息处理过程可以分为4个步骤:
```
1.收到消息 ---> 2.产生回复 ---> 3.包装回复 ---> 4.发送回复
```
以下是它们的默认处理逻辑(太长不看,可跳到[插件编写示例](#插件编写示例)):
**注意以下包含的代码是`v1.1.0`中的片段,已过时,只可用于理解事件,最新的默认代码逻辑请参考[chat_channel](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/channel/chat_channel.py)**
#### 1. 收到消息
负责接收用户消息,根据用户的配置,判断本条消息是否触发机器人。如果触发,则会判断该消息的类型(声音、文本、画图命令等),将消息包装成如下的`Context`交付给下一个步骤。
```python
class ContextType (Enum):
TEXT = 1 # 文本消息
VOICE = 2 # 音频消息
IMAGE_CREATE = 3 # 创建图片命令
class Context:
def __init__(self, type : ContextType = None , content = None, kwargs = dict()):
self.type = type
self.content = content
self.kwargs = kwargs
def __getitem__(self, key):
return self.kwargs[key]
```
`Context`中除了存放消息类型和内容外,还存放了一些与会话相关的参数。
例如,当收到用户私聊消息时,会存放以下的会话参数。
```python
context.kwargs = {'isgroup': False, 'msg': msg, 'receiver': other_user_id, 'session_id': other_user_id}
```
- `isgroup`: `Context`是否是群聊消息。
- `msg`: `itchat`中原始的消息对象。
- `receiver`: 需要回复消息的对象ID。
- `session_id`: 会话ID(一般是发送触发bot消息的用户ID,如果在群聊中并且`conf`里设置了`group_chat_in_one_session`,那么此处便是群聊ID)
#### 2. 产生回复
处理消息并产生回复。目前默认处理逻辑是根据`Context`的类型交付给对应的bot,并产生回复`Reply`。 如果本步骤没有产生任何回复,那么会跳过之后的所有步骤。
```python
if context.type == ContextType.TEXT or context.type == ContextType.IMAGE_CREATE:
reply = super().build_reply_content(context.content, context) #文字跟画图交付给chatgpt
elif context.type == ContextType.VOICE: # 声音先进行语音转文字后,修改Context类型为文字后,再交付给chatgpt
cmsg = context['msg']
cmsg.prepare()
file_name = context.content
reply = super().build_voice_to_text(file_name)
if reply.type != ReplyType.ERROR and reply.type != ReplyType.INFO:
context.content = reply.content # 语音转文字后,将文字内容作为新的context
context.type = ContextType.TEXT
reply = super().build_reply_content(context.content, context)
if reply.type == ReplyType.TEXT:
if conf().get('voice_reply_voice'):
reply = super().build_text_to_voice(reply.content)
```
回复`Reply`的定义如下所示,它允许Bot可以回复多类不同的消息。同时也加入了`INFO`和`ERROR`消息类型区分系统提示和系统错误。
```python
class ReplyType(Enum):
TEXT = 1 # 文本
VOICE = 2 # 音频文件
IMAGE = 3 # 图片文件
IMAGE_URL = 4 # 图片URL
INFO = 9
ERROR = 10
class Reply:
def __init__(self, type : ReplyType = None , content = None):
self.type = type
self.content = content
```
#### 3. 装饰回复
根据`Context`和回复`Reply`的类型,对回复的内容进行装饰。目前的装饰有以下两种:
- `TEXT`文本回复:如果这次消息需要的回复是`VOICE`,进行文字转语音回复之后再次装饰。 否则根据是否在群聊中来决定是艾特接收方还是添加回复的前缀。
- `INFO`或`ERROR`类型,会在消息前添加对应的系统提示字样。
如下是默认逻辑的代码:
```python
if reply.type == ReplyType.TEXT:
reply_text = reply.content
if context.get('desire_rtype') == ReplyType.VOICE:
reply = super().build_text_to_voice(reply.content)
return self._decorate_reply(context, reply)
if context['isgroup']:
reply_text = '@' + context['msg'].actual_user_nickname + ' ' + reply_text.strip()
reply_text = conf().get("group_chat_reply_prefix", "")+reply_text
else:
reply_text = conf().get("single_chat_reply_prefix", "")+reply_text
reply.content = reply_text
elif reply.type == ReplyType.ERROR or reply.type == ReplyType.INFO:
reply.content = str(reply.type)+":\n" + reply.content
```
#### 4. 发送回复
根据`Reply`的类型,默认逻辑调用不同的发送函数发送回复给接收方`context["receiver"]`。
### 插件触发事件
主程序目前会在各个消息步骤间触发事件,监听相应事件的插件会按照优先级,顺序调用事件处理函数。
目前支持三类触发事件:
```
1.收到消息
---> `ON_HANDLE_CONTEXT`
2.产生回复
---> `ON_DECORATE_REPLY`
3.装饰回复
---> `ON_SEND_REPLY`
4.发送回复
```
触发事件会产生事件的上下文`EventContext`,它包含了以下信息:
`EventContext(Event事件�
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
【项目资源】: 包含前端、后端、移动开发、操作系统、人工智能、物联网、信息化管理、数据库、硬件开发、大数据、课程资源、音视频、网站开发等各种技术项目的源码。 包括STM32、ESP8266、PHP、QT、Linux、iOS、C++、Java、python、web、C#、EDA、proteus、RTOS等项目的源码。 【项目质量】: 所有源码都经过严格测试,可以直接运行。 功能在确认正常工作后才上传。 【适用人群】: 适用于希望学习不同技术领域的小白或进阶学习者。 可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。 【附加价值】: 项目具有较高的学习借鉴价值,也可直接拿来修改复刻。 对于有一定基础或热衷于研究的人来说,可以在这些基础代码上进行修改和扩展,实现其他功能。 【沟通交流】: 有任何使用上的问题,欢迎随时与博主沟通,博主会及时解答。 鼓励下载和使用,并欢迎大家互相学习,共同进步。
资源推荐
资源详情
资源评论
收起资源包目录
基于gpt的企业微信机器人.zip (160个子文件)
Dockerfile.alpine 1KB
Dockerfile.alpine 391B
Dockerfile.debian 1KB
Dockerfile.debian 441B
image-create-sample.jpg 382KB
group-chat-sample.jpg 326KB
single-chat-sample.jpg 180KB
planet.jpg 33KB
roles.json 37KB
config-template.json 1KB
config.json 967B
plugins.json 810B
source.json 430B
config.json 45B
config.json 26B
config.json 21B
Dockerfile.latest 1020B
Dockerfile.alpine.latest 814B
LICENSE 1KB
run.log 71KB
tool.log 11KB
Makefile 482B
README.md 12KB
README.md 7KB
README.md 6KB
README.md 4KB
README.md 3KB
README.md 2KB
README.md 959B
README.md 907B
README.md 696B
README.md 308B
README.md 294B
README.md 5B
Name 27B
nohup.out 0B
user_datas.pkl 2KB
aigcopen.png 51KB
test-keyword.png 12KB
messages.py 22KB
messages.py 22KB
contact.py 21KB
contact.py 20KB
core.py 20KB
godcmd.py 18KB
login.py 17KB
chat_channel.py 17KB
login.py 16KB
plugin_manager.py 13KB
templates.py 12KB
wechatmp_channel.py 11KB
config.py 10KB
passive_reply.py 10KB
bdunit.py 9KB
chat_gpt_bot.py 9KB
role.py 9KB
wechat_channel.py 8KB
wechatcomapp_channel.py 8KB
WordsSearch.py 8KB
tool.py 7KB
open_ai_bot.py 6KB
utils.py 5KB
wechaty_channel.py 5KB
__init__.py 5KB
dungeon.py 5KB
azure_voice.py 5KB
register.py 4KB
register.py 4KB
wechat_message.py 4KB
hotreload.py 4KB
hotreload.py 4KB
audio_convert.py 4KB
baidu_voice.py 4KB
banwords.py 4KB
wechaty_message.py 4KB
chat_gpt_session.py 4KB
session_manager.py 3KB
active_reply.py 3KB
__init__.py 3KB
hello.py 3KB
terminal_channel.py 3KB
open_ai_session.py 3KB
chat_message.py 3KB
pytts_voice.py 2KB
wechatmp_client.py 2KB
returnvalues.py 2KB
wechatmp_message.py 2KB
keyword.py 2KB
sorted_dict.py 2KB
bridge.py 2KB
wechatcomapp_message.py 2KB
time_check.py 2KB
baidu_translate.py 2KB
open_ai_image.py 2KB
google_voice.py 2KB
event.py 2KB
context.py 2KB
utils.py 1KB
app.py 1KB
token_bucket.py 1KB
共 160 条
- 1
- 2
资源评论
妄北y
- 粉丝: 1w+
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功