Skip to main content
NoneBotPluginLogo

NoneBotPluginText

Nonebot-Plugin-NaiLongRemove

✨ 一个基于 AI 模型的简单插件~ ✨

python pdm-managed
Pydantic Version 1 Or 2 license pypi pypi download
NoneBot Registry Supported Adapters

📖 介绍

声明

本插件仅供娱乐和学习交流。

简介

NaiLongRemove 是一款由简单的 AI 模型建立的奶龙识别插件,可以识别群中的奶龙表情包并撤回该表情。

技术

目前插件支持两种模型,可通过配置文件更换,详见文档下方配置一节。
用户可以根据需要自行选择心仪的模型,两个模型性能都已经经过优化,但仍可能会有不同程度的误差,也欢迎各位继续反馈给我们~

💿 安装

如果你从来没接触过 NoneBot,请查看 这个文档

为避免依赖问题,我们把使用 GPU 推理的插件安装方式与普通安装分开了,供有需要的用户选择安装

使用 CPU 推理

以下提到的方法 任选其一 即可

[推荐] 使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-nailongremove
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-nailongremove
pdm
pdm add nonebot-plugin-nailongremove
poetry
poetry add nonebot-plugin-nailongremove
conda
conda install nonebot-plugin-nailongremove

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分的 plugins 项里追加写入

[tool.nonebot]
plugins = [
    # ...
    "nonebot_plugin_nailongremove"
]

使用 GPU 推理

点击展开

先进入 Bot 虚拟环境(如果有)

安装底包

pip install nonebot-plugin-nailongremove-base

根据你安装的 CUDA 与 CuDNN 版本(如果有装,没有就去装),按照官网说明安装对应版本的以下依赖:

安装完后配置插件使用 CUDA 进行推理

NAILONG_ONNX_PROVIDERS=["CUDAExecutionProvider"]

最后配置让 nonebot2 加载插件
打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分的 plugins 项里追加写入

[tool.nonebot]
plugins = [
    # ...
    "nonebot_plugin_nailongremove"
]

之后更新插件的话,进入虚拟环境只更新底包即可,不要安装及更新不带 base 的包

pip install nonebot-plugin-nailongremove-base -U

⚙️ 配置

在 nonebot2 项目的 .env 文件中添加下表中的必填配置

配置项 必填 默认值 说明
全局配置
PROXY 否 None 下载模型等文件时使用的代理地址
响应配置
NAILONG_BYPASS_SUPERUSER 否 True 是否不检查超级用户发送的图片
NAILONG_BYPASS_ADMIN 否 True 是否不检查群组管理员发送的图片
NAILONG_NEED_ADMIN 否 False 当自身不为群组管理员时是否不检查群内所有图片
NAILONG_LIST_SCENES 否 [] 聊天场景 ID 黑白名单列表
在单级聊天下为该聊天 ID,如 QQ 群号;
在多级聊天下为以 _ 分割的各级聊天 ID,如频道下的子频道或频道下私聊
NAILONG_BLACKLIST 否 True 是否使用黑名单模式
NAILONG_USER_BLACKLIST 否 [] 用户 ID 黑名单列表
NAILONG_PRIORITY 否 100 Matcher 优先级
行为配置
NAILONG_RECALL 否 True 是否撤回消息
NAILONG_MUTE_SECONDS 否 0 设置禁言时间,默认为 0 即不禁言
单位:秒
NAILONG_TIP 否 {"nailong": "本群禁止发奶龙!"} 发送的提示,使用 Alconna 的消息模板,可用变量见下,可以根据标签自定义对应值,如遇其中没有的标签会回退到 nailong
NAILONG_FAILED_TIP 否 {"nailong": "{:Reply($message_id)}呜,不要发奶龙了嘛 🥺 👉👈"} 撤回失败或禁用撤回时发送的提示,同上
NAILONG_CHECK_ALL_FRAMES 否 False 使用模型 1 时是否检查图片中的所有帧,启用该项后消息模板中的 $checked_result 变量当原图为动图时会变为动图
模型通用配置
NAILONG_MODEL_DIR 否 ./data/nailongremove 模型的下载位置
NAILONG_MODEL 否 1 选择需要加载的模型,可用模型见下
NAILONG_AUTO_UPDATE_MODEL 否 True 是否自动更新模型
NAILONG_CONCURRENCY 否 1 当图片为动图时,针对该图片并发识别图片帧的最大并发数
NAILONG_ONNX_PROVIDERS 否 ["CPUExecutionProvider"] 加载 onnx 模型使用的 provider 列表,请参考上方安装文档
模型 1 特定配置
NAILONG_MODEL1_TYPE 否 tiny 模型 1 使用的模型类型,可用 tiny / m
NAILONG_MODEL1_YOLOX_SIZE 否 None 针对模型 1,自定义模型输入可能会有尺寸更改
NAILONG_MODEL1_SCORE 否 {"nailong": 0.5} 模型 1 置信度阈值,范围 0 ~ 1,可以根据标签自定义对应值,设置对应标签的阈值以检测该标签,设为 null 或者不填可以忽略该标签
杂项配置
NAILONG_GITHUB_TOKEN 否 None GitHub Access Token,遇到模型下载或更新问题时可尝试填写

