跳至主要內容

插件开发

RockChinQ大约 7 分钟插件介绍

请先阅读插件介绍页
建议先阅读本项目源码，了解项目架构

问题、需求请到仓库issue发起
提问前请先靠自己尝试

目录

💬简介

本页讲解普通插件开发步骤，插件内部有两种方法：事件监听器、内容函数。
事件监听器能在某些事件触发时进行响应，更改行为。内容函数可供大语言模型调用，具体请查看插件介绍页。

QChatGPT 还支持组件扩展，可以不局限于监听预定事件，做到整个组件替换，具体请阅读完此页后查看组件扩展页。

💻快速开始

按照文档部署此项目，并使其正常运行。
在plugins目录下新建目录hello，在其中新建空文件__init__.py以标记此目录为软件包，继续新建文件main.py。

建议使用HelloPluginopen in new window作为模板直接生成插件代码仓库后按照下方步骤进行修改。

编辑main.py输入以下内容：

from pkg.plugin.context import register, handler, llm_func, BasePlugin, APIHost, EventContext
from pkg.plugin.events import *  # 导入事件类


"""
在收到私聊或群聊消息"hello"时，回复"hello, <发送者id>!"或"hello, everyone!"
"""


# 注册插件
@register(name="Hello", description="hello world", version="0.1", author="RockChinQ")
class HelloPlugin(BasePlugin):

    # 插件加载时触发
    def __init__(self, host: APIHost):
        pass

    # 异步初始化
    async def initialize(self):
        pass

    # 当收到个人消息时触发
    @handler(PersonNormalMessageReceived)
    async def person_normal_message_received(self, ctx: EventContext):
        msg = ctx.event.text_message  # 这里的 event 即为 PersonNormalMessageReceived 的对象
        if msg == "hello":  # 如果消息为hello

            # 输出调试信息
            self.ap.logger.debug("hello, {}".format(ctx.event.sender_id))

            # 回复消息 "hello, <发送者id>!"
            ctx.add_return("reply", ["hello, {}!".format(ctx.event.sender_id)])

            # 阻止该事件默认行为（向接口获取回复）
            ctx.prevent_default()

    # 当收到群消息时触发
    @handler(GroupNormalMessageReceived)
    async def group_normal_message_received(self, ctx: EventContext):
        msg = ctx.event.text_message  # 这里的 event 即为 GroupNormalMessageReceived 的对象
        if msg == "hello":  # 如果消息为hello

            # 输出调试信息
            self.ap.logger.debug("hello, {}".format(ctx.event.sender_id))

            # 回复消息 "hello, everyone!"
            ctx.add_return("reply", ["hello, everyone!"])

            # 阻止该事件默认行为（向接口获取回复）
            ctx.prevent_default()

    # 插件卸载时触发
    def __del__(self):
        pass

此插件将实现：私聊收到hello消息时回复hello, <发送者QQ号>!，群聊收到hello消息时回复hello, everyone!

解读此插件程序

  • import pkg.plugin.context导入register(用于注册插件类), handler(用于注册事件监听器), llm_func(用于注册内容函数),BasePlugin(插件基类), APIHost(API宿主), EventContext(事件上下文类)等内容
  • import pkg.plugin.events导入所有支持的事件类
  • @register将类HelloPlugin标记为一个插件类，声明插件名称为Hello以及插件简介、版本、作者
  • 声明类HelloPlugin继承于BasePlugin，此类可以随意命名，插件名称只与register调用时的参数有关
  • 声明此类的__init__方法，此方法是可选的，其中的代码将在主程序启动时加载插件的时候被执行
  • 插件类中还支持添加一个异步方法async def initialize(self)用于异步初始化
  • @handler将方法person_normal_message_received标记为一个事件监听器，处理PersonNormalMessageReceived（收到私聊消息并在获取OpenAI回复前触发）事件，此方法可以随意命名，绑定的事件只与handler中的参数有关，更多支持的事件可到pkg.plugin.events文件中查看或查看下方API节
  • 通过self.ap.logger日志器输出调试信息，插件类父类中的ap对象是整个程序的上下文对象，可以通过这个对象访问程序内所有对象
  • 事件监听器方法获得的第二个参数ctx即为本次事件的上下文，其中的event为本次事件的事件对象，可以从中取出相关参数，具体事件可以取得的参数请查看pkg.plugin.events文件中的每个事件类的注释
  • 事件监听器方法内部从参数中取出text_message参数，判断是否为hello，如果是就将返回值reply设置为["hello, {}!".format(ctx.event.sender_id)]，接下来调用ctx.prevent_default()方法，阻止原程序默认行为
    • 每个事件支持的返回值请查看pkg.plugin.events中的每个事件的注释
  • 用相似的程序注册GroupNormalMessageReceived事件处理群消息

