These docs are for version 1.x of Rasa Open Source. ## User Guide - [Installation](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/installation/) - [Tutorial: Rasa Basics](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/rasa-tutorial/) - [Tutorial: Building Assistants](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/building-assistants/) - [Command Line Interface](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/command-line-interface/) - [Architecture](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/architecture/) - [Messaging and Voice Channels](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/messaging-and-voice-channels/) - [Evaluating Models](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/evaluating-models/) - [Validate Data](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/validate-files/) - [Running the Server](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/running-the-server/) - [Deploying your Rasa Assistant](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/how-to-deploy/) - [Cloud Storage](https://legacy-docs-v1.rasa.com/1.7.1/user-guide/cloud-storage/) ## NLU - [About](https://legacy-docs-v1.rasa.com/1.7.1/nlu/about/) - [Using NLU Only](https://legacy-docs-v1.rasa.com/1.7.1/nlu/using-nlu-only/) - [Training Data Format](https://legacy-docs-v1.rasa.com/1.7.1/nlu/training-data-format/) - [Choosing a Pipeline](https://legacy-docs-v1.rasa.com/1.7.1/nlu/choosing-a-pipeline/) - [Language Support](https://legacy-docs-v1.rasa.com/1.7.1/nlu/language-support/) - [Entity Extraction](https://legacy-docs-v1.rasa.com/1.7.1/nlu/entity-extraction/) - [Components](https://legacy-docs-v1.rasa.com/1.7.1/nlu/components/) ## Core - [About](https://legacy-docs-v1.rasa.com/1.7.1/core/about/) - [Stories](https://legacy-docs-v1.rasa.com/1.7.1/core/stories/) - [Domains](https://legacy-docs-v1.rasa.com/1.7.1/core/domains/) - [Responses](https://legacy-docs-v1.rasa.com/1.7.1/core/responses/) - [Actions](https://legacy-docs-v1.rasa.com/1.7.1/core/actions/) - [Policies](https://legacy-docs-v1.rasa.com/1.7.1/core/policies/) - [Slots](https://legacy-docs-v1.rasa.com/1.7.1/core/slots/) - [Forms](https://legacy-docs-v1.rasa.com/1.7.1/core/forms/) - [Retrieval Actions](https://legacy-docs-v1.rasa.com/1.7.1/core/retrieval-actions/) - [Interactive Learning](https://legacy-docs-v1.rasa.com/1.7.1/core/interactive-learning/) - [Fallback Actions](https://legacy-docs-v1.rasa.com/1.7.1/core/fallback-actions/) - [Knowledge Base Actions](https://legacy-docs-v1.rasa.com/1.7.1/core/knowledge-bases/) ## Conversation Design - [Dialogue Elements](https://legacy-docs-v1.rasa.com/1.7.1/dialogue-elements/dialogue-elements/) - [Small Talk](https://legacy-docs-v1.rasa.com/1.7.1/dialogue-elements/small-talk/) - [Completing Tasks](https://legacy-docs-v1.rasa.com/1.7.1/dialogue-elements/completing-tasks/) - [Guiding Users](https://legacy-docs-v1.rasa.com/1.7.1/dialogue-elements/guiding-users/) ## API Reference - [Action Server](https://legacy-docs-v1.rasa.com/1.7.1/api/action-server/) - [HTTP API](https://legacy-docs-v1.rasa.com/1.7.1/api/http-api/) - [Jupyter Notebooks](https://legacy-docs-v1.rasa.com/1.7.1/api/jupyter-notebooks/) - [Agent](https://legacy-docs-v1.rasa.com/1.7.1/api/agent/) - [Custom NLU Components](https://legacy-docs-v1.rasa.com/1.7.1/api/custom-nlu-components/) - [Rasa SDK](https://legacy-docs-v1.rasa.com/1.7.1/api/rasa-sdk/) - [Events](https://legacy-docs-v1.rasa.com/1.7.1/api/events/) - [Tracker](https://legacy-docs-v1.rasa.com/1.7.1/api/tracker/) - [Tracker Stores](https://legacy-docs-v1.rasa.com/1.7.1/api/tracker-stores/#) - [Event Brokers](https://legacy-docs-v1.rasa.com/1.7.1/api/event-brokers/) - [Lock Stores](https://legacy-docs-v1.rasa.com/1.7.1/api/lock-stores/) - [Training Data Importers](https://legacy-docs-v1.rasa.com/1.7.1/api/training-data-importers/) - [Featurization of Conversations](https://legacy-docs-v1.rasa.com/1.7.1/api/core-featurization/) - [Migration Guide](https://legacy-docs-v1.rasa.com/1.7.1/migration-guide/) - [Rasa OSS Change Log](https://legacy-docs-v1.rasa.com/1.7.1/changelog/) ## Migrate from (beta) - [Dialogflow](https://legacy-docs-v1.rasa.com/1.7.1/migrate-from/google-dialogflow-to-rasa/) - [Wit.ai](https://legacy-docs-v1.rasa.com/1.7.1/migrate-from/facebook-wit-ai-to-rasa/) - [LUIS](https://legacy-docs-v1.rasa.com/1.7.1/migrate-from/microsoft-luis-to-rasa/) - [IBM Watson](https://legacy-docs-v1.rasa.com/1.7.1/migrate-from/ibm-watson-to-rasa/) ## Reference - [Glossary](https://legacy-docs-v1.rasa.com/1.7.1/glossary/) ## Versions viewing: 1.7.1 ## Tracker Stores All conversations are stored within a tracker store. Rasa Core provides implementations for different store types out of the box. If you want to use another store, you can also build a custom tracker store by extending the TrackerStore class. ### InMemoryTrackerStore (default) **Description** InMemoryTrackerStore is the default tracker store. It is used if no other tracker store is configured. It stores the conversation history in memory. **Note** As this store keeps all history in memory the entire history is lost if you restart Rasa Core. **Configuration** To use the InMemoryTrackerStore no configuration is needed. ### SQLTrackerStore **Description** `SQLTrackerStore` can be used to store the conversation history in an SQL database. Storing your trackers this way allows you to query the event database by sender_id, timestamp, action name, intent name and typename **Configuration** To set up Rasa Core with SQL the following steps are required: 1. Add required configuration to your endpoints.yml ```yaml tracker_store: type: SQL dialect: "sqlite" # the dialect used to interact with the db url: "" # (optional) host of the sql db, e.g. "localhost" db: "rasa.db" # path to your db username: # username used for authentication password: # password used for authentication query: # optional dictionary to be added as a query string to the connection URL driver: my-driver ``` 3. To start the Rasa Core server using your SQL backend, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` **Parameters** - `domain` (default: `None`): Domain object associated with this tracker store - `dialect` (default: `sqlite`): The dialect used to communicate with your SQL backend. Consult the [SQLAlchemy docs](https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls) for available dialects. - `url` (default: `None`): URL of your SQL server - `port` (default: `None`): Port of your SQL server - `db` (default: `rasa.db`): The path to the database to be used - `username` (default: `None`): The username which is used for authentication - `password` (default: `None`): The password which is used for authentication - `event_broker` (default: `None`): Event broker to publish events to - `login_db` (default: `None`): Alternative database name to which initially connect, and create the database specified by db (PostgreSQL only) - `query` (default: `None`): Dictionary of options to be passed to the dialect and/or the DBAPI upon connect ### RedisTrackerStore **Description** RedisTrackerStore can be used to store the conversation history in [Redis](https://redis.io/). Redis is a fast in-memory key-value store which can optionally also persist data. **Configuration** To set up Rasa Core with Redis the following steps are required: 1. Start your Redis instance 2. Add required configuration to your endpoints.yml ```yaml tracker_store: type: redis url: port: db: password: use_ssl: ``` 3. To start the Rasa Core server using your configured Redis instance, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` **Parameters** - `url` (default: `localhost`): The url of your redis instance - `port` (default: `6379`): The port which redis is running on - `db` (default: `0`): The number of your redis database - `password` (default: `None`): Password used for authentication (`None` equals no authentication) - `record_exp` (default: `None`): Record expiry in seconds - `use_ssl` (default: `False`): whether or not to use SSL for transit encryption ### MongoTrackerStore **Description** MongoTrackerStore can be used to store the conversation history in [Mongo](https://www.mongodb.com/). MongoDB is a free and open-source cross-platform document-oriented NoSQL database. **Configuration** 1. Start your MongoDB instance. 2. Add required configuration to your endpoints.yml ```yaml tracker_store: type: mongod url: db: username: password: auth_source: ``` > You can also add more advanced configurations (like enabling ssl) by appending a parameter to the url field, e.g. mongodb://localhost:27017/?ssl=true 3. To start the Rasa Core server using your configured MongoDB instance, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` **Parameters** - `url` (default: `mongodb://localhost:27017`): URL of your MongoDB - `db` (default: `rasa`): The database name which should be used - `username` (default: `0`): The username which is used for authentication - `password` (default: `None`): The password which is used for authentication - `auth_source` (default: `admin`): database name associated with the user’s credentials. - `collection` (default: `conversations`): The collection name which is used to store the conversations ### Custom Tracker Store **Description** If you require a tracker store which is not available out of the box, you can implement your own. This is done by extending the base class TrackerStore. _class_`rasa.core.tracker_store.``TrackerStore`( _domain_, _event_broker=None_, _retrieve_events_from_previous_conversation_sessions=False_) Class to hold all of the TrackerStore classes **Steps** 1. Extend the TrackerStore base class. Note that your constructor has to provide a parameter `url`. 2. In your endpoints.yml put in the module path to your custom tracker store and the parameters you require: ```yaml tracker_store: type: path.to.your.module.Class url: localhost a_parameter: a value another_parameter: another value ```