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.7.3/user-guide/installation/)
- [Tutorial: Rasa Basics](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/rasa-tutorial/)
- [Tutorial: Building Assistants](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/building-assistants/)
- [Command Line Interface](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/command-line-interface/)
- [Architecture](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/architecture/)
- [Messaging and Voice Channels](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/messaging-and-voice-channels/)
- [Evaluating Models](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/evaluating-models/)
- [Validate Data](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/validate-files/)
- [Configuring the HTTP API](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/configuring-http-api/)
- [Deploying your Rasa Assistant](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/how-to-deploy/)
- [Cloud Storage](https://legacy-docs-v1.rasa.com/1.7.3/user-guide/cloud-storage/)

# NLU

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

# Core

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

# Conversation Design

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

# API Reference

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

# Migrate from (beta)

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

# Reference

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

# Versions

viewing: 1.7.3

# Tags

[1.10.26](https://legacy-docs-v1.rasa.com/1.10.26/api/agent/) [1.10.25](https://legacy-docs-v1.rasa.com/1.10.25/api/agent/) [1.10.24](https://legacy-docs-v1.rasa.com/1.10.24/api/agent/) [1.10.23](https://legacy-docs-v1.rasa.com/1.10.23/api/agent/) [1.10.22](https://legacy-docs-v1.rasa.com/1.10.22/api/agent/) [1.10.21](https://legacy-docs-v1.rasa.com/1.10.21/api/agent/) [1.10.20](https://legacy-docs-v1.rasa.com/1.10.20/api/agent/) [1.10.19](https://legacy-docs-v1.rasa.com/1.10.19/api/agent/) [1.10.18](https://legacy-docs-v1.rasa.com/1.10.18/api/agent/) [1.10.17](https://legacy-docs-v1.rasa.com/1.10.17/api/agent/) [1.10.16](https://legacy-docs-v1.rasa.com/1.10.16/api/agent/) [1.10.15](https://legacy-docs-v1.rasa.com/1.10.15/api/agent/) [1.10.14](https://legacy-docs-v1.rasa.com/1.10.14/api/agent/) [1.10.13](https://legacy-docs-v1.rasa.com/1.10.13/api/agent/) [1.10.12](https://legacy-docs-v1.rasa.com/1.10.12/api/agent/) [1.10.11](https://legacy-docs-v1.rasa.com/1.10.11/api/agent/) [1.10.10](https://legacy-docs-v1.rasa.com/1.10.10/api/agent/) [1.10.9](https://legacy-docs-v1.rasa.com/1.10.9/api/agent/) [1.10.8](https://legacy-docs-v1.rasa.com/1.10.8/api/agent/) [1.10.7](https://legacy-docs-v1.rasa.com/1.10.7/api/agent/) [1.10.6](https://legacy-docs-v1.rasa.com/1.10.6/api/agent/) [1.10.5](https://legacy-docs-v1.rasa.com/1.10.5/api/agent/) [1.10.4](https://legacy-docs-v1.rasa.com/1.10.4/api/agent/) [1.10.3](https://legacy-docs-v1.rasa.com/1.10.3/api/agent/) [1.10.2](https://legacy-docs-v1.rasa.com/1.10.2/api/agent/) [1.10.1](https://legacy-docs-v1.rasa.com/1.10.1/api/agent/) [1.10.0](https://legacy-docs-v1.rasa.com/1.10.0/api/agent/) [1.9.7](https://legacy-docs-v1.rasa.com/1.9.7/api/agent/) [1.9.6](https://legacy-docs-v1.rasa.com/1.9.6/api/agent/) [1.9.5](https://legacy-docs-v1.rasa.com/1.9.5/api/agent/) [1.9.4](https://legacy-docs-v1.rasa.com/1.9.4/api/agent/) [1.9.3](https://legacy-docs-v1.rasa.com/1.9.3/api/agent/) [1.9.2](https://legacy-docs-v1.rasa.com/1.9.2/api/agent/) [1.9.1](https://legacy-docs-v1.rasa.com/1.9.1/api/agent/) [1.9.0](https://legacy-docs-v1.rasa.com/1.9.0/api/agent/) [1.8.3](https://legacy-docs-v1.rasa.com/1.8.3/api/agent/) [1.8.2](https://legacy-docs-v1.rasa.com/1.8.2/api/agent/) [1.8.1](https://legacy-docs-v1.rasa.com/1.8.1/api/agent/) [1.8.0](https://legacy-docs-v1.rasa.com/1.8.0/api/agent/) [1.7.4](https://legacy-docs-v1.rasa.com/1.7.4/api/agent/) [1.7.3](https://legacy-docs-v1.rasa.com/1.7.3/api/agent/) [1.7.2](https://legacy-docs-v1.rasa.com/1.7.2/api/agent/) [1.7.1](https://legacy-docs-v1.rasa.com/1.7.1/api/agent/) [1.7.0](https://legacy-docs-v1.rasa.com/1.7.0/api/agent/) [1.6.2](https://legacy-docs-v1.rasa.com/1.6.2/api/agent/) [1.5.3](https://legacy-docs-v1.rasa.com/1.5.3/api/agent/) [1.4.6](https://legacy-docs-v1.rasa.com/1.4.6/api/agent/) [1.3.10](https://legacy-docs-v1.rasa.com/1.3.10/api/agent/) [1.2.9](https://legacy-docs-v1.rasa.com/1.2.9/api/agent/)

# Agent

_class_`rasa.core.agent.` `Agent`( _domain=None_, _policies=None_, _interpreter=None_, _generator=None_, _tracker_store=None_, _lock_store=None_, _action_endpoint=None_, _fingerprint=None_, _model_directory=None_, _model_server=None_, _remote_storage=None_, _path_to_model_archive=None_)

The Agent class provides a convenient interface for the most important Rasa functionality.

This includes training, handling messages, loading a dialogue model, getting the next action, and handling a channel.

`create_processor`( _preprocessor=None_)

Instantiates a processor based on the set state of the agent.

Return type: `MessageProcessor`

_async_`execute_action`( _sender_id_, _action_, _output_channel_, _policy_, _confidence_)

Handle a single message.

Return type: [`DialogueStateTracker`](https://legacy-docs-v1.rasa.com/1.7.3/api/tracker/#rasa.core.trackers.DialogueStateTracker)

`handle_channels`( _channels_, _http_port=5005_, _route='/webhooks/'_, _cors=None_)

Start a webserver attaching the input channels and handling msgs.

Return type: `Sanic`

_async_`handle_message`( _message_, _message_preprocessor=None_, _**kwargs_)

Handle a single message.

Return type: `Optional`[`List`[`Dict`[`str`, `Any`]]`

_async_`handle_text`( _text_message_, _message_preprocessor=None_, _output_channel=None_, _sender_id='default_)

Handle a single message.

If a message preprocessor is passed, the message will be passed to that function first and the return value is then used as the input for the dialogue engine.

Return type: `Optional`[`List`[`Dict`[`str`, `Any`]]`

`is_core_ready`()

Check if all necessary components and policies are ready to use the agent.

Return type: `bool`

`is_ready`()

Check if all necessary components are instantiated to use agent.

Return type: `bool`

_classmethod_`load`( _model_path_, _interpreter=None_, _generator=None_, _tracker_store=None_, _lock_store=None_, _action_endpoint=None_, _model_server=None_, _remote_storage=None_, _path_to_model_archive=None_)

Load a persisted model from the passed path.

Return type: [`Agent`](https://legacy-docs-v1.rasa.com/1.7.3/api/agent/#rasa.core.agent.Agent)

_async_`load_data`( _training_resource_, _remove_duplicates=True_, _unique_last_num_states=None_, _augmentation_factor=50_, _tracker_limit=None_, _use_story_concatenation=True_, _debug_plots=False_, _exclusion_percentage=None_)

Load training data from a resource.

Return type: `List`[`DialogueStateTracker`](https://legacy-docs-v1.rasa.com/1.7.3/api/tracker/#rasa.core.trackers.DialogueStateTracker)

_async_`log_message`( _message_, _message_preprocessor=None_, _**kwargs_)

Append a message to a dialogue - does not predict actions.

Return type: [`DialogueStateTracker`](https://legacy-docs-v1.rasa.com/1.7.3/api/tracker/#rasa.core.trackers.DialogueStateTracker)

_async_`parse_message_using_nlu_interpreter`( _message_data_, _tracker=None_)

Handles message text and intent payload input messages.

Return type: `Dict`[`str`, `Any`]

`persist`( _model_path_)

Persists this agent into a directory for later loading and usage.

Return type: `None`

_async_`predict_next`( _sender_id_, _**kwargs_)

Handle a single message.

Return type: `Optional`[`Dict`[`str`, `Any`]]

`toggle_memoization`( _activate_)

Toggles the memoization on and off.

Return type: `None`

`train`( _training_trackers_, _**kwargs_)

Train the policies / policy ensemble using dialogue data from file.

Return type: `None`

_async_`trigger_intent`( _intent_name_, _entities_, _output_channel_, _tracker_)

Trigger a user intent, e.g. triggered by an external event.

Return type: `None`
