This release is a pre-release and may not be stable for production use.
Maxbot
Maxbot is an open source library and framework for creating conversational apps.
Features (work in progress)
- Unified and extendable messaging over any platform.
- Integration with external libraries and NLU services. Support for active learning.
- DSL for declarative dialog description based on ready-made models of conversational logic.
- An engine for creating your own dialog models.
- NLG command language and templates.
- Implementing business logic in a general-purpose programming language.
- Tracking dialog. Sessions. Dialog state. Error handling and recovery.
- Complex bots with multiple skills. Interaction of skills.
- Developing, debugging, testing and logging tools.
- Deployment in any environment: stand-alone, cloud-enabled, hosted. Scaling.
- Integration with external data sources, services, information systems and support services.
- Business analytics. Insights.
Maxbot is the right balance of simplicity and flexibility based on time-tested solutions.
Documentation
| Documentation | |
|---|---|
| Getting Started | Here's everything you need to know! |
| Design Guides | An introduction to the basics of building dialogues. |
| Tutorials | Using examples to understand how to work. |
| Complex Samples | Advanced demonstration of the system's capabilities. |
| Complete documentation | Complete product information. Design concepts and more. |
Install Maxbot
For detailed installation instructions, see the documentation.
- Operating system: macOS / OS X · Linux
- Python version: Python 3.9 (only 64 bit)
- Package managers: pip
Pip
Using pip, Maxbot releases are available as source packages and binary wheels.
Before you install Maxbot and its dependencies, make sure that
your pip and wheel are up to date.
When using pip it is generally recommended to install packages in a virtual environment to avoid modifying system state:
python -m venv .env
source .env/bin/activate
pip install -U pip wheel
pip install maxbot
Quick Start
For detailed installation instructions, see the documentation.
First, we configure channels. Channels are a way to integrate your bot with various messaging platforms.
You must configure at least one channel to create a bot. The telegram channel is configured by specifying secret api_token for the telegram bot.
Telegram channel is the best choice for a quick start because it's easy to run right on your laptop. Telegram Bot API allows you to receive incoming updates via long polling, so you don't need to have an external IP and set up webhooks.
Save the bot scenario as bot.yaml or something similar.
channels:
telegram:
api_token: 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw
intents:
- name: greetings
examples:
- Good morning
- Hello
- Hi
- name: ending
examples:
- Goodbye
- Bye
- See you
dialog:
- condition: intents.greetings
response: |
Good day to you!
- condition: intents.ending
response: |
OK. See you later.
- condition: true
response: |
Sorry I don't understand.
Run the MaxBot CLI app passing the path to the bot.yaml as a parameter.
$ maxbot run --bot bot.yaml
✓ Started polling updater... Press 'Ctrl-C' to exit.
Open your bot in telegram messenger and greet it.
- Type
Hello. You will see the appropriate response: "Good day to you." - Type
byeand the bot will reply "OK. See you later." - Enter a message unknown to the bot,
How are you?Get a response: "Sorry I don't understand."
The output in your console will look like this
[01/27/23 23:06:44], telegram#123456789
🧑 Hello
🤖 Good day to you!
[01/27/23 23:06:48], telegram#123456789
🧑 bye
🤖 OK. See you later.
[01/27/23 23:07:03], telegram#123456789
🧑 How are you?
🤖 Sorry I don't understand.
Press Ctrl-C to exit MaxBot CLI app.
Congratulations! You have successfully created and launched a simple bot and chatted with it.
Where to ask questions
The Maxbot project is maintained by the Maxbot team.
| Type | Platforms |
|---|---|
| Usage Questions | GitHub Discussions · Stack Overflow |
| Bug Reports | GitHub Issue Tracker |
| Feature Requests | GitHub Discussions |
The near future
- Integration of deterministic dialog models (Dialog Tree, Slot Filling) with large language models (LLM) such as ChatGPT, LLaMA, etc.
- Improved debugging and logging tools.
- Switch from Markdown to command language (XML-based) in bot response scripts.
- Improved built-in date and time extensions.
- Released new examples of using the library to create complex bots.
- Support for Python 3.10, 3.11.
Metadata
Release files for Maxbot 0.1.0b2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| maxbot-0.1.0b2-py3-none-any.whl | Python 3 | none | any | Details for maxbot-0.1.0b2-py3-none-any.whl |
Release files / maxbot-0.1.0b2-py3-none-any.whl
| Download URL | maxbot-0.1.0b2-py3-none-any.whl |
|---|---|
| Size | 91.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
48ff9fa98b20ca8dc3c5ad554d8e0bad57d6efafba12e89fcc97ced56f8f27f5
|
|
BLAKE2b-256 checksum How to use checksums |
e62bb030c614f2a196892e088386f2e66314ee5e9213e97456dfff25c039a9a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.9.16 Darwin/22.4.0
|
Security for Maxbot 0.1.0b2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.