ailingbot 0.0.8

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

🇬🇧English 🇨🇳简体中文

---

AilingBot - One-stop solution to empower your IM bot with AI.

Table of Contents

• What is AilingBot
• Features
• Quick Start
  • Start an AI chatbot in 5 minutes
    • Using Docker
    • Using PIP
      • Installation
      • Generate Configuration File
      • Start the Chatbot
  • Start API Service
    • Using Docker
    • Using PIP
      • Installation
      • Generate Configuration File
      • Start the Service
  • Integrating with WeChat Work
    • Using Docker
    • Using PIP
      • Installation
      • Generate Configuration File
      • Modify Configuration File
      • Start the Service
  • Integrating with Feishu
    • Using Docker
    • Using PIP
      • Installation
      • Generate Configuration File
      • Modify Configuration File
      • Start the Service
  • Integrating with DingTalk
    • Using Docker
    • Using PIP
      • Installation
      • Generate Configuration File
      • Modify Configuration File
      • Start the Service
  • Integrating with Slack
    • Using Docker
    • Using PIP
      • Installation
      • Generate Configuration File
      • Modify Configuration File
      • Start the Service
• 📖User Guide
  • Main Process
  • Main Concepts
  • Configuration
    • Configuration Methods
    • Configuration Mapping
    • Configuration Items
      • General
      • Built-in Policy Configuration
        • conversation
        • document_qa
      • Model Configuration
        • OpenAI
  • Command Line Tools
    • Initialize Configuration File (init)
      • Usage
      • Options
    • View Current Configuration (config)
      • Usage
      • Options
    • Start Command Line Bot (chat)
      • Usage
      • Options
    • Start Webhook Service (serve)
      • Usage
      • Options
    • Start API Service (api)
      • Usage
      • Options
  • 🔌API
• 💻Development Guide
  • Development Guidelines
  • Developing Chat Policy
  • Developing Channel
• 🤔Frequently Asked Questions
• 🎯Roadmap

What is AilingBot

AilingBot is an open-source engineering development framework and an all-in-one solution for integrating AI models into IM chatbots. With AilingBot, you can:

• ☕ Code-free usage: Quickly integrate existing AI large-scale models into mainstream IM chatbots (such as WeChat Work, Feishu, DingTalk, Slack etc.) to interact with AI models through IM chatbots and complete business requirements. Currently, AilingBot has built-in capabilities for multi-turn dialogue and document knowledge Q&A, and more capabilities will be added in the future.
• 🛠️Secondary development: AilingBot provides a clear engineering architecture, interface definition, and necessary basic components. You do not need to develop the engineering framework for large-scale model services from scratch. You only need to implement your Chat Policy and complete end-to-end AI model empowerment to IM chatbots through simple configurations. It also supports expanding to your own end (such as your own IM, web application, or mobile application) by developing your own channel.

Features

• 💯 Open source & Free: Completely open source and free.
• 📦 Ready to use: No need for development, with pre-installed capabilities to integrate with existing mainstream IM and AI models.
• 🔗 LangChain Friendly: Easy to integrate with LangChain.
• 🧩 Modular: The project is organized in a modular way, with modules dependent on each other through abstract protocols. Modules of the same type can be implemented by implementing the protocol, allowing for plug-and-play.
• 💻 Extensible: AilingBot can be extended to new usage scenarios and capabilities. For example, integrating with new IMs, new AI models, or customizing your own chat policy.
• 🔥 High performance: AilingBot uses a coroutine-based asynchronous mode to improve system concurrency performance. At the same time, system concurrency processing capabilities can be further improved through multi-processes.
• 🔌 API Integration: AilingBot provides a set of clear API interfaces for easy integration and collaboration with other systems and processes.

🚀 Quick Start

Start an AI chatbot in 5 minutes

Below is a guide on how to quickly start an AI chatbot based on the command-line interface using AilingBot. The effect is shown in the following figure:

💡 First, you need to have an OpenAI API key. If you don't have one, refer to relevant materials on the Internet to obtain it.

Using Docker

