MuiceBot

<div align=center> <img width=200 src="https://bot.snowy.moe/logo.png" alt="image"/> <h1 align="center">MuiceBot</h1> <p align="center">Muice-Chatbot's NoneBot2 Implementation</p> </div> <div align=center> <a href="#关于️"><img src="https://img.shields.io/github/stars/Moemu/MuiceBot" alt="Stars"></a> <a href="https://pypi.org/project/MuiceBot/"><img src="https://img.shields.io/pypi/v/Muicebot" alt="PyPI Version"></a> <a href="https://pypi.org/project/MuiceBot/"><img src="https://img.shields.io/pypi/dm/Muicebot" alt="PyPI Downloads" ></a> <a href="https://nonebot.dev/"><img src="https://img.shields.io/badge/nonebot-2-red" alt="nonebot2"></a> <a href="#"><img src="https://img.shields.io/badge/Code%20Style-Black-121110.svg" alt="codestyle"></a> </div> <div align=center> <a href="#"><img src="https://wakatime.com/badge/user/637d5886-8b47-4b82-9264-3b3b9d6add67/project/a4557f7b-4d26-4105-842a-7a783cbad588.svg" alt="wakatime"></a> <a href="https://www.modelscope.cn/datasets/Moemuu/Muice-Dataset"><img src="https://img.shields.io/badge/ModelScope-Dataset-644cfd?link=https://www.modelscope.cn/datasets/Moemuu/Muice-Dataset" alt="ModelScope"></a> </div> <div align=center> <a href="https://bot.snowy.moe">📃Documentation</a> <a href="https://bot.snowy.moe/guide/setup.html">✨Quick Start</a> <a href="https://github.com/MuikaAI/Muicebot-Plugins-Index">🧩Plugin Store</a> </div> *This project is currently in a slow update state, currently only Bug fixes/accepting external PR activities are carried out, and there are no plans for other functional development* # Introduction✨ > We believe that the creation of AI should be to help humans solve problems better rather than create problems. Therefore, we focus on the ability of large language models to solve practical problems. If the Muice series of projects cannot help us solve daily and emotional problems, the existence of Muice is meaningless. > *———— 《Muice Series Model Evaluation Criteria》* Muicebot is an LLM chatbot based on the Nonebot2 framework, designed to solve real-world problems. Through Muicebot, you can get a chat experience on mainstream chat platforms (such as QQ) that you can only get on web pages. Muicebot has two built-in chat personas named Muice and Monica (the personas are optional) to optimize the dialogue experience. For more information about Muice and Monica, please visit [About Muice](https://bot.snowy.moe/about/Muice) # Features🪄 ✅ Embedded with multiple model loaders, such as [OpenAI](https://platform.openai.com/docs/overview) and [Ollama](https://ollama.com/), which can load most model services or local models on the market, and support multi-modality (image recognition) and tool calling. In addition, a Muice Roleplay fine-tuned model that only calculates 3.9 > 3.11 is included~ ✅ Use `nonebot_plugin_alconna` as a general information interface, which supports most adapters on the market. Special optimizations have been made for some adapters ✅ Supports scheduled tasks based on `nonebot_plugin_apscheduler`, which can interact with large language models or directly send information on a regular basis ✅ Supports several common instructions based on `nonebot_plugin_alconna`. ✅ Save dialogue data based on the ORM layer provided by `nonebot-plugin-orm>=0.7.7`. Then someone will ask: Maintainer, Maintainer, can you implement long-term and short-term memory, LangChain, FairSeq and other memory optimizations? ~~It will be available in the future (~~ ✅ Dynamically generate persona prompts using Jinja2 ✅ Supports calling MCP Server (supports stdio, SSE and Streamable HTTP transmission methods) # Model Loader Compatibility | Model Loader | Streaming Dialogue | Multi-modal Input/Output | Inference Model Calling | Tool Calling | Internet Search | | ----------- | -------- | -------------- | ------------ | -------------------- | -------------------- | | `Azure` | ✅ | 🎶🖼️/❌ | ⭕ | ✅ | ❌ | | `Dashscope` | ✅ | 🎶🖼️/❌ | ✅ | ⭕ | ✅ | | `Gemini` | ✅ | ✅/🖼️ | ⭕ | ✅ | ✅ | | `Ollama` | ✅ | 🖼️/❌ | ✅ | ✅ | ❌ | | `Openai` | ✅ | ✅/🎶 | ✅ | ✅ | ❌ | ✅: Indicates that this loader can well support this function and `MuiceBot` has been implemented ⭕: Indicates that although this loader supports this function, problems may be encountered when using it 🚧: Indicates that although this loader supports this function, `MuiceBot` has not implemented it or is implementing it ❓: Indicates that the Maintainer is not sure whether this loader supports this function, and may need to further read the documentation and check the source code ❌: Indicates that this loader does not support this function Multi-modal tags: 🎶 means audio; 🎞️ means video; 🖼️ means image; 📄 means file; ✅ means full support # Who is this project suitable for? - Developers with experience in writing Python programs - Bot enthusiasts who have built Nonebot projects - AI enthusiasts who want to interact with large language models anytime and anywhere and are looking for a robot framework that can be compatible with most SDKs on the market ~~# TODO📝~~ ~~Recent update roadmap: [MuiceBot Update Plan](https://github.com/users/Moemu/projects/2)~~ # Usage Tutorial💻 Refer to [Documentation](https://bot.snowy.moe) # Plugin Store🧩 [MuikaAI/Muicebot-Plugins-Index](https://github.com/MuikaAI/Muicebot-Plugins-Index) # About🎗️ The output results of the large model will be provided **as is**. Due to complex reasons such as prompt injection attacks, the model may output harmful content. Regardless of the output results of the model, the output results of the model cannot represent the views and positions of the developers. All developers of this project are not responsible for any consequences (including but not limited to robot account bans) that may be indirectly caused by this project. This project is provided under the [BSD 3](https://github.com/Moemu/nonebot-plugin-muice/blob/main/LICENSE) license. Please keep a copy of the license file when redistributing. The project logo uses assets or works from [nonebot/nonebot2](https://github.com/nonebot/nonebot2) and artist [Nakkar](https://www.pixiv.net/users/28246124) [Pixiv works](https://www.pixiv.net/artworks/101063891). If there is any infringement, please contact us in time The BSD 3 license also applies to Muice's system prompts. Muice's text persona or persona image is provided under the terms of the [CC BY NC 3.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.zh-hans) license. This project is based on or references the implementation of some open source projects. We would like to express our gratitude here: - [nonebot/nonebot2](https://github.com/nonebot/nonebot2) The robot framework used in this project - [@botuniverse](https://github.com/botuniverse) Organization responsible for formulating the Onebot standard Thank you to all the developers for their assistance. It can be said that without you, there would be no Muice today: <a href="https://github.com/eryajf/Moemu/MuiceBot/contributors"> <img src="https://contrib.rocks/image?repo=Moemu/MuiceBot" alt="图片加载中..."/> </a> Friendly link: [LiteyukiStudio/nonebot-plugin-marshoai](https://github.com/LiteyukiStudio/nonebot-plugin-marshoai) This project belongs to MuikaAI Original implementation based on OneBot V11: [Moemu/Muice-Chatbot](https://github.com/Moemu/Muice-Chatbot) <a href="https://www.afdian.com/a/Moemu" target="_blank"><img src="https://pic1.afdiancdn.com/static/img/welcome/button-sponsorme.png" alt="afadian" style="height: 45px !important;width: 163px !important;"></a> <a href="https://www.buymeacoffee.com/Moemu" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 45px !important;width: 163px !important;" ></a> Star History： [](https://star-history.com/#Moemu/MuiceBot&Date)