These docs are for version 1.x of Rasa Open Source. ## User Guide - [Installation](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/installation/) - [Tutorial: Rasa Basics](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/rasa-tutorial/) - [Tutorial: Building Assistants](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/building-assistants/) - [Command Line Interface](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/command-line-interface/) - [Architecture](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/architecture/) - [Messaging and Voice Channels](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/messaging-and-voice-channels/) - [Testing Your Assistant](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/testing-your-assistant/) - [Setting up CI/CD](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/setting-up-ci-cd/) - [Validate Data](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/validate-files/) - [Configuring the HTTP API](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/configuring-http-api/) - [Deploying Your Rasa Assistant](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/how-to-deploy/) - [Cloud Storage](https://legacy-docs-v1.rasa.com/1.10.15/user-guide/cloud-storage/) ## NLU - [About](https://legacy-docs-v1.rasa.com/1.10.15/nlu/about/) - [Using NLU Only](https://legacy-docs-v1.rasa.com/1.10.15/nlu/using-nlu-only/) - [Training Data Format](https://legacy-docs-v1.rasa.com/1.10.15/nlu/training-data-format/) - [Language Support](https://legacy-docs-v1.rasa.com/1.10.15/nlu/language-support/) - [Choosing a Pipeline](https://legacy-docs-v1.rasa.com/1.10.15/nlu/choosing-a-pipeline/) - [Components](https://legacy-docs-v1.rasa.com/1.10.15/nlu/components/) - [Entity Extraction](https://legacy-docs-v1.rasa.com/1.10.15/nlu/entity-extraction/) ## Core - [About](https://legacy-docs-v1.rasa.com/1.10.15/core/about/) - [Stories](https://legacy-docs-v1.rasa.com/1.10.15/core/stories/) - [Domains](https://legacy-docs-v1.rasa.com/1.10.15/core/domains/) - [Responses](https://legacy-docs-v1.rasa.com/1.10.15/core/responses/) - [Actions](https://legacy-docs-v1.rasa.com/1.10.15/core/actions/) - [Reminders and External Events](https://legacy-docs-v1.rasa.com/1.10.15/core/reminders-and-external-events/) - [Policies](https://legacy-docs-v1.rasa.com/1.10.15/core/policies/) - [Slots](https://legacy-docs-v1.rasa.com/1.10.15/core/slots/) - [Forms](https://legacy-docs-v1.rasa.com/1.10.15/core/forms/) - [Retrieval Actions](https://legacy-docs-v1.rasa.com/1.10.15/core/retrieval-actions/) - [Interactive Learning](https://legacy-docs-v1.rasa.com/1.10.15/core/interactive-learning/) - [Fallback Actions](https://legacy-docs-v1.rasa.com/1.10.15/core/fallback-actions/) - [Knowledge Base Actions](https://legacy-docs-v1.rasa.com/1.10.15/core/knowledge-bases/) ## Conversation Design - [Dialogue Elements](https://legacy-docs-v1.rasa.com/1.10.15/dialogue-elements/dialogue-elements/) - [Small Talk](https://legacy-docs-v1.rasa.com/1.10.15/dialogue-elements/small-talk/) - [Completing Tasks](https://legacy-docs-v1.rasa.com/1.10.15/dialogue-elements/completing-tasks/) - [Guiding Users](https://legacy-docs-v1.rasa.com/1.10.15/dialogue-elements/guiding-users/) ## API Reference - [Action Server](https://legacy-docs-v1.rasa.com/1.10.15/api/action-server/) - [HTTP API](https://legacy-docs-v1.rasa.com/1.10.15/api/http-api/) - [Jupyter Notebooks](https://legacy-docs-v1.rasa.com/1.10.15/api/jupyter-notebooks/) - [Agent](https://legacy-docs-v1.rasa.com/1.10.15/api/agent/) - [Custom NLU Components](https://legacy-docs-v1.rasa.com/1.10.15/api/custom-nlu-components/) - [Rasa SDK](https://legacy-docs-v1.rasa.com/1.10.15/api/rasa-sdk/) - [Events](https://legacy-docs-v1.rasa.com/1.10.15/api/events/) - [Tracker](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker/) - [Tracker Stores](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#) - [Event Brokers](https://legacy-docs-v1.rasa.com/1.10.15/api/event-brokers/) - [Lock Stores](https://legacy-docs-v1.rasa.com/1.10.15/api/lock-stores/) - [Training Data Importers](https://legacy-docs-v1.rasa.com/1.10.15/api/training-data-importers/) - [Featurization of Conversations](https://legacy-docs-v1.rasa.com/1.10.15/api/core-featurization/) - [TensorFlow Configuration](https://legacy-docs-v1.rasa.com/1.10.15/api/tensorflow_usage/) - [Migration Guide](https://legacy-docs-v1.rasa.com/1.10.15/migration-guide/) - [Rasa Open Source Change Log](https://legacy-docs-v1.rasa.com/1.10.15/changelog/) ## Migrate from (beta) - [Dialogflow](https://legacy-docs-v1.rasa.com/1.10.15/migrate-from/google-dialogflow-to-rasa/) - [Wit.ai](https://legacy-docs-v1.rasa.com/1.10.15/migrate-from/facebook-wit-ai-to-rasa/) - [LUIS](https://legacy-docs-v1.rasa.com/1.10.15/migrate-from/microsoft-luis-to-rasa/) - [IBM Watson](https://legacy-docs-v1.rasa.com/1.10.15/migrate-from/ibm-watson-to-rasa/) ## Reference - [Glossary](https://legacy-docs-v1.rasa.com/1.10.15/glossary/) ## Versions Viewing: 1.10.15 ### Tracker Stores All conversations are stored within a tracker store. Rasa Open Source 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. ### Contents - [Tracker Stores](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#tracker-stores) - [InMemoryTrackerStore (default)](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#inmemorytrackerstore-default) - [SQLTrackerStore](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#sqltrackerstore) - [RedisTrackerStore](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#redistrackerstore) - [MongoTrackerStore](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#mongotrackerstore) - [DynamoTrackerStore](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#dynamotrackerstore) - [Custom Tracker Store](https://legacy-docs-v1.rasa.com/1.10.15/api/tracker-stores/#custom-tracker-store) ### InMemoryTrackerStore (default) `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 the Rasa server. **Configuration**: To use the `InMemoryTrackerStore` no configuration is needed. ### SQLTrackerStore `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 for SQLTrackerStore 1. Add required configuration to your `endpoints.yml`: ``` tracker_store: type: SQL dialect: "postgresql" # the dialect used to interact with the db url: "" # (optional) host of the sql db, e.g. "localhost" db: "rasa" # 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 ``` 2. To start the Rasa server using your SQL backend, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` 3. If deploying your model in Docker Compose, add the service to your `docker-compose.yml`: ``` postgres: image: postgres:latest ``` 4. To route requests to the new service, make sure that the `url` in your `endpoints.yml` references the service name: ``` tracker_store: type: SQL dialect: "postgresql" # the dialect used to interact with the db url: "postgres" db: "rasa" # 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 ``` ### Parameters for SQLTrackerStore - `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 ### Officially Compatible Databases for SQLTrackerStore - PostgreSQL - Oracle > 11.0 - SQLite ### RedisTrackerStore `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 for RedisTrackerStore 1. Start your Redis instance 2. Add required configuration to your `endpoints.yml`: ``` tracker_store: type: redis url: port: db: password: use_ssl: ``` 3. To start the Rasa server using your configured Redis instance, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` 4. If deploying your model in Docker Compose, add the service to your `docker-compose.yml`: ``` redis: image: redis:latest ``` ### Parameters for RedisTrackerStore - `url` (default: `localhost`): The URL of your redis instance - `port` (default: `6379`): The port on which Redis is running - `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 `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 for MongoTrackerStore 1. Start your MongoDB instance. 2. Add required configuration to your `endpoints.yml` ``` tracker_store: type: mongod url: db: username: password: auth_source: ``` 3. To start the Rasa server using your configured MongoDB instance, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` 4. If deploying your model in Docker Compose, add the service to your `docker-compose.yml`: ``` mongo: image: mongo environment: MONGO_INITDB_ROOT_USERNAME: rasa MONGO_INITDB_ROOT_PASSWORD: example mongo-express: # this service is a MongoDB UI, and is optional image: mongo-express ports: - 8081:8081 environment: ME_CONFIG_MONGODB_ADMINUSERNAME: rasa ME_CONFIG_MONGODB_ADMINPASSWORD: example ``` ### Parameters for MongoTrackerStore - `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 ### DynamoTrackerStore `DynamoTrackerStore` can be used to store the conversation history in [DynamoDB](https://aws.amazon.com/dynamodb/). DynamoDB is a hosted NoSQL database offered by Amazon Web Services (AWS). ### Configuration for DynamoTrackerStore 1. Start your DynamoDB instance. 2. Add required configuration to your `endpoints.yml`: ``` tracker_store: type: dynamo tablename: region: ``` 3. To start the Rasa server using your configured `DynamoDB` instance, add the `--endpoints` flag, e.g.: ``` rasa run -m models --endpoints endpoints.yml ``` ### Parameters for DynamoTrackerStore - `tablename` (default: `states`): name of the DynamoDB table - `region` (default: `us-east-1`): name of the region associated with the client ### Custom Tracker Store 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`. **Steps to implement Custom Tracker Store** 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: ``` tracker_store: type: path.to.your.module.Class url: localhost a_parameter: a value another_parameter: another value ``` 3. If deploying in Docker Compose, you have two options to add this store to Rasa Open Source: - extending the Rasa image to include the module - mounting the module as a volume