rasa-pro 3.8.17__py3-none-any.whl → 3.9.14__py3-none-any.whl

rasa/cli/project_templates/tutorial/credentials.yml

@@ -1,6 +1,6 @@
 # This file contains the credentials for the voice & chat platforms
 # which your bot is using.
-# https://rasa.com/docs/rasa/messaging-and-voice-channels
+# https://rasa.com/docs/rasa-pro/connectors/messaging-and-voice-channels/
 
 rest:
 #  # you don't need to provide anything here - this channel doesn't

rasa/cli/project_templates/tutorial/data/patterns.yml

@@ -0,0 +1,6 @@
+flows:
+  pattern_chitchat:
+    description: Conversation repair flow for off-topic interactions that won't disrupt the main conversation. should not respond to greetings or anything else for which there is a flow defined
+    name: pattern chitchat
+    steps:
+      - action: utter_free_chitchat_response

rasa/cli/project_templates/tutorial/domain.yml

@@ -3,8 +3,12 @@ version: "3.1"
 slots:
   recipient:
     type: text
+    mappings:
+      - type: from_llm
   amount:
     type: float
+    mappings:
+      - type: from_llm
 
 responses:
   utter_ask_recipient:

rasa/cli/project_templates/tutorial/endpoints.yml

@@ -1,21 +1,21 @@
 # This file contains the different endpoints your bot can use.
 
 # Server where the models are pulled from.
-# https://rasa.com/docs/rasa/model-storage#fetching-models-from-a-server
+# https://rasa.com/docs/rasa-pro/production/model-storage#fetching-models-from-a-server
 
 #models:
 #  url: http://my-server.com/models/default_core@latest
 #  wait_time_between_pulls:  10   # [optional](default: 100)
 
 # Server which runs your custom actions.
-# https://rasa.com/docs/rasa/custom-actions
+# https://rasa.com/docs/rasa-pro/concepts/custom-actions
 
 action_endpoint:
   url: "http://localhost:5055/webhook"
 
 # Tracker store which is used to store the conversations.
 # By default the conversations are stored in memory.
-# https://rasa.com/docs/rasa/tracker-stores
+# https://rasa.com/docs/rasa-pro/production/tracker-stores
 
 #tracker_store:
 #    type: redis
@@ -33,7 +33,7 @@ action_endpoint:
 #    password: <password used for authentication>
 
 # Event broker which all conversation events should be streamed to.
-# https://rasa.com/docs/rasa/event-brokers
+# https://rasa.com/docs/rasa-pro/production/event-brokers
 
 #event_broker:
 #  url: localhost
@@ -41,5 +41,5 @@ action_endpoint:
 #  password: password
 #  queue: queue
 
-#nlg:
-#  type: rephrase
+nlg:
+  type: rephrase

rasa/cli/run.py

@@ -58,7 +58,6 @@ def run_actions(args: argparse.Namespace) -> None:
 
 
 def _validate_model_path(model_path: Text, parameter: Text, default: Text) -> Text:
-
     if model_path is not None and not os.path.exists(model_path):
         reason_str = f"'{model_path}' not found."
         if model_path is None:

rasa/cli/scaffold.py

