Zoozl services for chatbots
Project description
zoozl
Server for chatbot services
Usage
For basic example a chatbot plugin is provided in zoozl.plugins
package. It is a simple chatbot that allows to play bulls & cows game. It is also a plugin that is loaded in case no configuration file is provided.
Run websocket server
python -m zoozl 1601 --conf chatbot.toml
where 1601
is the port number and chatbot.toml
is optional configuration file.
Architecture
zoozl package contains modules that handle various input interfaces like websocket or http POST and a chatbot interface that must be extended by plugins. Without plugin zoozl is not able to respond to any input. Plugin can be considered as a single chat assistant to handle a specific task. Plugin can be huge and complex or simple and small. It is up to the developer to decide how to structure plugins.
Plugin
Mimimal setup
- Create new toml configuration file (e.g. myconfig.toml)
extensions = ['my_plugin_module']
- Make sure
my_plugin_module
is importable from within python that will run zoozl server - Create file
my_plugin_module.py
from zoozl.chatbot import Interface
class MyPlugin(Interface):
aliases = ("call myplugin",)
def consume(self, context: , package: Package):
package.callback("Hello this is my plugin response")
- Start zoozl server with your configuration file and asking to bot
call myplugin
it will respondHello this is my plugin response
python -m zoozl 1601 --conf myconfig.toml
Plugin interface
Plugin must implement consume
method that takes two arguments context
and package
. context
is a dictionary that contains information about the current chatbot state and package
is a Package
object that contains input message and callback method to send response back to the user.
Plugin may define aliases
attribute that is a tuple of strings that are used to call the plugin. If aliases
is not defined, plugin will not be called. Aliases are like commands that user can call to interact with the plugin, however those commands are constructed as embeddings and then compared with input message embeddings to find the best match.
Special aliases are help, cancel and greet. Help aliases is used when there is no matching aliases found in plugins, cancel alias is used to cancel current conversation and release it from current plugin handling, greet alias is called immediately before any user message is handled.
If there is only one plugin expected, then aliases most likely should contain all three special aliases, thus plugin will be as soon as connection is made and everytime user asks anything.
Configuration file
Configuration file must conform to TOML format. Example of configuration:
extensions = ["chatbot_fifa_extension", "zoozl.plugins.greeter"]
websocket_port = 80 # if not provided, server will not listen to websocket requests
author = "my_chatbot_name" # default is zoozl
[chatbot_fifa_extension] # would be considered as specific configuration for plugin
database_path = "tests/tmp"
administrator = "admin"
Root objects like author, extensions are configuration options for chatbot system wide setup, you can pass unlimited objects in configuration, however suggested is to add a component for each plugin and separate those within components.
- TODO: Describe plugin interface and creation
- TODO: Add authentication and authorization interaction between chatbot and plugin
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file zoozl-0.1.4.tar.gz
.
File metadata
- Download URL: zoozl-0.1.4.tar.gz
- Upload date:
- Size: 17.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1019b90435b9008f96f0fb466eb2ee165f69aa6b1d555f94129376c7b39a86a8 |
|
MD5 | bc80648885447db9946ce713946621ee |
|
BLAKE2b-256 | 93646bb18bcfc845790620d3de66d595586db3f2ba60b559cd17d98efc145617 |
File details
Details for the file zoozl-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: zoozl-0.1.4-py3-none-any.whl
- Upload date:
- Size: 19.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97c0a9b4d3de0f93081c91bc62391ae66675643ea217a557225e809aa08fb87e |
|
MD5 | e360029dd4b51a57cf69bf43e062ca5f |
|
BLAKE2b-256 | e2d204e30a3de2f0e8cab307aecc9fa2cb0e09e6d009e3929903f12b5fce4dc0 |