Events ¶

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

Note

If you are using the Rasa SDK to write custom actions in python, you need to import the events from rasa_sdk.events, not fromrasa.core.events. If you are writing actions in another language, your events should be formatted like the JSON objects on this page.

General Purpose Events ¶

Set a Slot ¶

Short

Event to set a slot on a tracker

JSON

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

Class_class_rasa.core.events.``SlotSet( key, value=None, timestamp=None, metadata=None) ¶

The user has specified their preference for the value of a slot.

Every slot has a name and a value. This event can be used to set a value for a slot on a conversation.

Restart a conversation ¶

Short

Resets anything logged on the tracker.

JSON

evt = {"event": "restart"}

Reset all Slots ¶

Short

Resets all the slots of a conversation.

JSON

evt = {"event": "reset_slots"}

Schedule a reminder ¶

Short

Schedule an action to be executed in the future.

JSON

evt = {
    "event": "reminder",
    "action": "my_action",
    "date_time": "2018-09-03T11:41:10.128172",
    "name": "my_reminder",
    "kill_on_user_msg": True,
}

Pause a conversation ¶

Short

Stops the bot from responding to messages. Action prediction will be halted until resumed.

JSON

evt = {"event": "pause"}

Resume a conversation ¶

Short

Resumes a previously paused conversation. The bot will start predicting actions again.

JSON

evt = {"event": "resume"}

Force a followup action ¶

Short

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

JSON

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

Automatically tracked events ¶

User sent message ¶

Short

Message a user sent to the bot.

JSON

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.

JSON

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

Undo a user message ¶

Short

Undoes all side effects that happened after the last user message (including the user event of the message).

JSON

evt = {"event": "rewind"}

Undo an action ¶

Short

Undoes all side effects that happened after the last action (including the action event of the action).

JSON

evt = {"event": "undo"}

Log an executed action ¶

Short

Logs an action the bot executed to the conversation. Events that action created are logged separately.

JSON

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

Start a new conversation session ¶

Short

Marks the beginning of a new conversation session. Resets the tracker and triggers an ActionSessionStart which by default applies the existing SlotSet events to the new session.

JSON

evt = {"event": "session_started"}

👋 I can help you get started with Rasa and answer your technical questions.