git clone https://github.com/ericzhang-cn/ailingbot.git ailingbot
cd ailingbot
docker build -t ailingbot .
docker run -it --rm \
  -e  AILINGBOT_POLICY__LLM__OPENAI_API_KEY={your OpenAI API key} \
  ailingbot poetry run ailingbot chat

Using PIP

Installation

pip install ailingbot

Generate Configuration File

ailingbot init --silence --overwrite

This will create a file called settings.toml in the current directory, which is the configuration file for AilingBot. Next, modify the necessary configurations. To start the bot, only one configuration is needed. Find the following section in settings.toml:

[policy.llm]
_type = "openai"
model_name = "gpt-3.5-turbo"
openai_api_key = ""
temperature = 0

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

Start the Chatbot

Start the chatbot with the following command:

ailingbot chat

Start API Service

Using Docker

git clone https://github.com/ericzhang-cn/ailingbot.git ailingbot
cd ailingbot
docker build -t ailingbot .
docker run -it --rm \
  -e  AILINGBOT_POLICY__LLM__OPENAI_API_KEY={your OpenAI API key} \
  ailingbot poetry run ailingbot api

Using PIP

Installation

pip install ailingbot

Generate Configuration File

Same as starting the command line bot.

Start the Service

Start the bot using the following command:

ailingbot api

Now, enter http://localhost:8080/docs in your browser to see the API documentation. (If it is not a local start, please enter http://{your public IP}:8080/docs)

Here is an example request:

curl -X 'POST' \
  'http://localhost:8080/chat/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "text": "你好"
}'

And the response:

{
  "type": "text",
  "conversation_id": "default_conversation",
  "uuid": "afb35218-2978-404a-ab39-72a9db6f303b",
  "ack_uuid": "3f09933c-e577-49a5-8f56-fa328daa136f",
  "receiver_id": "anonymous",
  "scope": "user",
  "meta": {},
  "echo": {},
  "text": "你好！很高兴和你聊天。有什么我可以帮助你的吗？",
  "reason": null,
  "suggestion": null
}

Integrating with WeChat Work

Here's a guide on how to quickly integrate the chatbot with WeChat Work.

Using Docker

git clone https://github.com/ericzhang-cn/ailingbot.git ailingbot
cd ailingbot
docker build -t ailingbot .
docker run -d \
-e AILINGBOT_POLICY__NAME=conversation \
-e AILINGBOT_POLICY__HISTORY_SIZE=5 \
-e AILINGBOT_POLICY__LLM__OPENAI_API_KEY={your OpenAI API key
} \
-e AILINGBOT_CHANNEL__NAME=wechatwork \
-e AILINGBOT_CHANNEL__CORPID={your WeChat Work robot's corpid} \
-e AILINGBOT_CHANNEL__CORPSECRET={
your WeChat Work robot's corpsecret} \
-e AILINGBOT_CHANNEL__AGENTID={your WeChat Work robot's agentid} \
-e AILINGBOT_CHANNEL__TOKEN={
your WeChat Work robot's webhook token} \
-e AILINGBOT_CHANNEL__AES_KEY={your WeChat Work robot's webhook aes_key} \
-p 8080: 8080
ailingbot poetry run ailingbot serve

Using PIP

Installation

pip install ailingbot

Generate Configuration File

ailingbot init --silence --overwrite

Modify Configuration File

Open settings.toml, and fill in the following section with your WeChat Work robot's real information:

[channel]
name = "wechatwork"
corpid = "" # Fill in with real information
corpsecret = "" # Fill in with real information
agentid = 0 # Fill in with real information
token = "" # Fill in with real information
aes_key = "" # Fill in with real information

In the llm section, fill in your OpenAI API Key:

[policy.llm]
_type = "openai"
model_name = "gpt-3.5-turbo"
openai_api_key = "" # Fill in with your real OpenAI API Key here
temperature = 0

Start the Service

ailingbot serve

Finally, we need to go to the WeChat Work admin 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 chatbot in WeChat Work and start chatting:

Integrating with Feishu

Here's a guide on how to quickly integrate the chatbot with Feishu and enable a new conversation policy: uploading documents and performing knowledge-based question answering on them.

Using Docker

