notice

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

Version: Master/Unreleased

rasa.cli.x

add_subparser

add_subparser(subparsers: SubParsersAction, parents: List[argparse.ArgumentParser]) -> None

Add all rasa x parsers.

Arguments:

  • subparsers - subparser we are going to attach to
  • parents - Parent parsers, needed to ensure tree structure in argparse

start_rasa_for_local_rasa_x

start_rasa_for_local_rasa_x(args: argparse.Namespace, rasa_x_token: Text) -> None

Starts the Rasa X API with Rasa as a background process.

is_rasa_x_installed

is_rasa_x_installed() -> bool

Check if Rasa X is installed.

generate_rasa_x_token

generate_rasa_x_token(length: int = 16) -> Text

Generate a hexadecimal secret token used to access the Rasa X API.

A new token is generated on every rasa x command.

is_rasa_project_setup

is_rasa_project_setup(args: argparse.Namespace, project_path: Text) -> bool

Checks if project_path contains a valid Rasa Open Source project.

Arguments:

  • args - Command-line arguments.
  • project_path - Path to the possible Rasa Open Source project.

Returns:

True if project_path is a valid Rasa Open Source project, False otherwise.

run_locally

run_locally(args: argparse.Namespace) -> None

Run a Rasa X instance locally.

Arguments:

  • args - commandline arguments