Events

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

Events

Conversations in Rasa are represented as a sequence of events. This page lists the event types defined in Rasa Core.

General Purpose Events

• Set a Slot
• Restart a conversation
• Reset all Slots
• Schedule a reminder
• Cancel a reminder
• Pause a conversation
• Resume a conversation
• Force a followup action

Automatically tracked events

• User sent message
• Bot responded message
• Undo a user message
• Undo an action
• Log an executed action
• Start a new conversation session

Event Types

Set a Slot: Event to set a slot on a tracker

{
  "event": "slot",
  "name": "departure_airport",
  "value": "BER"
}

Restart a conversation: Resets anything logged on the tracker.

{
  "event": "restart"
}

Reset all Slots: Resets all the slots of a conversation.

{
  "event": "reset_slots"
}

Schedule a reminder: Schedule an intent to be triggered in the future.

{
  "event": "reminder",
  "intent": "my_intent",
  "entities": {
    "entity1": "value1",
    "entity2": "value2"
  },
  "date_time": "2018-09-03T11:41:10.128172",
  "name": "my_reminder",
  "kill_on_user_msg": true
}

Cancel a reminder: Cancel one or more reminders.

{
  "event": "cancel_reminder",
  "name": "my_reminder",
  "intent": "my_intent",
  "entities": [
    {
      "entity": "entity1",
      "value": "value1"
    },
    {
      "entity": "entity2",
      "value": "value2"
    }
  ],
  "date_time": "2018-09-03T11:41:10.128172"
}

Pause a conversation: Stops the bot from responding to messages.

{
  "event": "pause"
}

Resume a conversation: Resumes a previously paused conversation.

{
  "event": "resume"
}

Force a followup action: Instead of predicting the next action, force the next action to be a fixed one.

{
  "event": "followup",
  "name": "my_action"
}

User Sent Message: Message a user sent to the bot.

{
  "event": "user",
  "text": "Hey",
  "parse_data": {
    "intent": {
      "name": "greet",
      "confidence": 0.9
    },
    "entities": []
  },
  "metadata": {}
}

Bot Responded Message: Message a bot sent to the user.

{
  "event": "bot",
  "text": "Hey there!",
  "data": {}
}

Undo a User Message: Undoes everything that happened after the last user message.

{
  "event": "rewind"
}

Undo an Action: Undoes everything that happened after the last action.

{
  "event": "undo"
}

Log an Executed Action: Logs an action the bot executed to the conversation.

{
  "event": "action",
  "name": "my_action"
}

Start a new conversation session: Marks the beginning of a new conversation session.

{
  "event": "session_started"
}