notice

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

Version: Main/Unreleased

rasa.cli.utils

get_validated_path

get_validated_path(current: Optional[Union["Path", Text]], parameter: Text, default: Optional[Union["Path", Text]] = None, none_is_valid: bool = False) -> Optional[Union["Path", Text]]

Checks whether a file path or its default value is valid and returns it.

Arguments:

  • current - The parsed value.
  • parameter - The name of the parameter.
  • default - The default value of the parameter.
  • none_is_valid - True if None is valid value for the path, else `False``

Returns:

The current value if it was valid, else the default value of the argument if it is valid, else None.

missing_config_keys

missing_config_keys(path: Union["Path", Text], mandatory_keys: List[Text]) -> List[Text]

Checks whether the config file at path contains the mandatory_keys.

Arguments:

  • path - The path to the config file.
  • mandatory_keys - A list of mandatory config keys.

Returns:

The list of missing config keys.

cancel_cause_not_found

cancel_cause_not_found(current: Optional[Union["Path", Text]], parameter: Text, default: Optional[Union["Path", Text]]) -> None

Exits with an error because the given path was not valid.

Arguments:

  • current - The path given by the user.
  • parameter - The name of the parameter.
  • default - The default value of the parameter.

parse_last_positional_argument_as_model_path

parse_last_positional_argument_as_model_path() -> None

Fixes the parsing of a potential positional model path argument.

button_to_string

button_to_string(button: Dict[Text, Any], idx: int = 0) -> Text

Create a string representation of a button.

element_to_string

element_to_string(element: Dict[Text, Any], idx: int = 0) -> Text

Create a string representation of an element.

button_choices_from_message_data

button_choices_from_message_data(message: Dict[Text, Any], allow_free_text_input: bool = True) -> List[Text]

Return list of choices to present to the user.

If allow_free_text_input is True, an additional option is added at the end along with the response buttons that allows the user to type in free text.

payload_from_button_question

payload_from_button_question(button_question: "Question") -> Text

Prompt user with a button question and returns the nlu payload.

signal_handler

signal_handler(_: int, __: FrameType) -> None

Kills Rasa when OS signal is received.