notice

This is unreleased documentation for Rasa Open Source Documentation Master/Unreleased version.
For the latest released documentation, see the latest version (2.2.x).

Version: Master/Unreleased

rasa.core.training.interactive

RestartConversation Objects

class RestartConversation(Exception)

Exception used to break out the flow and restart the conversation.

ForkTracker Objects

class ForkTracker(Exception)

Exception used to break out the flow and fork at a previous step.

The tracker will be reset to the selected point in the past and the conversation will continue from there.

UndoLastStep Objects

class UndoLastStep(Exception)

Exception used to break out the flow and undo the last step.

The last step is either the most recent user message or the most recent action run by the bot.

Abort Objects

class Abort(Exception)

Exception used to abort the interactive learning and exit.

send_message

async send_message(endpoint: EndpointConfig, conversation_id: Text, message: Text, parse_data: Optional[Dict[Text, Any]] = None) -> Dict[Text, Any]

Send a user message to a conversation.

request_prediction

async request_prediction(endpoint: EndpointConfig, conversation_id: Text) -> Dict[Text, Any]

Request the next action prediction from core.

retrieve_domain

async retrieve_domain(endpoint: EndpointConfig) -> Dict[Text, Any]

Retrieve the domain from core.

retrieve_status

async retrieve_status(endpoint: EndpointConfig) -> Dict[Text, Any]

Retrieve the status from core.

retrieve_tracker

async retrieve_tracker(endpoint: EndpointConfig, conversation_id: Text, verbosity: EventVerbosity = EventVerbosity.ALL) -> Dict[Text, Any]

Retrieve a tracker from core.

send_action

async send_action(endpoint: EndpointConfig, conversation_id: Text, action_name: Text, policy: Optional[Text] = None, confidence: Optional[float] = None, is_new_action: bool = False) -> Dict[Text, Any]

Log an action to a conversation.

send_event

async send_event(endpoint: EndpointConfig, conversation_id: Text, evt: Union[List[Dict[Text, Any]], Dict[Text, Any]]) -> Dict[Text, Any]

Log an event to a conversation.

format_bot_output

format_bot_output(message: BotUttered) -> Text

Format a bot response to be displayed in the history table.

latest_user_message

latest_user_message(events: List[Dict[Text, Any]]) -> Optional[Dict[Text, Any]]

Return most recent user message.

all_events_before_latest_user_msg

all_events_before_latest_user_msg(events: List[Dict[Text, Any]]) -> List[Dict[Text, Any]]

Return all events that happened before the most recent user message.

is_listening_for_message

async is_listening_for_message(conversation_id: Text, endpoint: EndpointConfig) -> bool

Check if the conversation is in need for a user message.

record_messages

async record_messages(endpoint: EndpointConfig, file_importer: TrainingDataImporter, conversation_id: Text = DEFAULT_SENDER_ID, max_message_limit: Optional[int] = None, skip_visualization: bool = False) -> None

Read messages from the command line and print bot responses.

start_visualization

start_visualization(image_path: Text, port: int) -> None

Add routes to serve the conversation visualization files.

wait_til_server_is_running

async wait_til_server_is_running(endpoint, max_retries=30, sleep_between_retries=1) -> bool

Try to reach the server, retry a couple of times and sleep in between.

run_interactive_learning

run_interactive_learning(file_importer: TrainingDataImporter, skip_visualization: bool = False, conversation_id: Text = uuid.uuid4().hex, server_args: Dict[Text, Any] = None) -> None

Start the interactive learning with the model of the agent.