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

• InMemoryTrackerStore (default)
• SQLTrackerStore
• RedisTrackerStore
• MongoTrackerStore
• DynamoTrackerStore
• Custom Tracker Store

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 the Rasa server.

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 Open Source with SQL the following steps are required:

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

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

• domain (default: None): Domain object associated with this tracker store
• dialect (default: sqlite): The dialect used to communicate with your SQL backend.
• 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

RedisTrackerStore

Description RedisTrackerStore can be used to store the conversation history in Redis. Redis is a fast in-memory key-value store which can optionally also persist data.

Configuration To set up Rasa Open Source with Redis the following steps are required:

1. Start your Redis instance.

2. Add required configuration to your endpoints.yml:

tracker_store:
    type: redis
    url: <url of the redis instance, e.g. localhost>
    port: <port of your redis instance, usually 6379>
    db: <number of your database within redis, e.g. 0>
    password: <password used for authentication>
    use_ssl: <whether or not the communication is encrypted, default `false`>

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

• 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)

MongoTrackerStore

Description MongoTrackerStore can be used to store the conversation history in Mongo. MongoDB is a free and open-source cross-platform document-oriented NoSQL database.

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

DynamoTrackerStore

Description DynamoTrackerStore can be used to store the conversation history in
DynamoDB. DynamoDB is a hosted NoSQL database offered by Amazon Web Services (AWS).

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.

classrasa.core.tracker_store.TrackerStore`( domain, event_broker=None, retrieve_events_from_previous_conversation_sessions=False)
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:

tracker_store:
  type: path.to.your.module.Class
  url: localhost
  a_parameter: a value
  another_parameter: another value

3. If you are 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 volume

Make sure to add the corresponding service as well.