可用模型

消息模板可用变量

变量名 类型 说明
$event Event 当前事件
$target Target 事件目标
$message_id str 消息 ID
$msg UniMessage 当前消息
$ss Session 当前会话
$checked_result Image 框选出对应目标后的图片,仅在模型配置为 1 时存在

🎉 使用

只要有人发奶龙表情包被识别出来,就会被撤回并提醒。

📞 联系

  • Nonebot2 官方交流群:768887710(基础的安装部署问题可在这里询问)
  • 人工智能学习交流群:949992679(学习交流 AI 相关技术可以来这里捏)
  • 机器人插件学习交流群:200980266(机器人 BUG 模型精度等问题反馈来这里哟)

欢迎大家进群一起学习交流~

📝 更新日志

2.3.1

  • 修改插件依赖以避免一些问题,影响了安装过程,请查看安装文档了解
    • 对应配置项修改:删除配置项 NAILONG_ONNX_TRY_TO_USE_GPU,添加配置项 NAILONG_ONNX_PROVIDERS

2.3.0

  • 支持了检查 GIF 中的所有帧并将结果重新封成 GIF,默认禁用,同时弃用 $checked_image 变量,新增 $checked_result 变量
  • 现在模型 1 的输入大小可以根据模型类型自动配置了,但是如果配置项指定了那么会优先使用
  • 支持处理含有其他标签的图片了,部分配置项支持根据标签自定义对应值
  • 增加用户黑名单
  • 默认模型调整至 1

2.2.1

  • 优化模型自动更新(可能是反向优化)

2.2.0

  • 重命名配置项 NAILONG_YOLOX_SIZE -> NAILONG_MODEL1_YOLOX_SIZE
  • 模型 1 现可以自动获取最新版本,也可以通过配置选择要使用的模型类型
  • 模型 1 现可通过配置项控制识别置信度阈值
  • 加载 onnx 模型时会默认尝试使用 GPU,如果失败则会显示一串警告,如果不想看见警告参考上面关闭对应配置

2.1.4

  • 修复 NAILONG_NEED_ADMIN 配置不生效的 Bug

2.1.3

  • 修复忽略群管与超级用户无效的 Bug

2.1.2

  • 重构部分代码,修复潜在 Bug

2.1.1

  • 新增变量 $checked_image

2.1.0

  • 从原仓库下载模型

2.0.0

  • 重构插件,适配多平台
  • 更新了两个新模型,优化了模型精度,用户可自行选择其中之一进行推理
  • 增加了禁言、群黑白名单、可选关闭管理员检测等功能
  • 增加了自动更新模型可选

Metadata

Release files for nonebot-plugin-nailongkiller 2.3.1.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nonebot-plugin-nailongkiller 2.3.1.post1
File Size Uploaded
nonebot_plugin_nailongkiller-2.3.1.post1.tar.gz 6.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nonebot-plugin-nailongkiller 2.3.1.post1
File Interpreter ABI Platform
nonebot_plugin_nailongkiller-2.3.1.post1-py3-none-any.whl Python 3 none any Details

Total release size: 13.2 kB

Release files / nonebot_plugin_nailongkiller-2.3.1.post1.tar.gz

Download URL nonebot_plugin_nailongkiller-2.3.1.post1.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
87edb2128d6d89318228c4c2bbeca5bcd5f2188aedfb6a4888aa987ddedbf2fd
BLAKE2b-256 checksum
How to use checksums
cd266e979cd54a6ae35b9be41ea29face6de4ed06073469383aefe1fdde3ab2a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.20.1 CPython/3.11.9 Darwin/24.0.0

Release files / nonebot_plugin_nailongkiller-2.3.1.post1-py3-none-any.whl

Download URL nonebot_plugin_nailongkiller-2.3.1.post1-py3-none-any.whl
Size 6.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d5f7afcf299252ef53a78f1329d66036a3c56ef175948b1472577897f6ba464
BLAKE2b-256 checksum
How to use checksums
f59d324340302ce09895453503cee0f52dcd20da0ac6b8d4c9fae1c57321e247
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.20.1 CPython/3.11.9 Darwin/24.0.0

Release history Release notifications | RSS feed

This release

2.3.1.post1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page