nonebot_plugin_suggarchat 1.13

Plugin for the Suggar chat framework compatible with Nonebot2.

SuggarChat OpenAI协议聊天插件

Chat plugin for Nonebot2 with Onebot V11 adapter.

描述

适用于Nonebot2的Onebot V11 适配器的LLM聊天插件

目录

• 温馨提示
• 特性
• 安装方式
• 配置文件
• 提示词设置
• 模型预设
• 预设使用方法
• 指令
• 实验功能
• 交流/反馈

温馨提示

可能会与其他插件冲突，比如导致指令无法触发，我的设计目的只是为了一个纯粹的聊天机器人，问题请提交到ISSUE。

Issue不用模板一律不看！

本插件更面向于有Nonebot2基础或插件开发者以及有LLM API开发/使用经验的用户！

不推荐直接调用resources.py的方法，而是通过插件API进行调用。

---

传入LLM的信息格式如下，请自行在提示词内做好处理，便于LLM理解（这里我提供了use_base_prompt选项，如果启用了可以忽略，这个选项将自动在你的prompt前插入内容，对消息段作出解释）：

不会写就来QQ群问群主吧（

点击查看详细格式

可解析的消息段：文字，at，合并转发

---

at+文字：

你好世界@Somebody

合并转发（暂不支持解析嵌套的合并转发消息）：

\（合并转发
[YYYY-MM-DD hh:mm:ss PM/AM][昵称(QQ号)]说：<内容>
[[YYYY-MM-DD hh:mm:ss PM/AM][昵称(QQ号)]说：<内容>]
）\
......以此类推

---

私聊普通消息：

[YYYY-MM-DD weekday hh:mm:ss AM/PM]用户昵称（QQ号）：<内容>

私聊引用消息：

私聊普通消息格式+ （（（引用的消息）））：引用消息内其他消息段解析后内容

私聊合并转发消息：

私聊普通消息格式+合并转发消息格式

---

聊群普通消息：

[管理员/群主/自己/群员][YYYY-MM-DD weekday hh:mm:ss AM/PM][昵称（QQ号）]说:<内容>

聊群引用消息：

聊群普通消息格式+ （（（引用的消息）））：引用消息内其他消息段解析后内容

聊群合并转发消息：

聊群普通消息格式+合并转发消息格式

---

戳一戳消息：

\(戳一戳消息\) 昵称(QQ:qq号) 戳了戳你

对于源码

警告！本插件源码可能含有以下内容

点我开始赤史

《三角形具有稳定性》

if:
    if:
        if:
            if:
            else:
        else:
    else:
else:

《无意义分支》

if a:do()
else:pass

《如判断》

if True:
    todo()
#或者说
while True:
    todo()
    break

特性

• OpenAI API 支持
• QQ群组聊天支持
• QQ私聊支持
• 群组AT触发
• API 开放
• 戳一戳消息触发支持
• 多模型切换选择
• 不同群内自定义聊天开关
• 不同聊群可设置的自定义补充Prompt
• 向超控（特定聊群）推送插件的错误日志
• 自定义Bot消息被撤回时缓解尴尬的推送
• 合并转发/引用消息解析支持（只会解析纯文本/at消息段，如果您不理解这是什么意思，你可以理解为丢给LLM的信息只有"@a 你好"这样的格式，会在下文介绍提及）
• “伪人模式”-聊群自动随机概率回复功能
• 会话控制

安装方式

1. 通过NB-CLI安装（推荐）

nb plugin install nonebot-plugin-suggarchat

2. 通过pip安装 确保已安装Python（版本>=3.9）。 打开命令行工具，执行以下命令来安装插件：

pip install nonebot-plugin-suggarchat

3. 通过PDM安装

pdm add nonebot-plugin-suggarchat

以上方法需要在你的pyproject.toml中的plugins列表添加如下内容：

plugins=["nonebot_plugin_suggarchat"]
#添加"nonebot_plugin_suggarchat"

此外，如果你创建了虚拟环境，并且使用2,3方法安装，请额外使用pipenv shell进入虚拟环境再进行安装，否则插件将会安装在你的系统Python环境中。

配置文件

• 配置文件路径： 将在插件启动时在控制台输出。

配置项说明

点此展开