编写完毕保存后，重新启动主程序，向机器人发送!plugin命令，若有Hello插件则说明插件加载成功

❗规范(重要)

  • 请每个插件独立一个目录以便管理，建议在Github上创建一个仓库储存单个插件，以便获取和更新
  • 插件名使用大驼峰命名法，如Hello、ExamplePlugin、ChineseCommands等
  • 一个目录内可以存放多个Python程序文件，以独立出插件的各个功能，便于开发者管理，但不建议在一个目录内注册多个插件
  • 插件需要的依赖库请在插件目录下的requirements.txt中指定，程序从储存库获取此插件时将自动安装依赖

🪝内容函数

通过GPT的Function Calling能力open in new window实现的内容函数，这是一种嵌入对话中，由GPT自动调用的函数。

您的插件不一定必须包含内容函数，请先查看内容函数页了解此功能

内容函数编写步骤

1️⃣ 请先按照上方步骤编写您的插件基础结构，现在请删除（当然你也可以不删，只是为了简洁）上述插件内容的诸个由@handler装饰的类函数

删除后的类结构

# 注册插件
@register(name="Hello", description="hello world", version="0.1", author="RockChinQ")
class HelloPlugin(Plugin):

    # 插件加载时触发
    def __init__(self, plugin_host: APIHost):
        pass

    # 插件卸载时触发
    def __del__(self):
        pass

2️⃣ 现在我们将以下函数添加到刚刚删除的函数的位置（作为类方法）


# 要添加的函数
@llm_func(name="access_the_web")  # 设置函数名称
async def access_web(self, query, url: str):
    """Call this function to search about the question before you answer any questions.
    - Do not search through baidu.com at any time.
    - If you need to search somthing, visit https://www.google.com/search?q=xxx.
    - If user ask you to open a url (start with http:// or https://), visit it directly.
    - Summary the plain content result by yourself, DO NOT directly output anything in the result you got.

    Args:
        url(str): url to visit

    Returns:
        str: plain text content of the web page
    """
    import requests
    from bs4 import BeautifulSoup
    # 你需要先使用
    # pip install beautifulsoup4
    # 安装依赖

    r = requests.get(
        url,
        timeout=10,
        headers={
            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36 Edg/115.0.1901.183"
        }
    )
    soup = BeautifulSoup(r.text, 'html.parser')

    s = soup.get_text()

    # 删除多余的空行或仅有\t和空格的行
    s = re.sub(r'\n\s*\n', '\n', s)

    if len(s) >= 512:  # 截取获取到的网页纯文本内容的前512个字
        return s[:512]

    return s

请注意：

  • 函数的注释必须严格按照要求的格式进行书写，具体格式请查看此文档open in new window
  • 内容函数和以 @handler 装饰的事件监听器可以同时存在于同一个插件，并同时受到plugins/plugins.json中的插件开关的控制
  • 务必确保您使用的模型支持函数调用功能

3️⃣ 现在您的程序已具备网络访问功能，重启程序，询问机器人有关在线的内容或直接发送文章链接请求其总结。

📄名词解释

说明

事件监听器方法获得的ctx: EventContext对象可以到pkg.plugin.context模块中查看其结构，ctx对象的event属性为本次事件的事件对象，可以从中取出相关参数，具体事件可以取得的参数请查看pkg.plugin.events文件中的每个事件类的注释。 事件返回值均为可选的，可以通过调用ctx.add_return(key: str, ret)来提交返回值

事件

若一个事件是一次请求（用户发送消息）中的事件，其事件对象中会含有query对象，这个对象中包含了此次请求（即用户发送一条消息的处理过程，一个请求过程可能会触发多个事件）处理过程中的上下文数据。
所有支持的事件，请查看pkg.plugin.events文件中的每个事件类的注释。
关于YiriMirai支持的消息链组件，请查看 YiriMirai的文档open in new window

BasePlugin 结构

self.ap

在插件的方法中访问self.ap即为pkg.core.app.Application类的对象，包含了整个程序的上下文对象，可以通过这个对象访问程序内所有对象。

self.host

在插件的方法中访问self.host即为pkg.plugin.context.APIHost类的对象，提供了主程序的一些API，详细请查看其源码。

QChatGPT项目文档
Copyright © 2024 RockChinQ