Tracker Stores

These docs are for version 1.x of Rasa Open Source.

User Guide

• Installation
• Tutorial: Rasa Basics
• Tutorial: Building Assistants
• Command Line Interface
• Architecture
• Messaging and Voice Channels
• Testing Your Assistant
• Setting up CI/CD
• Validate Data
• Configuring the HTTP API
• Deploying Your Rasa Assistant
• Cloud Storage

NLU

• About
• Using NLU Only
• Training Data Format
• Language Support
• Choosing a Pipeline
• Components
• Entity Extraction

Core

• About
• Stories
• Domains
• Responses
• Actions
• Reminders and External Events
• Policies
• Slots
• Forms
• Retrieval Actions
• Interactive Learning
• Fallback Actions
• Knowledge Base Actions

Conversation Design

• Dialogue Elements
• Small Talk
• Completing Tasks
• Guiding Users

API Reference

• Action Server
• HTTP API
• Jupyter Notebooks
• Agent
• Custom NLU Components
• Rasa SDK
• Events
• Tracker
• Tracker Stores
• Event Brokers
• Lock Stores
• Training Data Importers
• Featurization of Conversations
• TensorFlow Configuration
• Migration Guide
• Rasa Open Source Change Log

Migrate from (beta)

• Dialogflow
• Wit.ai
• LUIS
• IBM Watson

Reference

• Glossary

Versions

viewing: 1.10.20

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.

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.

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

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

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.

Configuration

1. Start your MongoDB instance.
2. Add required configuration to your endpoints.yml

tracker_store:
    type: mongod
    url: <url to your mongo instance, e.g. mongodb://localhost:27017>
    db: <name of the db within your mongo instance, e.g. rasa>
    username: <username used for authentication>
    password: <password used for authentication>
    auth_source: <database name associated with the user’s credentials>

3. To start the Rasa server using your configured MongoDB instance, add the --endpoints flag, e.g.:

rasa run -m models --endpoints endpoints.yml

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

Configuration

1. Start your DynamoDB instance.
2. Add required configuration to your endpoints.yml:

tracker_store:
    type: dynamo
    tablename: <name of the table to create, e.g. rasa>
    region: <name of the region associated with the client>

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.