@@ -213,8 +213,9 @@ def run(args: argparse.Namespace) -> None:
     print_success("Welcome to Rasa! 🤖\n")
     print(
         "By installing and using this software, you agree to be bound by the terms "
-        "and conditions of the End-User License Agreement (EULA) available at "
-        "https://rasa.com/eula. Please review the EULA carefully before proceeding.\n"
+        "and conditions of the Developer Terms available at "
+        "https://rasa.com/developer-terms. "
+        "Please review the Developer Terms carefully before proceeding.\n"
     )
     if args.no_prompt:
         print(

rasa/cli/studio/download.py

@@ -2,7 +2,12 @@ import argparse
 from typing import List
 
 from rasa.cli import SubParsersAction
+from rasa.cli.arguments.default_arguments import (
+    add_config_param,
+    add_endpoint_param,
+)
 from rasa.cli.arguments.train import add_data_param, add_domain_param
+from rasa.shared.constants import DEFAULT_ENDPOINTS_PATH, DEFAULT_CONFIG_PATH
 
 from rasa.studio.download import handle_download
 
@@ -35,6 +40,12 @@ def set_studio_download_arguments(parser: argparse.ArgumentParser) -> None:
     """Add arguments for running `rasa studio download`."""
     add_domain_param(parser)
     add_data_param(parser)
+    add_config_param(parser, default=DEFAULT_CONFIG_PATH)
+    add_endpoint_param(
+        parser,
+        "Configuration file for the model endpoints.",
+        default=DEFAULT_ENDPOINTS_PATH,
+    )
 
     parser.add_argument(
         "assistant_name",

rasa/cli/studio/studio.py

@@ -1,5 +1,6 @@
 import argparse
-from typing import List
+from typing import List, Optional
+from urllib.parse import ParseResult, urlparse
 
 import questionary
 from rasa.cli import SubParsersAction
@@ -11,6 +12,11 @@ from rasa.studio.auth import StudioAuth
 from rasa.studio.config import StudioConfig
 
 
+DEFAULT_REALM_NAME = "rasa-studio"
+
+DEFAULT_CLIENT_ID = "admin-cli"
+
+
 def add_subparser(
     subparsers: SubParsersAction, parents: List[argparse.ArgumentParser]
 ) -> None:
@@ -34,13 +40,24 @@ def add_subparser(
 def _add_config_subparser(
     studio_sub_parsers: SubParsersAction, parents: List[argparse.ArgumentParser]
 ) -> None:
-    studio_sub_parsers.add_parser(
+    studio_config_parser = studio_sub_parsers.add_parser(
         "config",
         parents=parents,
         conflict_handler="resolve",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
         help="Configure communication parameters for Rasa Studio",
-    ).set_defaults(func=_create_studio_config)
+    )
+
+    studio_config_parser.set_defaults(func=create_and_store_studio_config)
+
+    # add advanced configuration flag to trigger
+    # advanced configuration setup for authentication settings
+    studio_config_parser.add_argument(
+        "--advanced",
+        action="store_true",
+        default=False,
+        help="Configure additional authentication parameters for Rasa Studio",
+    )
 
 
 def _add_login_subparser(
@@ -74,37 +91,176 @@ def _studio_login(args: argparse.Namespace) -> None:
     Args:
         args: Commandline arguments
     """
-    username = args.username
-    password = args.password
-
     studio_config = StudioConfig.read_config()
     studio_auth = StudioAuth(studio_config)
-    studio_auth.login(username, password)
 
+    # show the user the studio url they are logging into
+    # urlparse will always return parseresult if a string is passed in as url
+    parsed_url: ParseResult = urlparse(studio_config.studio_url)  # type: ignore[assignment]
+    studio_url = f"{parsed_url.scheme}://{parsed_url.netloc}"
+
+    rasa.shared.utils.cli.print_info(
+        f"Trying to log in to Rasa Studio at {studio_url} ..."
+    )
+
+    try:
+        username = args.username
+        password = args.password
+
+        if not username:
+            username = questionary.text("Please enter your username").unsafe_ask()
+
+        if not password:
+            password = questionary.password("Please enter your password").unsafe_ask()
+
+        studio_auth.login(username, password)
+    except KeyboardInterrupt:
+        rasa.shared.utils.cli.print_error("Login to Rasa Studio aborted.")
+    except Exception as e:
+        rasa.shared.utils.cli.print_error(f"Failed to login to Rasa Studio. {e}")
 
-def _create_studio_config(_: argparse.Namespace) -> None:
-    authentication_server_url = questionary.text(
-        "Please enter an URL path to the Authentication Server",
-        default="https://auth.rasa.com",
-    ).ask()
 
+def _configure_studio_url() -> Optional[str]:
+    """Configure the Rasa Studio URL.
+
+    Returns:
+        The configured Rasa Studio URL
+    """
     studio_url = questionary.text(
-        "Please enter an URL path to the Studio",
-        default="https://studio.rasa.com/graphql/",
-    ).ask()
+        "Please provide the Rasa Studio URL",
+    ).unsafe_ask()
+
+    if not studio_url.endswith("/"):
+        studio_url += "/"
+
+    # prepend with https if no protocol is provided
+    if not studio_url.startswith("http"):
+        return "https://" + studio_url
+    return studio_url
 
-    realm_name = questionary.text("Please enter Realm Name", default="Studio").ask()
+
+def _get_advanced_config(studio_url: str) -> tuple:
+    """Get the advanced configuration values for Rasa Studio."""
+    keycloak_url = questionary.text(
+        "Please provide your Rasa Studio Keycloak URL",
+        default=studio_url + "auth/",
+    ).unsafe_ask()
+
+    realm_name = questionary.text(
+        "Please enter Realm Name", default=DEFAULT_REALM_NAME
+    ).unsafe_ask()
 
     client_id = questionary.text(
-        "Please enter client ID",
-    ).ask()
+        "Please enter client ID", default=DEFAULT_CLIENT_ID
+    ).unsafe_ask()
+
+    return keycloak_url, realm_name, client_id
 
-    if not authentication_server_url.endswith("/"):
-        authentication_server_url += "/"
 
-    StudioConfig(
-        authentication_server_url=authentication_server_url,
-        studio_url=studio_url,
+def _get_default_config(studio_url: str) -> tuple:
+    """Get the default configuration values for Rasa Studio."""
+    keycloak_url = studio_url + "auth/"
+    realm_name = DEFAULT_REALM_NAME
+    client_id = DEFAULT_CLIENT_ID
+
+    rasa.shared.utils.cli.print_info(
+        f"Using default values for "
+        f"Keycloak URL: {keycloak_url}, "
+        f"Realm Name: '{realm_name}', "
+        f"Client ID: '{client_id}'. "
+        f"You can use '--advanced' to configure these settings."
+    )
+
+    return keycloak_url, realm_name, client_id
+
+
+def _create_studio_config(
+    studio_url: str, keycloak_url: str, realm_name: str, client_id: str
+) -> StudioConfig:
+    """Create a StudioConfig object with the provided parameters."""
+    return StudioConfig(
+        authentication_server_url=keycloak_url,
+        studio_url=studio_url + "api/graphql/",
         client_id=client_id,
         realm_name=realm_name,
-    ).write_config()
+    )
+
+
+def _check_studio_auth(studio_auth: StudioAuth) -> bool:
+    """Check if the Rasa Studio authentication server is reachable."""
+    if studio_auth.health_check():
+        rasa.shared.utils.cli.print_info(
+            "Tried configuration and successfully reached Rasa Studio."
+        )
+        return True
+    return False
+
+
+def _prompt_store_config_anyways() -> bool:
+    """Prompt the user to store the configuration."""
+    should_store_config = questionary.confirm(
+        "Do you want to store the configuration anyway?"
+    ).unsafe_ask()
+
+    return should_store_config
+
+
+def _configure_studio_config(args: argparse.Namespace) -> StudioConfig:
+    """Configure the Rasa Studio connection settings."""
+    studio_url = _configure_studio_url()
+
+    # check if the user wants to configure advanced authentication settings
+    if args.advanced:
+        keycloak_url, realm_name, client_id = _get_advanced_config(studio_url)
+    else:
+        keycloak_url, realm_name, client_id = _get_default_config(studio_url)
+
+    # create a configuration and auth object to try to reach the studio
+    studio_config = _create_studio_config(
+        studio_url, keycloak_url, realm_name, client_id
+    )
+    studio_auth = StudioAuth(studio_config)
+
+    if _check_studio_auth(studio_auth):
+        return studio_config
+
+    rasa.shared.utils.cli.print_error(
+        f"Failed to reach Rasa Studio authentication server at "
+        f"{studio_config.authentication_server_url}."
+    )
+
+    if _prompt_store_config_anyways():
+        return studio_config
+
+    rasa.shared.utils.cli.print_info(
+        "The config was not stored, you can change the values "
+        "again or abort with Ctrl-C."
+    )
+
+    return _configure_studio_config(args)
+
+
+def create_and_store_studio_config(args: argparse.Namespace) -> None:
+    """Create and store the Rasa Studio configuration.
+
+    Args:
+        args: Commandline arguments
+    """
+    try:
+        rasa.shared.utils.cli.print_info(
+            "Configuring Rasa Studio connection settings ..."
+        )
+        studio_config = _configure_studio_config(args)
+
+        if studio_config:
+            studio_config.write_config()
+
+            rasa.shared.utils.cli.print_success(
+                "Successfully configured Rasa Pro to connect to Studio."
+            )
+        else:
+            rasa.shared.utils.cli.print_error(
+                "Failed to configure Rasa Pro to connect to Studio."
+            )
+    except KeyboardInterrupt:
+        rasa.shared.utils.cli.print_error("Configuration of Rasa Studio aborted.")

rasa/cli/studio/upload.py

@@ -54,14 +54,6 @@ def set_upload_arguments(parser: argparse.ArgumentParser) -> None:
     add_config_param(parser)
     add_endpoint_param(parser, help_text="Path to the endpoints file.")
 
-    parser.add_argument(
-        "assistant_name",
-        default=None,
-        nargs=1,
-        type=str,
-        help="Name of the assistant on Rasa Studio",
-    )
-
     parser.add_argument(
         "--entities",
         default=None,

rasa/cli/telemetry.py

@@ -7,6 +7,7 @@ from rasa.cli import SubParsersAction
 import rasa.cli.utils
 from rasa.shared.constants import DOCS_URL_TELEMETRY
 import rasa.shared.utils.cli
+from rasa.utils import licensing
 
 
 def add_subparser(
@@ -21,7 +22,7 @@ def add_subparser(
     telemetry_parser = subparsers.add_parser(
         "telemetry",
         parents=parents,
-        help="Configuration of Rasa Open Source telemetry reporting.",
+        help="Configuration of Rasa Pro telemetry reporting.",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
@@ -30,7 +31,7 @@ def add_subparser(
         "disable",
         parents=parents,
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-        help="Disable Rasa Open Source Telemetry reporting.",
+        help="Disable Rasa Pro Telemetry reporting.",
     )
     telemetry_disable_parser.set_defaults(func=disable_telemetry)
 
@@ -38,7 +39,7 @@ def add_subparser(
         "enable",
         parents=parents,
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-        help="Enable Rasa Open Source Telemetry reporting.",
+        help="Enable Rasa Pro Telemetry reporting.",
     )
     telemetry_enable_parser.set_defaults(func=enable_telemetry)
     telemetry_parser.set_defaults(func=inform_about_telemetry)
@@ -60,11 +61,15 @@ def inform_about_telemetry(_: argparse.Namespace) -> None:
         textwrap.dedent(
             """
             Rasa uses telemetry to report anonymous usage information. This information
-            is essential to help improve Rasa Open Source for all users."""
+            is essential to help improve Rasa Pro for all users."""
         )
     )
-
-    if not is_enabled:
+    if licensing.is_champion_server_license():
+        print(
+            "\nYou are using a developer license, which requires telemetry "
+            "reporting to be enabled."
+        )
+    elif not is_enabled:
         print("\nYou can enable telemetry reporting using")
         rasa.shared.utils.cli.print_info("\n\trasa telemetry enable")
     else:
@@ -79,6 +84,13 @@ def inform_about_telemetry(_: argparse.Namespace) -> None:
 
 def disable_telemetry(_: argparse.Namespace) -> None:
     """Disable telemetry tracking."""
+    if licensing.is_champion_server_license():
+        rasa.shared.utils.cli.print_error(
+            "You are using a developer license, which requires telemetry "
+            "reporting to be enabled."
+        )
+        return
+
     telemetry.track_telemetry_disabled()
     telemetry.toggle_telemetry_reporting(is_enabled=False)
     rasa.shared.utils.cli.print_success("Disabled telemetry reporting.")

rasa/cli/utils.py

@@ -23,7 +23,6 @@ from rasa.shared.utils.yaml import read_config_file
 from rasa.utils.io import write_yaml
 
 if TYPE_CHECKING:
-
     from questionary import Question
     from typing_extensions import Literal
     from rasa.validator import Validator
@@ -39,8 +38,7 @@ def get_validated_path(
     parameter: Text,
     default: Optional[Union[Path, Text, List[Text]]] = ...,
     none_is_valid: "Literal[False]" = ...,
-) -> Union[Path, Text]:
-    ...
+) -> Union[Path, Text]: ...
 
 
 @overload
@@ -49,8 +47,7 @@ def get_validated_path(
     parameter: Text,
     default: Optional[Union[Path, Text, List[Text]]] = ...,
     none_is_valid: "Literal[True]" = ...,
-) -> Optional[Union[Path, Text]]:
-    ...
+) -> Optional[Union[Path, Text]]: ...
 
 
 def get_validated_path(
@@ -158,9 +155,9 @@ def validate_assistant_id_in_config(config_file: Union["Path", Text]) -> None:
 
         # add random value for assistant id, overwrite config file
         time_format = "%Y%m%d-%H%M%S"
-        config_data[
-            ASSISTANT_ID_KEY
-        ] = f"{time.strftime(time_format)}-{randomname.get_name()}"
+        config_data[ASSISTANT_ID_KEY] = (
+            f"{time.strftime(time_format)}-{randomname.get_name()}"
+        )
 
         write_yaml(data=config_data, target=config_file, should_preserve_key_order=True)
 
@@ -281,8 +278,15 @@ def validate_files(
             validator, max_history, fail_on_warnings
         )
         valid_flows = validator.verify_flows()
-
-        all_good = valid_domain and valid_nlu and valid_stories and valid_flows
+        valid_CALM_slot_mappings = validator.validate_CALM_slot_mappings()
+
+        all_good = (
+            valid_domain
+            and valid_nlu
+            and valid_stories
+            and valid_flows
+            and valid_CALM_slot_mappings
+        )
 
     validator.warn_if_config_mandatory_keys_are_not_set()
 
@@ -302,6 +306,7 @@ def _validate_domain(validator: "Validator") -> bool:
     valid_form_slots = validator.verify_form_slots()
     valid_slot_mappings = validator.verify_slot_mappings()
     valid_responses = validator.check_for_no_empty_paranthesis_in_responses()
+    valid_buttons = validator.validate_button_payloads()
     return (
         valid_domain_validity
         and valid_actions_in_stories_rules
@@ -309,6 +314,7 @@ def _validate_domain(validator: "Validator") -> bool:
         and valid_form_slots
         and valid_slot_mappings
         and valid_responses
+        and valid_buttons
     )
 
 
@@ -451,3 +457,8 @@ def warn_if_rasa_plus_package_installed() -> None:
             f"for using Rasa Pro. Please uninstall it.",
             UserWarning,
         )
+
+
+def check_if_studio_command() -> bool:
+    """Checks if the command is a Rasa Studio command."""
+    return len(sys.argv) >= 2 and sys.argv[1] == "studio"

rasa/cli/x.py

@@ -166,8 +166,9 @@ async def _pull_runtime_config_from_server(
         attempts -= 1
 
     rasa.shared.utils.cli.print_error_and_exit(
-        "Could not fetch runtime config from server at '{}'. "
-        "Exiting.".format(config_endpoint)
+        "Could not fetch runtime config from server at '{}'. Exiting.".format(
+            config_endpoint
+        )
     )