These docs are for version 1.x of Rasa Open Source.
[Docs for the new version 2.0 can be found here.](/content/docs/rasa/index.html)

## User Guide

- [Installation](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/installation/)
- [Tutorial: Rasa Basics](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/rasa-tutorial/)
- [Tutorial: Building Assistants](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/building-assistants/)
- [Command Line Interface](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/command-line-interface/)
- [Architecture](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/architecture/)
- [Messaging and Voice Channels](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/messaging-and-voice-channels/)
- [Testing Your Assistant](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/testing-your-assistant/)
- [Setting up CI/CD](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/setting-up-ci-cd/)
- [Validate Data](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/validate-files/)
- [Configuring the HTTP API](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/configuring-http-api/)
- [Deploying Your Rasa Assistant](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/how-to-deploy/)
- [Cloud Storage](https://legacy-docs-v1.rasa.com/1.10.6/user-guide/cloud-storage/)

## NLU

- [About](https://legacy-docs-v1.rasa.com/1.10.6/nlu/about/)
- [Using NLU Only](https://legacy-docs-v1.rasa.com/1.10.6/nlu/using-nlu-only/)
- [Training Data Format](https://legacy-docs-v1.rasa.com/1.10.6/nlu/training-data-format/)
- [Language Support](https://legacy-docs-v1.rasa.com/1.10.6/nlu/language-support/)
- [Choosing a Pipeline](https://legacy-docs-v1.rasa.com/1.10.6/nlu/choosing-a-pipeline/)
- [Components](https://legacy-docs-v1.rasa.com/1.10.6/nlu/components/)
- [Entity Extraction](https://legacy-docs-v1.rasa.com/1.10.6/nlu/entity-extraction/)

## Core

- [About](https://legacy-docs-v1.rasa.com/1.10.6/core/about/)
- [Stories](https://legacy-docs-v1.rasa.com/1.10.6/core/stories/)
- [Domains](https://legacy-docs-v1.rasa.com/1.10.6/core/domains/)
- [Responses](https://legacy-docs-v1.rasa.com/1.10.6/core/responses/)
- [Actions](https://legacy-docs-v1.rasa.com/1.10.6/core/actions/)
- [Reminders and External Events](https://legacy-docs-v1.rasa.com/1.10.6/core/reminders-and-external-events/)
- [Policies](https://legacy-docs-v1.rasa.com/1.10.6/core/policies/)
- [Slots](https://legacy-docs-v1.rasa.com/1.10.6/core/slots/)
- [Forms](https://legacy-docs-v1.rasa.com/1.10.6/core/forms/)
- [Retrieval Actions](https://legacy-docs-v1.rasa.com/1.10.6/core/retrieval-actions/)
- [Interactive Learning](https://legacy-docs-v1.rasa.com/1.10.6/core/interactive-learning/)
- [Fallback Actions](https://legacy-docs-v1.rasa.com/1.10.6/core/fallback-actions/)
- [Knowledge Base Actions](https://legacy-docs-v1.rasa.com/1.10.6/core/knowledge-bases/)

## Conversation Design

- [Dialogue Elements](https://legacy-docs-v1.rasa.com/1.10.6/dialogue-elements/dialogue-elements/)
- [Small Talk](https://legacy-docs-v1.rasa.com/1.10.6/dialogue-elements/small-talk/)
- [Completing Tasks](https://legacy-docs-v1.rasa.com/1.10.6/dialogue-elements/completing-tasks/)
- [Guiding Users](https://legacy-docs-v1.rasa.com/1.10.6/dialogue-elements/guiding-users/)

## API Reference

- [Action Server](https://legacy-docs-v1.rasa.com/1.10.6/api/action-server/)
- [HTTP API](https://legacy-docs-v1.rasa.com/1.10.6/api/http-api/)
- [Jupyter Notebooks](https://legacy-docs-v1.rasa.com/1.10.6/api/jupyter-notebooks/)
- [Agent](https://legacy-docs-v1.rasa.com/1.10.6/api/agent/)
- [Custom NLU Components](https://legacy-docs-v1.rasa.com/1.10.6/api/custom-nlu-components/)
- [Rasa SDK](https://legacy-docs-v1.rasa.com/1.10.6/api/rasa-sdk/#)
- [Events](https://legacy-docs-v1.rasa.com/1.10.6/api/events/)
- [Tracker](https://legacy-docs-v1.rasa.com/1.10.6/api/tracker/)
- [Tracker Stores](https://legacy-docs-v1.rasa.com/1.10.6/api/tracker-stores/)
- [Event Brokers](https://legacy-docs-v1.rasa.com/1.10.6/api/event-brokers/)
- [Lock Stores](https://legacy-docs-v1.rasa.com/1.10.6/api/lock-stores/)
- [Training Data Importers](https://legacy-docs-v1.rasa.com/1.10.6/api/training-data-importers/)
- [Featurization of Conversations](https://legacy-docs-v1.rasa.com/1.10.6/api/core-featurization/)
- [TensorFlow Configuration](https://legacy-docs-v1.rasa.com/1.10.6/api/tensorflow_usage/)
- [Migration Guide](https://legacy-docs-v1.rasa.com/1.10.6/migration-guide/)
- [Rasa Open Source Change Log](https://legacy-docs-v1.rasa.com/1.10.6/changelog/)

## Migrate from (beta)

- [Dialogflow](https://legacy-docs-v1.rasa.com/1.10.6/migrate-from/google-dialogflow-to-rasa/)
- [Wit.ai](https://legacy-docs-v1.rasa.com/1.10.6/migrate-from/facebook-wit-ai-to-rasa/)
- [LUIS](https://legacy-docs-v1.rasa.com/1.10.6/migrate-from/microsoft-luis-to-rasa/)
- [IBM Watson](https://legacy-docs-v1.rasa.com/1.10.6/migrate-from/ibm-watson-to-rasa/)

## Reference

- [Glossary](https://legacy-docs-v1.rasa.com/1.10.6/glossary/)

## Versions

viewing: 1.10.6

## Rasa SDK

Rasa SDK provides the tools you need to write custom actions in python.

### Installation

Use `pip` to install `rasa-sdk` on your action server.
```bash
pip install rasa-sdk
```
Note
You do not need to install `rasa` for your action server. E.g. if you are running Rasa in a docker container, it is recommended to create a separate container for your action server. In this separate container, you only need to install `rasa-sdk`.

### Running the Action Server

If you have `rasa` installed, run this command to start your action server:
```bash
rasa run actions
```
Otherwise, if you do not have `rasa` installed, run this command:
```bash
python -m rasa_sdk --actions actions
```
You can verify that the action server is up and running with the command:
```bash
curl http://localhost:5055/health
```
You can get the list of registered custom actions with the command:
```bash
curl http://localhost:5055/actions
```
The file that contains your custom actions should be called `actions.py`. Alternatively, you can use a package directory called `actions` or else manually specify an actions module or package with the `--actions` flag.

### Actions

The `Action` class is the base class for any custom action. It has two methods that both need to be overwritten, `name()` and `run()`.

In a restaurant bot, if the user says “show me a Mexican restaurant”, your bot could execute the action `ActionCheckRestaurants`, which might look like this:
```python
from rasa_sdk import Action
from rasa_sdk.events import SlotSet

class ActionCheckRestaurants(Action):
   def name(self) -> Text:
      return "action_check_restaurants"

def run(self,
           dispatcher: CollectingDispatcher,
           tracker: Tracker,
           domain: Dict[Text, Any]) -> List[Dict[Text, Any]]:

cuisine = tracker.get_slot('cuisine')
      q = "select * from restaurants where cuisine='{0}' limit 1".format(cuisine)
      result = db.query(q)

return [SlotSet("matches", result if result is not None else [])]
```
You should add the action name `action_check_restaurants` to the actions in your domain file. The action’s `run()` method receives three arguments. You can access the values of slots and the latest message sent by the user using the `tracker` object, and you can send messages back to the user with the `dispatcher` object, by calling `dispatcher.utter_message`.

### Tracker

The `rasa_sdk.Tracker` lets you access the bot’s memory in your custom actions. You can get information about past events and the current state of the conversation through `Tracker` attributes and methods.

The following are available as attributes of a `Tracker` object:
- `sender_id` - The unique ID of person talking to the bot.
- `slots` - The list of slots that can be filled as defined in the domains.
- `latest_message` - A dictionary containing the attributes of the latest message: `intent`, `entities` and `text`.
- `events` - A list of all previous events.
- `active_form` - The name of the currently active form.
- `latest_action_name` - The name of the last action the bot executed.
