Events

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

User Guide

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

NLU

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

Core

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

Conversation Design

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

API Reference

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

Migrate from (beta)

• Dialogflow: Dialogflow
• Wit.ai: Wit.ai
• LUIS: LUIS
• IBM Watson: IBM Watson

Reference

• Glossary: 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
  Short: Event to set a slot on a tracker

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

• Restart a conversation
  Short: Resets anything logged on the tracker.

  evt = {"event": "restart"}

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

  evt = {"event": "reset_slots"}

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

  evt = {
    "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
  Short: Cancel one or more reminders.

  evt = {
    "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
  Short: Stops the bot from responding to messages.

  evt = {"event": "pause"}

• Resume a conversation
  Short: Resumes a previously paused conversation.

  evt = {"event": "resume"}

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

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

Automatically tracked events

• User sent message
  Short: Message a user sent to the bot.

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

• Bot responded message
  Short: Message a bot sent to the user.

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

• Undo a user message
  Short: Undoes all side effects that happened after the last user message.

  evt = {"event": "rewind"}

• Undo an action
  Short: Undoes all side effects that happened after the last action.

  evt = {"event": "undo"}

• Log an executed action
  Short: Logs an action the bot executed to the conversation.

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

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

  evt = {"event": "session_started"}