配置项	类型	默认值	解释
memory_length_limit	int	50	单会话允许存储的最大消息数（如果您不知道这是什么意思，请不要修改）
enable	bool	false	是否启用聊天机器人（即该插件）
poke_reply	bool	true	是否启用戳一戳回复功能
enable_group_chat	bool	true	是否启用群聊功能
enable_private_chat	bool	true	是否启用私聊功能
allow_custom_prompt	bool	true	是否允许自定义提示
allow_send_to_admin	bool	true	是否允许向管理员发送消息
admin_group	int	0	管理员群组的ID
admins	list[int]	[]	管理员用户的列表
open_ai_base_url	string	""	OpenAI协议 API URL
use_env_api_key	bool	False	是否使用环境变量中的API密钥（如果启用将忽略open_ai_api_key项）
open_ai_api_key	string	""	OpenAI协议 API 密钥
say_after_self_msg_be_deleted	bool	true	自己的消息被删除后是否回复
group_added_msg	string	"你好，我是Suggar，欢迎使用Suggar的AI聊天机器人，你可以向我提问任何问题，我会尽力回答你的问题，如果你需要帮助，你可以向我发送“帮助”"	加入群组时发送的欢迎消息
send_msg_after_be_invited	bool	true	被邀请进群后是否发送消息
after_deleted_say_what	list[str]	[ "Suggar说错什么话了吗～下次我会注意的呢～", "抱歉啦，不小心说错啦～", ... ]	消息被删除后随机回复的内容
use_base_prompt	bool	true	是否使用基本提示词（即让LLM理解消息段解析）
preset	string	main	是否使用预设（在控制台打印的models文件夹下，预设json格式参考下文（你的预设名不能设为__main__）午）
max_tokens	int	100	在单次时，LLM最多可以回复多少个token（即字数，如果你的模型提供商支持
model	str	auto	使用什么模型（具体看你的API提供商
parse_segments	bool	true	是否解析消息段，此权重覆盖use_base_prompt（即at/合并转发等）
fake_people	bool	true	是否启用自动回复模式
probability	int	10	随机回复的概率(1%~100%)
keyword	str	"at"	触发bot对话关键词,at为to_me,其他为以这个词开头必定回复
nature_chat_style	bool	false	启用更加自然的聊天风格
matcher_function	bool	false	启用matcher,当这一项启用,SuggaeMatcher将会运行（这是一个实验性的功能）。
session_control	bool	false	启用会话控制机制（根据设定的会话时间差自动裁切上下文，如果超时则裁切上下文并询问是否继续对话）
session_control_time	int	60	会话控制时间间隔（单位：分钟）
session_control_history	int	10	储存的会话历史最大条数

提示词

提示词位于将在控制台打印的config文件夹，分别为prompt_group.txt与prompt_private.txt，分别对应群聊和私聊的提示词。

模型预设

预设文件位于将在控制台打印的models文件夹下，预设文件为json格式，具体格式如下：

    {
    "model":"auto",
    "name":"",
    "base_url":"",
    "api_key":""
    }

解释：

• model: 使用的模型，默认为auto，即自动选择。
• name: 预设的名字，用于在插件中选择使用。
• base_url: OpenAI协议 API URL，默认为空。
• api_key: OpenAI协议 API 密钥，默认为空。

预设使用方法

1. 在控制台打印的models文件夹下，创建一个json文件，文件名必须与预设的名字一致。
2. 在json文件中，填写预设的内容。
3. 在插件配置文件中，将preset的值设置为预设的名字（我们更推荐你使用指令来切换而不是直接修改配置文件）。

指令使用方法

指令	参数	解释
/聊天菜单 或 /chat_menu:	无	显示聊天菜单
/del_memory, /失忆, /删除记忆, /删除历史消息, /删除回忆	无	删除群/私聊会话聊天上下文
/enable_chat 或 /启用聊天	无	启用聊天功能
/disable_chat 或 /禁用聊天	无	禁用聊天功能
/prompt	--(show) 展示当前提示词，--(clear) 清空当前prompt，--(set) <文字>则设置提示词	设置或查看当前自定义提示词（适用于用户自定义补充提示词）
/presets	无	查看可用的预设列表
/set_preset 或 /设置预设 或 /设置模型预设	<预设名>	设置当前使用的预设
/sessions	无	查看历史会话列表（显示编号、消息片段和时间戳）
/sessions	set <编号> 用指定编号的历史会话覆盖当前记忆 del <编号> 删除指定编号的历史会话 archive 将当前会话归档到历史记录中，并清空当前聊天上下文 clear 清空所有历史会话记录	会话控制管理指令

隐藏指令

隐藏指令

为什么会有？因为开发者为了DEBUG，会保留一些在开发过程中测试的指令，如果您只是普通用户，请忽略，也不推荐您去使用这些指令 主要是写的垃圾 。

指令	参数	解释
/debug	无	显示调试信息并推送

实验功能

• 事件循环套事件循环？实现了一个简单的Matcher功能，可以注册处理器函数，并进行额外处理。

展开查看示例代码

from nonebot.plugin import require
require("nonebot_plugin_suggarchat")
# 先require再import!!!
from nonebot_plugin_suggarchat.on_event import on_chat
from nonebot_plugin_suggarchat.event import ChatEvent
from nonebot import logger
@on_chat().handle()
async def _(event:ChatEvent):
    logger.info("收到聊天事件!")
    logger.info(event)

• 会话控制（在配置文件中设置，详情见配置文件部分）

讨论

QQ 交流群: 链接