ailingbot 0.0.1

An all-in-one solution to empower your IM bot with LLM.

🇨🇳简体中文

---

AilingBot - An all-in-one solution to empower your IM bot with AI.

Features

• 💯Open source&Free: Completely open source and free.
• 📦Out of the box: No development is required, with pre-built capabilities to integrate with mainstream IM and LLM models.
• 🔗Integrated LangChain: The ability to integrate LangChain allows for the direct use of LangChain's pre-existing chains or agents.
• 🧩Modular: The project is organized in a modular way, with modules depending on abstract protocols, and similar modules implementing the protocols for plug-and-play functionality.
• 💻Extensible: It can expand the usage scenarios and capabilities of AilingBot. For example, integrating with new instant messaging platforms, new language learning models, or developing their own chains, agents, and chat policy.
• 🚀High Performance: AilingBot uses coroutine-based asynchronous mode to improve the system's high-concurrency performance. Meanwhile, the core servers can start multiple processes to further improve the system's high-concurrency processing capabilities.
• 🔌Integrating through API: AilingBot provides a set of clear API interfaces, which facilitates integration and collaboration with other systems and processes.

IM support list

Supported

• WeChat Work
• Feishu

Coming soon

• DingTalk
• Slack

Quickstart Guide

Launch an AI Chatbot in 5 Minutes

Installation

pip install ailingbot

• You also need an OpenAI API key. If you don't have one, please apply for it here: https://platform.openai.com/account/api-keys

Initialize Configuration File

ailingbot init --silence

This will create a file named settings.toml in the current directory, which is the configuration file for AilingBot. Next, modify the necessary configurations. To start the bot, you only need to configure one item. Find the following section in settings.toml:

[policy.args.lc_chain_config.llm]
_type = "openai"
model_name = "gpt-3.5-turbo"
openai_api_key = "Your OpenAI API key"
temperature = 0

Change the value of openai_api_key to your actual OpenAI API key.

Start the Bot

Start the bot with the following command:

ailingbot bot chat -c settings.toml

You can now have a conversation with the bot through an interactive dialogue environment, as shown below:

Connect to Instant Messaging Tools

Below we take WeChat Work as an example to demonstrate how AilingBot can be quickly connected to instant messaging tools.

Prerequisites

To connect to WeChat Work, in addition to the prerequisites above, you also need to install the following environment:

• RabbitMQ: https://www.rabbitmq.com/

• Assumes you already have a usable WeChat Work app and are familiar with the WeChat Work app development process. If you're not familiar with this, please refer to the WeChat Work official developer documentation: https://developer.work.weixin.qq.com/

Modify the configuration file.

Open settings.toml, the complete content is as follows:

# This is the AilingBot configuration file template. Please modify it as needed.

lang = "zh_CN"
tz = "Asia/Shanghai"

[broker]
name = "pika"

[broker.args]
host = "localhost"
port = 5672
user = ""
password = ""
timeout = 5
queue_name_prefix = ""

[policy]
name = "lc_conversation_chain"

[policy.args]

[policy.args.lc_chain_config.llm]
_type = "openai"
model_name = "gpt-3.5-turbo"
openai_api_key = "Your OpenAI API key"
temperature = 0

[channel]

[channel.agent]
name = "wechatwork"

[channel.agent.args]
corpid = "WechatWork corpid"
corpsecret = "WechatWork corpsecret"
agentid = 0

[channel.webhook]
name = "wechatwork"

[channel.webhook.args]
token = "WechatWork webhook token"
aes_key = "WechatWork webhook aes_key"

[channel.uvicorn.args]
host = "0.0.0.0"
port = 8080

Here are the places that need to be filled in as needed:

• openai_api_key = "Your OpenAI API key"
• corpid = "WechatWork corpid"
• corpsecret = "WechatWork corpsecret"
• agentid = 0
• token = "WechatWork webhook token"
• aes_key = "WechatWork webhook aes_key"

Start the Bot

To connect to instant messaging tools, three commands need to be executed to start the corresponding processes separately:

Start the Channel Webhook process. The purpose of this process is to receive messages sent by users to the WeChat Work app as a webhook:

ailingbot channel serve_webhook -c settings.toml

Start the Bot Serve process. The purpose of this process is to listen for user messages received via the webhook and generate reply messages based on the corresponding chat policy:

ailingbot bot serve -c settings.toml

Start the Channel Agent process. The purpose of this process is to send the reply messages generated by the Bot Serve process to the user:

ailingbot channel serve_agent -c settings.toml

Configure Webhook

Finally, we need to go to the WeChat Work management console to configure the webhook address so that WeChat Work knows to forward the received user messages to our webhook. The webhook URL is: http(s)://your_public_IP:8080/webhook/wechatwork/event/

After completing the above configuration, you can find the bot in WeChat Work and start a conversation:

Roadmap

• Provide comprehensive user and developer documentation.
• Support more IM platforms, such as DingTalk and Slack.
• Support more commonly used LLM prompting paradigms and out-of-the-box chat policy.
• Provide support for commonly used capabilities in LLM Chain, such as Vector Embedding&Query and Grounding.
• Provide a WebUI.
• Provide one-click deployment capability based on Docker containers.
• Enhance the system's observability and manageability.

License

MIT License

Copyright (c) 2023 AilingBot

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.