LiteyukiStudio/nonebot-plugin-marshoai

Fork 0

mirror of https://github.com/LiteyukiStudio/nonebot-plugin-marshoai.git synced 2024-11-30 09:14:52 +08:00

Asankilp aebd6d7780 ✨新增控制加载内置工具包的配置项

2024-11-24 02:05:56 +08:00

8.2 KiB

Raw Blame History

nonebot-plugin-marshoai

✨ 使用 OpenAI 标准格式 API 的聊天机器人插件 ✨

📖 介绍

通过调用 OpenAI 标准格式 API(例如由 Azure OpenAI 驱动，GitHub Models 提供访问的生成式 AI 推理 API) 来实现聊天的插件。
插件内置了猫娘小棉(Marsho)的人物设定，可以进行可爱的聊天！
谁不喜欢回复消息快又可爱的猫娘呢？
对 OneBot 以外的适配器与非 GitHub Models API的支持未经过完全验证。 Melobot 实现

🐱 设定

基本信息

名字：小棉(Marsho)
生日：9月6日

喜好

🌞 晒太阳晒到融化
🤱 撒娇啊～谁不喜欢呢～
🍫 吃零食！肉肉好吃！
🐾 玩！我喜欢和朋友们一起玩！

💿 安装

使用 nb-cli 安装

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

nb plugin install nonebot-plugin-marshoai

使用包管理器安装

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

pip

pip install nonebot-plugin-marshoai

pdm

pdm add nonebot-plugin-marshoai

poetry

poetry add nonebot-plugin-marshoai

conda

conda install nonebot-plugin-marshoai

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

plugins = ["nonebot_plugin_marshoai"]

🤖 获取 token(GitHub Models)

新建一个personal access token，不需要给予任何权限。
将新建的 token 复制，添加到.env文件中的marshoai_token配置项中。

🎉 使用

发送marsho指令可以获取使用说明(若在配置中自定义了指令前缀请使用自定义的指令前缀)。

👉 戳一戳

当 nonebot 连接到支持的 OneBot v11 实现端时，可以接收头像双击戳一戳消息并进行响应。详见MARSHOAI_POKE_SUFFIX配置项。

🛠️ 小棉工具

小棉工具(MarshoTools)是v0.5.0版本的新增功能，支持加载外部函数库来为 Marsho 提供 Function Call 功能。使用文档

👍 夸赞名单

夸赞名单存储于插件数据目录下的praises.json里（该目录路径会在 Bot 启动时输出到日志），当配置项为true 时发起一次聊天后自动生成，包含人物名字与人物优点两个基本数据。
存储于其中的人物会被 Marsho “认识”和“喜欢”。
其结构类似于：

{
  "like": [
    {
      "name": "Asankilp",
      "advantages": "赋予了Marsho猫娘人格，使用vim与vscode为Marsho写了许多代码，使Marsho更加可爱"
    },
    {
      "name": "神羽(snowykami)",
      "advantages": "人脉很广，经常找小伙伴们开银趴，很会写后端代码"
    },
    ...
  ]
}

⚙️ 可配置项

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

配置项	必填	默认值	说明
MARSHOAI_TOKEN	是?	无	调用 API 所需的访问 token
MARSHOAI_DEFAULT_NAME	否	`marsho`	调用 Marsho 默认的命令前缀
MARSHOAI_ALIASES	否	`set{"小棉"}`	调用 Marsho 的命令别名
MARSHOAI_DEFAULT_MODEL	否	`gpt-4o-mini`	Marsho 默认调用的模型
MARSHOAI_PROMPT	否	猫娘 Marsho 人设提示词	Marsho 的基本系统提示词 ※部分推理模型(o1等)不支持系统提示词。
MARSHOAI_ADDITIONAL_PROMPT	否	无	Marsho 的扩展系统提示词
MARSHOAI_POKE_SUFFIX	否	`揉了揉你的猫耳`	对 Marsho 所连接的 OneBot 用户进行双击戳一戳时，构建的聊天内容。此配置项为空字符串时，戳一戳响应功能会被禁用。例如，默认值构建的聊天内容将为`*[昵称]揉了揉你的猫耳`。
MARSHOAI_ENABLE_SUPPORT_IMAGE_TIP	否	`true`	启用后用户发送带图请求时若模型不支持图片，则提示用户
MARSHOAI_ENABLE_NICKNAME_TIP	否	`true`	启用后用户未设置昵称时提示用户设置
MARSHOAI_ENABLE_PRAISES	否	`true`	是否启用夸赞名单功能
MARSHOAI_ENABLE_TOOLS	否	`true`	是否启用小棉工具(MarshoTools)
MARSHOAI_LOAD_BUILTIN_TOOLS	否	`true`	是否加载内置工具包
MARSHOAI_AZURE_ENDPOINT	否	`https://models.inference.ai.azure.com`	OpenAI 标准格式 API 端点
MARSHOAI_TEMPERATURE	否	无	进行推理时的温度参数
MARSHOAI_TOP_P	否	无	进行推理时的核采样参数
MARSHOAI_MAX_TOKENS	否	无	返回消息的最大 token 数
MARSHOAI_ADDITIONAL_IMAGE_MODELS	否	`[]`	额外添加的支持图片的模型列表，例如`hunyuan-vision`

❤ 鸣谢&版权说明

"Marsho" logo 由 @Asankilp 绘制，基于 CC BY-NC-SA 4.0 许可下提供。
"nonebot-plugin-marshoai" 基于 MIT 许可下提供。

🕊️ TODO

Melobot 实现
对聊天发起者的认知（认出是谁在问 Marsho）（初步实现）
自定义 API 接入点的适配（不局限于GitHub Models）
上下文通过数据库持久化存储

8.2 KiB Raw Blame History Unescape Escape