llmkira 1.0.1

A chain message bot based on OpenAI

---

🍩 Deploy Docs & 🧀 Dev Docs & 🤝 Contribute

Don't hesitate to Star ⭐️, Issue 📝, and PR 🛠️

Python>=3.9

This project uses the ToolCall feature.

It integrates a message queuing and snapshot system, offering plugin mechanisms and authentication prior to plugin execution.

The model adheres to the Openai Schema, other models are not supported. Please adapt using gateways independently.

Demo

🔨 Roadmap

• Removal of legacy code
• Deletion of metric system
• Deletion of model selection system, unified to OpenAI Schema
• Implementation of a more robust plugin system
• Project structure simplification
• Elimination of the Provider system
• Hook support.
• Access to TTS.
• Add LLM reference support to the plugin environment. (extract && search in text)
• Add standalone support for Openai's new Schema. (vision)

📦 Features

• 🍪 A comprehensive plugin development ecosystem, adopting a classic design, and seamless integration with plugins through pip installation
• 📝 Message system with no time or sender constraints, offering fully decoupled logics
• 📬 Offers Login via a URL mechanism, providing a flexible and expandable authentication development solution
• 🍰 Empowers users to authorize plugin execution. Users can configure plugin environment variables at their discretion
• 📦 Support for plugins to access files
• 🍟 Multi-platform support – extend new platforms by inheriting the base class
• 🍔 Plugins can determine their appearance in new sessions dynamically, preventing performance degradation despite large amounts of plugins

🍔 Login Modes

• Login via url: Use /login token$https://provider.com to Login. The program posts the token to the interface to retrieve configuration information
• Login: Use /login https://api.com/v1$key$model to login

🧀 Plugin Previews

Sticker Converter	Timer Function	Translate Function

🎬 Platform Support

Platform	Support	File System	Remarks
Telegram	✅	✅
Discord	✅	✅
Kook	✅	✅	Does not support triggering by reply
Slack	✅	✅	Does not support triggering by reply
QQ	❌
Wechat	❌
Twitter	❌
Matrix	❌
IRC	❌
...			Create Issue/PR

📦 Quick Start

Refer to the 🧀 Deployment Document for more information.

# Install RabbitMQ
docker pull rabbitmq:3.10-management
docker run -d -p 5672:5672 -p 15672:15672 \
  -e RABBITMQ_DEFAULT_USER=admin \
  -e RABBITMQ_DEFAULT_PASS=8a8a8a \
  --hostname myRabbit \
  --name rabbitmq \
  rabbitmq:3.10-management
docker ps -l
# Install Project
pip install pdm
pdm install -G bot
cp .env.exp .env && nano .env
# Test
pdm run python3 start_sender.py
pdm run python3 start_receiver.py
# Host
pdm start pm2.json

🥣 Docker

Build Hub: sudoskys/llmbot

Automatic Docker/Docker-compose Installation

If you are using a brand new server, you can use the following shell to automatically install this project.

This script automatically installs the required services and maps ports using Docker methods. If you have deployed redis, rabbitmq, mongodb, please modify the docker-compose.yml file accordingly.

curl -sSL https://raw.githubusercontent.com/LLMKira/Openaibot/main/deploy.sh | bash

Manual Docker-compose Installation

git clone https://github.com/LlmKira/Openaibot.git
cd Openaibot
cp .env.exp .env&&nano .env
docker-compose -f docker-compose.yml up -d

Update image using docker-compose pull.

Use docker exec -it llmbot /bin/bash to view Shell in Docker, enter exit to exit.

🍪 Slash Commands

clear - Deletes chat records
help - Displays documentation
chat - Conversation
task - Use a function to converse
ask - Disable function-based conversations
tool - Lists all functions
login - Login
auth - Authorize a function
env - Environment variables of the function

💻 How to Develop Plugins?

Refer to the example plugins in the plugins directory and the 🧀 Plugin Development Document for plugin development documentation.

Hooks

Hooks control the EventMessage in sender and receiver. For example, we have voice_hook in built-in hooks.

you can enable it by setting VOICE_REPLY_ME=true in .env.

/env VOICE_REPLY_ME=true
/env REECHO_VOICE_KEY=<key in dev.reecho.ai>

check the source code in llmkira/extra/voice_hook.py, learn to write your own hooks.

🧀 Sponsor

📜 Notice

This project, named OpenAiBot, signifying "Open Artificial Intelligence Robot", is not officially affiliated with OpenAI.