Python SDK for the development of custom actions for Rasa.
To install the SDK run
pip install rasa-sdk
|SDK version||compatible Rasa version|
|SDK version||compatible Rasa Core version|
Detailed instructions can be found in the Rasa Documentation about Custom Actions.
In order to start an action server using implemented custom actions,
you can use the available Docker image
Before starting the action server ensure that the folder containing
your actions is handled as Python module and therefore has to contain
a file called
Then start the action server using:
docker run -p 5055:5055 --mount type=bind,source=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions \ rasa/rasa-sdk:<version>
The action server is then available at
To add custom dependencies you enhance the given Docker image, e.g.:
# Extend the official Rasa SDK image FROM rasa/rasa-sdk:<version> # Change back to root user to install dependencies USER root # To install system dependencies RUN apt-get update -qq && \ apt-get install -y <NAME_OF_REQUIRED_PACKAGE> && \ apt-get clean && \ rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* # To install packages from PyPI RUN pip install --no-cache-dir <A_REQUIRED_PACKAGE_ON_PYPI> # Switch back to non-root to run code USER 1001
Rasa SDK uses Poetry for packaging and dependency management. If you want to build it from source, you have to install Poetry first. This is how it can be done:
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3
There are several other ways to install Poetry. Please, follow the official guide to see all possible options.
To install dependencies and
rasa-sdk itself in editable mode execute
To ensure a standardized code style we use the formatter black. If your code is not formatted properly, GitHub CI will fail to build.
If you want to automatically format your code on every commit, you can use pre-commit.
Just install it via
pip install pre-commit and execute
To check and reformat files execute
Releasing a new version is quite simple, as the packages are build and distributed by GitHub Actions.
mainin case of a major / minor, the current release branch for patch releases).
mainor release branches), e.g. using
GitHub Actions will build this tag and push a package to pypi.
git tag 1.2.0 -m "next release" git push origin 1.2.0
git checkout -b 1.2.x git push origin 1.2.x
Licensed under the Apache License, Version 2.0. Copyright 2021 Rasa Technologies GmbH. Copy of the license.
A list of the Licenses of the dependencies of the project can be found at the bottom of the Libraries Summary.