Tracker
These docs are for version 1.x of Rasa Open Source.
Tracker
Trackers maintain the state of a dialogue between the assistant and the user in the form of conversation sessions. To learn more about how to configure the session behaviour, check out the docs on Session configuration.
class rasa.core.trackers.DialogueStateTracker(sender_id, slots, max_event_history=None, sender_source=None)
Maintains the state of a conversation.
The field max_event_history will only give you these last events, it can be set in the tracker_store.
applied_events()
Returns all actions that should be applied - without reverted events.
Return typeList[Event]
as_dialogue()
Return a Dialogue object containing all of the turns.
Return typeDialogue
change_form_to(form_name)
Activate or deactivate a form.
Return typeNone
clear_followup_action()
Clears follow up action when it was executed.
Return typeNone
copy()
Creates a duplicate of this tracker.
Return typeDialogueStateTracker
current_slot_values()
Return the currently set values of the slots.
Return typeDict[str, Any]
current_state(event_verbosity=<EventVerbosity.NONE: 1>)
Return the current tracker state as an object.
Return typeDict[str, Any]
events_after_latest_restart()
Return a list of events after the most recent restart.
Return typeList[Event]
export_stories(e2e=False, include_source=False)
Dump the tracker as a story in the Rasa Core story format.
Returns the dumped tracker as a string.
Return typestr
export_stories_to_file(export_path='debug.md')
Dump the tracker as a story to a file.
Return typeNone
classmethod from_dict(sender_id, events_as_dict, slots=None, max_event_history=None)
Create a tracker from dump.
Return typeDialogueStateTracker
generate_all_prior_trackers()
Returns a generator of the previous trackers of this tracker.
Return typeGenerator[DialogueStateTracker, None, None]
get_last_event_for(event_type, action_names_to_exclude=None, skip=0)
Gets the last event of a given type which was actually applied.
Return typeOptional[Event]
get_latest_entity_values(entity_type, entity_role=None, entity_group=None)
Get entity values found for the passed entity type and optional role and group in latest message.
Return typeIterator[str]
get_latest_input_channel()
Get the name of the input_channel of the latest UserUttered event.
Return typeOptional[str]
get_slot(key)
Retrieves the value of a slot.
Return typeOptional[Any]
idx_after_latest_restart()
Return the idx of the most recent restart in the list of events.
Return typeint
init_copy()
Creates a new state tracker with the same initial values.
Return typeDialogueStateTracker
is_paused()
State whether the tracker is currently paused.
Return typebool
last_executed_action_has(name, skip=0)
Returns whether last ActionExecuted event had a specific name.
Return typebool
past_states(domain)
Generate the past states of this tracker based on the history.
Return typedeque
recreate_from_dialogue(dialogue)
Use a serialised Dialogue to update the trackers state.
Return typeNone
reject_action(action_name)
Notify active form that it was rejected.
Return typeNone
replay_events()
Update the tracker based on a list of events.
Return typeNone
set_form_validation(validate)
Toggle form validation.
Return typeNone
set_latest_action_name(action_name)
Set latest action name and reset form validation and rejection parameters.
Return typeNone
travel_back_in_time(target_time)
Creates a new tracker with a state at a specific timestamp.
Return typeDialogueStateTracker
trigger_followup_action(action)
Triggers another action following the execution of the current.
Return typeNone
update(event, domain=None)
Modify the state of the tracker according to an Event.
Return typeNone
👋 I can help you get started with Rasa and answer your technical questions.