ZikeQuote3

✨ 一个 LLM 介入的群聊语录插件 ✨

📖 介绍

ZikeQuote3 基于 NoneBot2 开发，便于群聊语录自动收集与管理，支持通过 LLM 自动收集群聊消息作为语录、手动管理语录、以及多种方式查看等功能。

🗒️ 功能

🤖 智能收集

• 自动收集: 持续监听群聊消息，达到消息量阈值自动触发筛选。
• LLM 集成: LLM 自动分析消息历史，根据指导提取群友语录并生成简短评论。

👨‍💻 手动管理

• 手动管理: 支持通过命令增删查改。
• 语录评论: 对已有语录添加评论，丰富内容。

🎨 展示查询

• 随机语录: 支持不同算法模式下的随机语录推荐，同时允许多种筛选推荐，支持图像和文字。
• 语录搜索: 可搜索罗列筛选语录。
• 语录排行: 统计成员语录数量，生成图片排行榜。
• 语录列表: 展示查看用户语录列表。

📊 插件配置

• 群粒度控制: 支持精细到群粒度的语录插件配置。
• 动态更新: 支持热调整配置与热重载配置，灵活方便。

⚙️ 权限控制

• 灵活强大: 基于 nonebot-plugin-access-control 的权限控制，全面精确。

🔧 安装

1. 确保您已经安装了 NoneBot2，然后安装插件本体

   手动安装

   下载该仓库后，进入命令行并使用

    poetry install
   

   以安装 pyproject.toml 中的依赖

   使用 nb-cli 安装

   在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-zikequote3
   

   使用包管理器安装

   在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

   pip

    pip install nonebot-plugin-zikequote3
   

   uv (推荐插件管理器)

    uv add nonebot-plugin-zikequote3
   

   poetry

    poetry add nonebot-plugin-zikequote3
   

   conda

    conda install nonebot-plugin-zikequote3
   

   如果不使用 nb cli 安装，需要打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入

    ```toml
    plugins = ["nonebot-plugin-zikequote3"]
    ```
   

2. 推荐安装权限控制主插件 nonebot-plugin-access-control，然后设置默认权限

   权限控制主插件安装方式

   与常规插件安装方式类似，例如

    pip install nonebot-plugin-access-control
   

   问题排除

   - 如遇到新版 nonebot 启动后 `FakeIO` 报错 `expected str instance, bytes found`，可通过命令 `nb orm --upgrade` 升级权限插件的 orm 数据库后端后重新启动
   配置权限

   可以参照其文档对本插件进行权限配置，具体配置项可见本插件文档或本插件根目录下的 `nonebot_plugin_zikequote3\services\permission_management\permission_node_definition.py`

3. 截图相关插件调整

   问题排除

   如果出现报错如“找不到浏览器”等，可以在配置中指定 `htmlrender_browser_channel = "msedge"` 指定使用系统浏览器

4. 创建文件 llm_services/api_key 配置 LLM API Key，可修改 llm_services/client.py 使用自定义客户端、模型与自定义参数

5. (可选) 创建文件 utils/sentry_dsn 可配置 Sentry 异常报错捕获平台的 dsn

⚙ 配置

插件的配置项位于 config.toml 文件中，部分设置支持动态修改

🎉 使用

插件主要命令：

• /语录rank: 查看语录排行榜。
• (回复消息) /加语录: 添加语录。
• (回复语录) /删语录 或 /删语录 语录ID: 删除语录 (TODO)。
• (回复语录) 评价内容: 评论语录。
• /删评论 评论ID: 删除评论 (TODO)。
• /语录 [关键词]: 随机获取一条语录，可按关键词筛选。
• /语录卡 [关键词]: 生成语录卡片图片，可按关键词筛选。
• /语录图 [关键词]: 随机抽取一张语录图片，可按附带语录信息的关键词筛选。
• /语录列表 [用户名] 或 /语录列表 @用户: 查看某个用户的语录列表。
• /查语录 关键词: 搜索包含指定关键词的语录，可指定正则等选项。
• /查看语录配置: 查看本群的语录配置情况

🖼️ 更新日志

docs/CHANGELOG.md

🤺 隐私告知与考量

本插件涉及用户聊天记录的收集和分析。部署者是数据控制者，有责任遵守当地法律法规，并尊重群成员的隐私。建议部署者在使用前向群成员进行充分告知。