Events

List of all the events the dialogue system is able to handle and supports.

An event can be referenced by its type_name attribute (e.g. when returning events in an http callback).

class rasa_core.events.ActionExecuted(action_name)[source]

Bases: rasa_core.events.Event

An operation describes an action taken + its result.

It comprises an action and a list of events. operations will be appended to the latest Turn in the Tracker.turns.

apply_to(tracker)[source]
as_story_string()[source]
class rasa_core.events.ActionReverted[source]

Bases: rasa_core.events.Event

Bot undoes its last action.

Shouldn’t be used during actual user interactions, mostly for train. As a side effect the Tracker‘s last turn is removed.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'undo'
class rasa_core.events.AllSlotsReset[source]

Bases: rasa_core.events.Event

Conversation should start over & history wiped.

As a side effect the Tracker will be reinitialised.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'reset_slots'
class rasa_core.events.Event[source]

Bases: object

An event is one of the following: - something the user has said to the bot (starts a new turn) - the topic has been set - the bot has taken an action

Events are logged by the Tracker’s log_event method. This updates the list of turns so that the current state can be recovered by consuming the list of turns.

apply_to(tracker)[source]
as_story_string()[source]
static from_parameters(event_name, parameters, domain, default=None)[source]
static from_story_string(event_name, parameters, domain, default=None)[source]
static resolve_by_type(type_name, default=None)[source]

Returns a slots class by its type name.

type_name = u'event'
class rasa_core.events.ReminderScheduled(action_name, trigger_date_time, name=None, kill_on_user_message=True)[source]

Bases: rasa_core.events.Event

Allows asynchronous scheduling of action execution.

As a side effect the message processor will schedule an action to be run at the trigger date.

as_story_string()[source]
type_name = u'reminder'
class rasa_core.events.Restarted[source]

Bases: rasa_core.events.Event

Conversation should start over & history wiped.

As a side effect the Tracker will be reinitialised.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'restart'
class rasa_core.events.SlotSet(key, value=None)[source]

Bases: rasa_core.events.Event

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

As a side effect the Tracker‘s slots will be updated so that tracker.slots[key]=value.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'slot'
class rasa_core.events.StoryExported[source]

Bases: rasa_core.events.Event

Story should get dumped to a file.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'export'
class rasa_core.events.TopicSet(topic)[source]

Bases: rasa_core.events.Event

The topic of conversation has changed.

As a side effect self.topic will be pushed on to Tracker.topic_stack.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'topic'
class rasa_core.events.UserUtteranceReverted[source]

Bases: rasa_core.events.Event

Bot undoes its last action.

Shouldn’t be used during actual user interactions, mostly for train. As a side effect the Tracker‘s last turn is removed.

apply_to(tracker)[source]
as_story_string()[source]
type_name = u'rewind'
class rasa_core.events.UserUttered(text, intent=None, entities=None, parse_data=None)[source]

Bases: rasa_core.events.Event

The user has said something to the bot.

As a side effect a new Turn will be created in the Tracker.

apply_to(tracker)[source]
as_story_string()[source]
static empty()[source]
type_name = u'user'