git clone https://github.com/ericzhang-cn/ailingbot.git ailingbot
cd ailingbot
docker build -t ailingbot .
docker run -d \
  -e AILINGBOT_POLICY__NAME=document_qa \
  -e AILINGBOT_POLICY__CHUNK_SIZE=1000 \
  -e AILINGBOT_POLICY__CHUNK_OVERLAP=0 \
  -e AILINGBOT_POLICY__LLM__OPENAI_API_KEY={your OpenAI API key} \
  -e AILINGBOT_POLICY__LLM__MODEL_NAME=gpt-3.5-turbo-16k \
  -e AILINGBOT_CHANNEL__NAME=feishu \
  -e AILINGBOT_CHANNEL__APP_ID={your Feishu robot's app id} \
  -e AILINGBOT_CHANNEL__APP_SECRET={your Feishu robot's app secret} \
  -e AILINGBOT_CHANNEL__VERIFICATION_TOKEN={your Feishu robot's webhook verification token} \
  -p 8080:8080
  ailingbot poetry run ailingbot serve

Using PIP

Installation

pip install ailingbot

Generate Configuration File

ailingbot init --silence --overwrite

Modify Configuration File

Open settings.toml, and change the channel section to the following, filling in your Feishu robot's real information:

[channel]
name = "feishu"
app_id = "" # Fill in with real information
app_secret = "" # Fill in with real information
verification_token = "" # Fill in with real information

Replace the policy section with the following document QA policy:

[policy]
name = "document_qa"
chunk_size = 1000
chunk_overlap = 5

Finally, it is recommended to use the 16k model when using the document QA policy. Therefore, change policy.llm.model_name to the following configuration:

[policy.llm]
_type = "openai"
model_name = "gpt-3.5-turbo-16k" # Change to gpt-3.5-turbo-16k
openai_api_key = "" # Fill in with real information
temperature = 0

Start the Service

ailingbot serve

Finally, we need to go to the Feishu admin console to configure the webhook address. The webhook URL for Feishu is: http(s)://your_public_IP:8080/webhook/feishu/event/

After completing the above configuration, you can find the chatbot in Feishu and start chatting:

Integrating with DingTalk

Here's a guide on how to quickly integrate the chatbot with DingTalk.

Using Docker

git clone https://github.com/ericzhang-cn/ailingbot.git ailingbot
cd ailingbot
docker build -t ailingbot .
docker run -d \
  -e AILINGBOT_POLICY__NAME=conversation \
  -e AILINGBOT_POLICY__HISTORY_SIZE=5 \
  -e AILINGBOT_POLICY__LLM__OPENAI_API_KEY={your OpenAI API key} \
  -e AILINGBOT_CHANNEL__NAME=dingtalk \
  -e AILINGBOT_CHANNEL__APP_KEY={your DingTalk robot's app key} \
  -e AILINGBOT_CHANNEL__APP_SECRET={your DingTalk robot's app secret} \
  -e AILINGBOT_CHANNEL__ROBOT_CODE={your DingTalk robot's robot code} \
  -p 8080:8080
  ailingbot poetry run ailingbot serve

Using PIP

Installation

pip install ailingbot

Generate Configuration File

ailingbot init --silence --overwrite

Modify Configuration File

Open settings.toml, and change the channel section to the following, filling in your DingTalk robot's real information:

[channel]
name = "dingtalk"
app_key = "" # Fill in with real information
app_secret = "" # Fill in with real information
robot_code = "" # Fill in with real information

Start the Service

ailingbot serve

Finally, we need to go to the DingTalk admin console to configure the webhook address. The webhook URL for DingTalk is: http(s)://your_public_IP:8080/webhook/dingtalk/event/

After completing the above configuration, you can find the chatbot in DingTalk and start chatting:

Integrating with Slack

Here's a guide on how to quickly integrate the chatbot with Slack and enable a new conversation policy: uploading documents and performing knowledge-based question answering on them.

Using Docker

git clone https://github.com/ericzhang-cn/ailingbot.git ailingbot
cd ailingbot
docker build -t ailingbot .
docker run -d \
  -e AILINGBOT_POLICY__NAME=document_qa \
  -e AILINGBOT_POLICY__CHUNK_SIZE=1000 \
  -e AILINGBOT_POLICY__CHUNK_OVERLAP=0 \
  -e AILINGBOT_POLICY__LLM__OPENAI_API_KEY={your OpenAI API key} \
  -e AILINGBOT_POLICY__LLM__MODEL_NAME=gpt-3.5-turbo-16k \
  -e AILINGBOT_CHANNEL__NAME=slack \
  -e AILINGBOT_CHANNEL__VERIFICATION_TOKEN={your Slack App webhook verification token} \
  -e AILINGBOT_CHANNEL__OAUTH_TOKEN={your Slack App oauth token} \
  -p 8080:8080
  ailingbot poetry run ailingbot serve

Using PIP

Installation

pip install ailingbot

Generate Configuration File

ailingbot init --silence --overwrite

Modify Configuration File

Open settings.toml, and change the channel section to the following, filling in your Slack robot's real information:

[channel]
name = "slack"
verification_token = "" # Fill in with real information
oauth_token = "" # Fill in with real information

Replace the policy section with the following document QA policy:

[policy]
name = "document_qa"
chunk_size = 1000
chunk_overlap = 5

Finally, it is recommended to use the 16k model when using the document QA policy. Therefore, change policy.llm.model_name to the following configuration:

[policy.llm]
_type = "openai"
model_name = "gpt-3.5-turbo-16k" # Change to gpt-3.5-turbo-16k
openai_api_key = "" # Fill in with real information
temperature = 0

Start the Service

ailingbot serve

Finally, we need to go to the Slack admin console to configure the webhook address. The webhook URL for Slack is: http(s)://your_public_IP:8080/webhook/slack/event/

After completing the above configuration, you can find the chatbot in Slack and start chatting:

📖User Guide

Main Process

The main processing flow of AilingBot is as follows:

1. First, the user sends a message to the IM bot.
2. If a webhook is configured, the instant messaging tool will forward the request sent to the bot to the webhook service address.
3. The webhook service processes the original IM message and converts it into AilingBot's internal message format, which is then sent to ChatBot.
4. ChatBot processes the request and forms a response message based on the configured chat policy. During this process, ChatBot may perform operations such as requesting a large language model, accessing a vector database, or calling an external API to complete the request processing.
5. ChatBot sends the response message to the IM Agent. The IM Agent is responsible for converting the AilingBot internal response message format into a specific IM format and calling the IM open capability API to send the response message.
6. The IM bot displays the message to the user, completing the entire processing process.

Main Concepts

• IM bot: A capability built into most instant messaging tools that allows administrators to create a bot and process user messages through a program.
• Channel: A channel represents different terminals, which can be an IM or a custom terminal (such as the web).
• Webhook: An HTTP(S) service used to receive user messages forwarded by IM bots. Different channels have their own specifications for webhooks, so each channel requires its own webhook implementation.
• IM Agent: Used to call IM open capability APIs. Different IM open capability APIs are different, so each channel requires a corresponding agent implementation.
• ChatBot: The core component used to receive and respond to user messages.
• Chat Policy: Defines how to respond to users and is called by ChatBot. A chat policy specifically defines the robot's abilities, such as chitchat or knowledge Q&A.
• LLM: Large language model, such as OpenAI's ChatGPT and open ChatGLM, are all different large language models. The large language model is a key component for implementing AI capabilities.

Configuration

Configuration Methods

AilingBot can be configured in two ways:

• Using configuration files: AilingBot reads settings.toml in the current directory as the configuration file in TOML format. Please refer to the following section for specific configuration items.
• Using environment variables: AilingBot also reads configuration items in environment variables. Please refer to the following section for a list of environment variables.

💡 Both configuration files and environment variables can be used together. If a configuration item exists in both, the environment variable takes precedence.

Configuration Mapping

All configurations have the following mappings between TOML keys and environment variables:

• All environment variables start with AILINGBOT_.
• Double underscores __ are used as separators between levels.
• Underscores in configuration keys are preserved in environment variables.
• Case-insensitive.

For example:

• The corresponding environment variable of some_conf is AILINGBOT_SOME_CONF.
• The corresponding environment variable of some_conf.conf_1 is AILINGBOT_SOME_CONF__CONF_1.
• The corresponding environment variable of some_conf.conf_1.subconf is AILINGBOT_SOME_CONF__CONF_1__SUBCONF.

Configuration Items

General

Configuration Item	Description	TOML	Environment Variable
Language	Language code (Reference: http://www.lingoes.net/en/translator/langcode.htm)	lang	AILINGBOT_LANG
Timezone	Timezone code (Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)	tz	AILINGBOT_TZ
Policy Name	Predefined policy name or complete policy class path	policy.name	AILINGBOT_POLICY__NAME
Channel Name	Predefined channel name	channel.name	AILINGBOT_CHANNEL__NAME
Webhook Path	Complete class path of non-predefined channel webhook	channel.webhook_name	AILINGBOT_CHANNEL__WEBHOOK_NAME
Agent Path	Complete class path of non-predefined channel agent	channel.agent_name	AILINGBOT_CHANNEL__AGENT_NAME
Uvicorn Config	All uvicorn configurations (Reference: uvicorn settings). These configurations will be passed to uvicorn	uvicorn.*	AILINGBOT_UVICORN__*

Configuration example:

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

[policy]
name = "conversation"
# More policy configurations

[channel]
name = "wechatwork"
# More channel configurations

[uvicorn]
host = "0.0.0.0"
port = 8080

Built-in Policy Configuration

conversation

Conversation uses LangChain's Conversation as the policy, which enables direct interaction with LLM and has a conversation history context, enabling multi-turn conversations.

Configuration Item	Description	TOML	Environment Variable
History Size	Indicates how many rounds of historical conversations to keep	policy.history_size	AILINGBOT_POLICY__HISTORY_SIZE

Configuration example:

# Use the conversation policy and keep 5 rounds of historical conversations
[policy]
name = "conversation"
history_size = 5

document_qa

Document_qa uses LangChain's Stuff as the policy. Users can upload a document and then ask questions based on the document content.

Configuration Item	Description	TOML	Environment Variable
Chunk Size	Corresponds to LangChain Splitter's chunk_size	policy.chunk_size	AILINGBOT_POLICY__CHUNK_SIZE
Chunk Overlap	Corresponds to LangChain Splitter's chunk_overlap	policy.chunk_overlap	AILINGBOT_POLICY__CHUNK_OVERLAP

Configuration example:

# Use the document_qa policy, with chunk_size and chunk_overlap set to 1000 and 0, respectively
[policy]
name = "document_qa"
chunk_size = 1000
chunk_overlap = 0

Model Configuration

The model configuration is consistent with LangChain. The following is an example.

OpenAI

[policy.llm]
_type = "openai" # Corresponding environment variable: AILINGBOT_POLICY__LLM___TYPE
model_name = "gpt-3.5-turbo" # Corresponding environment variable: AILINGBOT_POLICY__LLM__MODEL_NAME
openai_api_key = "sk-pd8I'm sorry, it seems like your message got cut off. Can you please provide me with more information or clarify your request?

Command Line Tools

Initialize Configuration File (init)

Usage

The init command generates a configuration file settings.toml in the current directory. By default, the user will be prompted interactively. You can use the --silence option to generate the configuration file directly using default settings.

Usage: ailingbot init [OPTIONS]

Initialize the AilingBot environment.

Options:
--silence    Without asking the user.
--overwrite  Overwrite existing file if a file with the same name already
exists.
--help       Show this message and exit.

Options

Option	Description	Type	Remarks
--silence	Generate the default configuration directly without asking the user.	Flag
--overwrite	Allow overwriting the settings.toml file in the current directory.	Flag

View Current Configuration (config)

The config command reads the current environment configuration (including the configuration file and environment variables) and merges them.

Usage

Usage: ailingbot config [OPTIONS]

  Show current configuration information.

Options:
  -k, --config-key TEXT  Configuration key.
  --help                 Show this message and exit.

Options

Option	Description	Type	Remarks
-k, --config-key	Configuration key	String	If not passed, the complete configuration information will be displayed.

Start Command Line Bot (chat)

The chat command starts an interactive command-line bot for testing the current chat policy.

Usage

Usage: ailingbot chat [OPTIONS]

  Start an interactive bot conversation environment.

Options:
  --debug  Enable debug mode.
  --help   Show this message and exit.

Options

Option	Description	Type	Remarks
--debug	Enable debug mode	Flag	The debug mode will output more information, such as the prompt.

Start Webhook Service (serve)

The serve command starts a Webhook HTTP server for interacting with specific IM.

Usage

Usage: ailingbot serve [OPTIONS]

  Run webhook server to receive events.

Options:
  --log-level [TRACE|DEBUG|INFO|SUCCESS|WARNING|ERROR|CRITICAL]
                                  The minimum severity level from which logged
                                  messages should be sent to(read from
                                  environment variable AILINGBOT_LOG_LEVEL if
                                  is not passed into).  [default: TRACE]
  --log-file TEXT                 STDOUT, STDERR, or file path(read from
                                  environment variable AILINGBOT_LOG_FILE if
                                  is not passed into).  [default: STDERR]
  --help                          Show this message and exit.

Options

Option	Description	Type	Remarks
--log-level	The minimum severity level from which logged messages should be sent to.	String	By default, all log levels will be displayed (TRACE).
--log-file	The location where logs are output.	String	By default, logs will be output to standard error (STDERR).

Start API Service (api)

The api command starts the API HTTP server.

Usage

Usage: ailingbot api [OPTIONS]

Run endpoint server.

Options:
  --log-level [TRACE|DEBUG|INFO|SUCCESS|WARNING|ERROR|CRITICAL]
                                  The minimum severity level from which logged
                                  messages should be sent to(read from
                                  environment variable AILINGBOT_LOG_LEVEL if
                                  is not passed into).  [default: TRACE]
  --log-file TEXT                 STDOUT, STDERR, or file path(read from
                                  environment variable AILINGBOT_LOG_FILE if
                                  is not passed into).  [default: STDERR]
  --help                          Show this message and exit.

Options

Option	Description	Type	Remarks
--log-level	Display log level, which will display logs at this level and above	String	By default, all levels are displayed (TRACE)
--log-file	Log output location	String	By default, logs are printed to standard error (STDERR)

🔌API

TBD

💻Development Guide

Development Guidelines

TBD

Developing Chat Policy

TBD

Developing Channel

TBD

🤔Frequently Asked Questions

• Due to the fact that WeChat Work does not support uploading file event callbacks, the built-in document_qa policy cannot be used for WeChat Work.
• The webhook of each IM requires a public IP. If you do not have one, you can consider testing locally through the " intranet penetration" solution. Please refer to online resources for specific methods.
• We expect the chat policy to be stateless, and the state should be stored externally. However, in specific implementations, the policy may still have local states (such as storing conversation history in local variables). Therefore, when uvicorn has multiple worker processes, these local states cannot be shared because each process has a separate chat policy instance, and a request from the same user may be responded to by different workers, leading to unexpected behavior. To avoid this, please ensure that at least one of the following two conditions is met:
  • Chat policy does not use local states.
  • Only one uvicorn worker is started.

🎯Roadmap

• Provide complete usage and developer documentation.
• Support more channels.
  • WeChat Work
  • Feishu
  • DingTalk
  • Slack
• Support more request message types.
  • Text request
  • Image request
  • File request
• Support more response message types.
  • Text response
  • Image response
  • File response
  • Markdown response
  • Table response
• Develop more out-of-the-box chat policies.
  • Multi-round conversation policy
  • Document question and answer policy
  • Database question and answer policy
  • Online search question and answer policy
• Support calling standalone chat policy services through HTTP.
• Abstract basic components
  • Large language model
  • Knowledge base
  • Tools
• Support local model deployment.
  • ChatGLM-6B
• Support API.
• Web management background and visual configuration management.
• Provide deployment capability based on Docker containers.
• Enhance the observability and controllability of the system.
• Complete test cases.