rasa-pro 3.10.16__py3-none-any.whl → 3.11.0__py3-none-any.whl

rasa/__main__.py

@@ -1,5 +1,6 @@
 import argparse
-import logging
+from typing import Optional, List
+import structlog
 import os
 import platform
 import sys
@@ -35,10 +36,9 @@ from rasa.cli.utils import (
 )
 from rasa.plugin import plugin_manager
 from rasa.shared.exceptions import RasaException
-from rasa.shared.utils.cli import print_error
 from rasa.utils.common import configure_logging_and_warnings
 
-logger = logging.getLogger(__name__)
+structlogger = structlog.get_logger()
 
 
 def create_argument_parser() -> argparse.ArgumentParser:
@@ -89,7 +89,7 @@ def print_version() -> None:
     """Prints version information of rasa tooling and python."""
     from rasa.utils.licensing import get_license_expiration_date
 
-    print(f"Rasa Version      :         {version.__version__}")
+    print(f"Rasa Pro Version  :         {version.__version__}")
     print(f"Minimum Compatible Version: {MINIMUM_COMPATIBLE_VERSION}")
     print(f"Rasa SDK Version  :         {rasa_sdk_version}")
     print(f"Python Version    :         {platform.python_version()}")
@@ -98,18 +98,27 @@ def print_version() -> None:
     print(f"License Expires   :         {get_license_expiration_date()}")
 
 
-def main() -> None:
-    """Run as standalone python application."""
+def main(raw_arguments: Optional[List[str]] = None) -> None:
+    """Run as standalone python application.
+
+    Args:
+        raw_arguments: Arguments to parse. If not provided,
+            arguments will be taken from the command line.
+    """
     warn_if_rasa_plus_package_installed()
     parse_last_positional_argument_as_model_path()
     arg_parser = create_argument_parser()
-    cmdline_arguments = arg_parser.parse_args()
+    cmdline_arguments = arg_parser.parse_args(raw_arguments)
 
     log_level = getattr(cmdline_arguments, "loglevel", None)
     logging_config_file = getattr(cmdline_arguments, "logging_config_file", None)
     configure_logging_and_warnings(
         log_level, logging_config_file, warn_only_once=True, filter_repeated_logs=True
     )
+    # TODO: we shouldn't configure colored logging, since we are using structlog
+    # for logging - should be removed as part of logs cleanup
+    rasa.utils.io.configure_colored_logging(log_level)
+    configure_structlog(log_level)
 
     tf_env.setup_tf_environment()
     tf_env.check_deterministic_ops()
@@ -119,8 +128,6 @@ def main() -> None:
 
     try:
         if hasattr(cmdline_arguments, "func"):
-            rasa.utils.io.configure_colored_logging(log_level)
-
             is_studio_command = check_if_studio_command()
 
             if not is_studio_command:
@@ -137,23 +144,32 @@ def main() -> None:
                 plugin_manager().hook.init_anonymization_pipeline(
                     endpoints_file=endpoints_file
                 )
-            # configure structlog
-            configure_structlog(log_level)
 
             cmdline_arguments.func(cmdline_arguments)
         elif hasattr(cmdline_arguments, "version"):
             print_version()
         else:
             # user has not provided a subcommand, let's print the help
-            logger.error("No command specified.")
+            structlogger.error("cli.no_command", event_info="No command specified.")
             arg_parser.print_help()
             sys.exit(1)
-    except RasaException as e:
+    except RasaException as exc:
         # these are exceptions we expect to happen (e.g. invalid training data format)
         # it doesn't make sense to print a stacktrace for these if we are not in
         # debug mode
-        logger.debug("Failed to run CLI command due to an exception.", exc_info=e)
-        print_error(f"{e.__class__.__name__}: {e}")
+        structlogger.debug(
+            "cli.exception.details",
+            event_info="Failed to run CLI command due to an exception.",
+            exc_info=exc,
+        )
+        structlogger.error("cli.exception.rasa_exception", event_info=f"{exc}")
+        sys.exit(1)
+    except Exception as exc:
+        structlogger.error(
+            "cli.exception.general_exception",
+            event_info=f"{exc.__class__.__name__}: {exc}",
+            exc_info=exc,
+        )
         sys.exit(1)
 
 

rasa/api.py

@@ -2,7 +2,7 @@ import asyncio
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Text, Union
 
 import rasa.shared.constants
-from rasa.nlu.persistor import StorageType
+from rasa.core.persistor import StorageType
 
 # WARNING: Be careful about adding any top level imports at this place!
 #   These functions are imported in `rasa.__init__` and any top level import
@@ -14,6 +14,7 @@ from rasa.nlu.persistor import StorageType
 
 if TYPE_CHECKING:
     from rasa.model_training import TrainingResult
+    from rasa.shared.importers.importer import TrainingDataImporter
 
 
 def run(
@@ -78,6 +79,8 @@ def train(
     model_to_finetune: Optional[Text] = None,
     finetuning_epoch_fraction: float = 1.0,
     remote_storage: Optional[StorageType] = None,
+    file_importer: Optional["TrainingDataImporter"] = None,
+    keep_local_model_copy: bool = False,
 ) -> "TrainingResult":
     """Runs Rasa Core and NLU training in `async` loop.
 
@@ -99,7 +102,12 @@ def train(
             a directory in case the latest trained model should be used.
         finetuning_epoch_fraction: The fraction currently specified training epochs
             in the model configuration which should be used for finetuning.
-        remote_storage: Remote storage to use for model storage.
+        remote_storage: Optional name of the remote storage to
+            use for storing the model.
+        file_importer: Instance of `TrainingDataImporter` to use for training.
+            If it is not provided, a new instance will be created.
+        keep_local_model_copy: If `True` the model will be stored locally even if
+            remote storage is configured.
 
     Returns:
         An instance of `TrainingResult`.
@@ -121,6 +129,8 @@ def train(
             model_to_finetune=model_to_finetune,
             finetuning_epoch_fraction=finetuning_epoch_fraction,
             remote_storage=remote_storage,
+            file_importer=file_importer,
+            keep_local_model_copy=keep_local_model_copy,
         )
     )
 

rasa/cli/arguments/default_arguments.py

@@ -1,12 +1,12 @@
 import argparse
 import logging
-from typing import Optional, Text, Union
+from enum import Enum
+from typing import List, Optional, Text, Union
 
-from rasa.nlu.persistor import RemoteStorageType, StorageType, parse_remote_storage
+from rasa.core.persistor import RemoteStorageType, StorageType, parse_remote_storage
 from rasa.shared.constants import (
     DEFAULT_CONFIG_PATH,
     DEFAULT_DATA_PATH,
-    DEFAULT_DOMAIN_PATH,
     DEFAULT_ENDPOINTS_PATH,
     DEFAULT_MODELS_PATH,
 )
@@ -52,7 +52,7 @@ def add_nlu_data_param(
 
 def add_domain_param(
     parser: Union[argparse.ArgumentParser, argparse._ActionsContainer],
-    default: Optional[Text] = DEFAULT_DOMAIN_PATH,
+    default: Optional[Text] = None,
 ) -> None:
     parser.add_argument(
         "-d",
@@ -185,3 +185,23 @@ def parse_remote_storage_arg(value: str) -> StorageType:
         return parse_remote_storage(value)
     except ValueError as e:
         raise argparse.ArgumentTypeError(str(e))
+
+
+class SkipYamlValidation(Enum):
+    DOMAIN = "domain"
+
+    @classmethod
+    def list(cls) -> List[str]:
+        return [e.value for e in SkipYamlValidation]
+
+
+def add_skip_validation_flag(
+    parser: Union[argparse.ArgumentParser, argparse._ActionsContainer],
+) -> None:
+    parser.add_argument(
+        "--skip-yaml-validation",
+        default=[],
+        choices=SkipYamlValidation.list(),
+        action="append",
+        help="Skip YAML validation for selected parts of the training data.",
+    )

rasa/cli/arguments/run.py

@@ -5,6 +5,7 @@ from typing import Union
 from rasa.cli.arguments.default_arguments import (
     add_endpoint_param,
     add_model_param,
+    add_skip_validation_flag,
     add_remote_storage_param,
 )
 from rasa.core import constants
@@ -21,6 +22,8 @@ def set_run_arguments(parser: argparse.ArgumentParser) -> None:
     """Arguments for running Rasa directly using `rasa run`."""
     add_model_param(parser)
     add_server_arguments(parser)
+    add_inspect_argument(parser)
+    add_skip_validation_flag(parser)
 
 
 def set_run_action_arguments(parser: argparse.ArgumentParser) -> None:
@@ -57,6 +60,18 @@ def add_port_argument(
     )
 
 
+# noinspection PyProtectedMember
+def add_inspect_argument(
+    parser: Union[argparse.ArgumentParser, argparse._ArgumentGroup],
+) -> None:
+    """Add an argument for port."""
+    parser.add_argument(
+        "--inspect",
+        action="store_true",
+        help="Run development inspector alongside the assistant.",
+    )
+
+
 def add_server_arguments(parser: argparse.ArgumentParser) -> None:
     """Add arguments for running API endpoint."""
     parser.add_argument(

rasa/cli/arguments/shell.py

@@ -1,12 +1,16 @@
 import argparse
 
-from rasa.cli.arguments.default_arguments import add_model_param
+from rasa.cli.arguments.default_arguments import (
+    add_model_param,
+    add_skip_validation_flag,
+)
 from rasa.cli.arguments.run import add_server_arguments
 
 
 def set_shell_arguments(parser: argparse.ArgumentParser) -> None:
     add_model_param(parser)
     add_server_arguments(parser)
+    add_skip_validation_flag(parser)
 
 
 def set_shell_nlu_arguments(parser: argparse.ArgumentParser) -> None:

rasa/cli/arguments/train.py

@@ -3,12 +3,12 @@ from typing import Union
 
 from rasa.cli.arguments.default_arguments import (
     add_config_param,
-    add_domain_param,
-    add_endpoint_param,
+    add_stories_param,
     add_nlu_data_param,
     add_out_param,
+    add_domain_param,
+    add_endpoint_param,
     add_remote_storage_param,
-    add_stories_param,
 )
 from rasa.graph_components.providers.training_tracker_provider import (
     TrainingTrackerProvider,
@@ -34,18 +34,13 @@ def set_train_arguments(parser: argparse.ArgumentParser) -> None:
 
     _add_model_name_param(parser)
     add_persist_nlu_data_param(parser)
+    add_keep_local_model_copy_param(parser)
     add_force_param(parser)
     add_finetune_params(parser)
     add_endpoint_param(
         parser, help_text="Configuration file for the connectors as a yml file."
     )
     add_remote_storage_param(parser)
-    parser.add_argument(
-        "--remote-bot-config-path",
-        help="Path to the bot configuration file in the remote storage.",
-        required=False,
-        type=str,
-    )
 
 
 def set_train_core_arguments(parser: argparse.ArgumentParser) -> None:
@@ -247,6 +242,19 @@ def add_persist_nlu_data_param(
     )
 
 
+def add_keep_local_model_copy_param(
+    parser: Union[argparse.ArgumentParser, argparse._ActionsContainer],
+) -> None:
+    """Adds parameters for keeping a local copy of the model."""
+    parser.add_argument(
+        "--keep-local-model-copy",
+        action="store_true",
+        help="Keep a copy of the model in the model directory if remote "
+        "model upload is configured. Defaults to `false`, which "
+        "deletes the local copy of the model after upload.",
+    )
+
+
 def add_finetune_params(
     parser: Union[argparse.ArgumentParser, argparse._ActionsContainer],
 ) -> None:

rasa/cli/evaluate.py

@@ -1,16 +1,16 @@
 import argparse
-from typing import List, Text, Optional
 from pathlib import Path
+from typing import List, Text, Optional
 
+import rasa.cli.arguments.evaluate as arguments
+import rasa.shared.utils.cli
 from rasa import telemetry
-from rasa.core.utils import AvailableEndpoints
-from rasa.core.tracker_store import TrackerStore
-from rasa.core.evaluation.marker_tracker_loader import MarkerTrackerLoader
+from rasa.cli import SubParsersAction
 from rasa.core.evaluation.marker_base import Marker, OperatorMarker
+from rasa.core.evaluation.marker_tracker_loader import MarkerTrackerLoader
+from rasa.core.tracker_store import TrackerStore
+from rasa.core.utils import AvailableEndpoints
 from rasa.shared.core.domain import Domain
-from rasa.cli import SubParsersAction
-import rasa.cli.arguments.evaluate as arguments
-import rasa.shared.utils.cli
 
 STATS_OVERALL_SUFFIX = "-overall.csv"
 STATS_SESSION_SUFFIX = "-per-session.csv"

rasa/cli/inspect.py

@@ -3,11 +3,12 @@ import webbrowser
 from asyncio import AbstractEventLoop
 from typing import List, Text
 
+from sanic import Sanic
+
+from rasa import telemetry
 from rasa.cli import SubParsersAction
 from rasa.cli.arguments import shell as arguments
 from rasa.core import constants
-from sanic import Sanic
-
 from rasa.utils.cli import remove_argument_from_parser
 
 
@@ -31,8 +32,13 @@ def add_subparser(
         ),
     )
     inspect_parser.set_defaults(func=inspect)
-
     arguments.set_shell_arguments(inspect_parser)
+
+    # additional argument for voice
+    inspect_parser.add_argument(
+        "--voice", help="Enable voice", action="store_true", default=False
+    )
+
     # it'd be confusing to expose those arguments to the user,
     # so we remove them
     remove_argument_from_parser(inspect_parser, "--credentials")
@@ -40,9 +46,10 @@ def add_subparser(
     remove_argument_from_parser(inspect_parser, "--enable-api")
 
 
-async def open_inspector_in_browser(server_url: Text) -> None:
+async def open_inspector_in_browser(server_url: Text, voice: bool = False) -> None:
     """Opens the rasa inspector in the default browser."""
-    webbrowser.open(f"{server_url}/webhooks/inspector/inspect.html")
+    channel = "socketio" if not voice else "browser_audio"
+    webbrowser.open(f"{server_url}/webhooks/{channel}/inspect.html")
 
 
 def inspect(args: argparse.Namespace) -> None:
@@ -52,12 +59,17 @@ def inspect(args: argparse.Namespace) -> None:
     async def after_start_hook_open_inspector(_: Sanic, __: AbstractEventLoop) -> None:
         """Hook to open the browser on server start."""
         server_url = constants.DEFAULT_SERVER_FORMAT.format("http", args.port)
-        await open_inspector_in_browser(server_url)
+        await open_inspector_in_browser(server_url, args.voice)
 
     # the following arguments are not exposed to the user
-    args.connector = "rasa.core.channels.development_inspector.DevelopmentInspectInput"
+    if args.voice:
+        args.connector = "browser_audio"
+    else:
+        args.connector = "rasa.core.channels.socketio.SocketIOInput"
     args.enable_api = True
+    args.inspect = True
     args.credentials = None
     args.server_listeners = [(after_start_hook_open_inspector, "after_server_start")]
 
+    telemetry.track_inspect_started(args.connector)
     rasa.cli.run.run(args)

rasa/cli/interactive.py

@@ -109,6 +109,7 @@ def _set_not_required_args(args: argparse.Namespace) -> None:
     args.fail_on_validation_warnings = False
     args.validation_max_history = None
     args.remote_storage = None
+    args.keep_local_model_copy = False
 
 
 def perform_interactive_learning(

rasa/cli/llm_fine_tuning.py

@@ -22,7 +22,6 @@ from rasa.cli.e2e_test import (
 )
 from rasa.core.exceptions import AgentNotReady
 from rasa.core.utils import AvailableEndpoints
-from rasa.dialogue_understanding.generator import SingleStepLLMCommandGenerator
 from rasa.e2e_test.e2e_test_runner import E2ETestRunner
 from rasa.llm_fine_tuning.annotation_module import annotate_e2e_tests
 from rasa.llm_fine_tuning.llm_data_preparation_module import convert_to_fine_tuning_data
@@ -45,9 +44,6 @@ from rasa.shared.constants import (
     DEFAULT_MODELS_PATH,
     LLM_CONFIG_KEY,
 )
-from rasa.shared.utils.llm import (
-    combine_custom_and_default_config,
-)
 from rasa.shared.utils.yaml import read_config_file
 from rasa.utils.beta import ensure_beta_feature_is_enabled
 
@@ -279,19 +275,20 @@ def _get_llm_command_generator_config(e2e_test_runner: E2ETestRunner) -> Dict[st
 
     train_schema = e2e_test_runner.agent.processor.model_metadata.train_schema  # type: ignore
 
-    for node_name, node in train_schema.nodes.items():
-        if node.matches_type(SingleStepLLMCommandGenerator, include_subtypes=True):
-            return combine_custom_and_default_config(
-                node.config.get(LLM_CONFIG_KEY, {}), DEFAULT_LLM_CONFIG
-            )
+    for node in train_schema.nodes:
+        if "SingleStepLLMCommandGenerator" in node:
+            return {
+                **DEFAULT_LLM_CONFIG,
+                **train_schema.nodes[node].config.get(LLM_CONFIG_KEY),
+            }
 
     rasa.shared.utils.cli.print_error(
-        "The provided model is not trained using 'SingleStepLLMCommandGenerator' or "
-        "its subclasses. Without it, no data for fine-tuning can be generated. To "
-        "resolve this, please include 'SingleStepLLMCommandGenerator' or its subclass "
-        "in your config and train your model."
+        "The provided model was not trained with the 'SingleStepLLMCommandGenerator'."
+        "Without the 'SingleStepLLMCommandGenerator' no data for fine-tuning can be "
+        "created. Please add the 'SingleStepLLMCommandGenerator' to your config and"
+        "train your model."
     )
-    sys.exit(1)
+    sys.exit(0)
 
 
 def log_start_of_module(module_name: str) -> None:

rasa/cli/project_templates/calm/config.yml

@@ -1,12 +1,10 @@
 recipe: default.v1
 language: en
 pipeline:
-- name: SingleStepLLMCommandGenerator
-  llm:
-    model_name: gpt-4
-    request_timeout: 7
-    max_tokens: 256
+  - name: SingleStepLLMCommandGenerator
+    llm:
+      model_group: openai-gpt-4
 
 policies:
-- name: FlowPolicy
-- name: IntentlessPolicy
+  - name: FlowPolicy
+  - name: IntentlessPolicy

rasa/cli/project_templates/calm/endpoints.yml

@@ -41,5 +41,18 @@ action_endpoint:
 #  password: password
 #  queue: queue
 
-nlg:
-  type: rephrase
+# The lines below activate contextual rephrasing, using the default OpenAI language model.
+# Ensure the OPENAI_API_KEY is set to prevent any missing API key errors.
+# For more details, refer to the documentation:
+# https://rasa.com/docs/rasa-pro/concepts/contextual-response-rephraser
+# To enable the rephraser, remove the comment symbols in the lines below.
+#nlg:
+#   type: rephrase
+
+model_groups:
+  - id: openai-gpt-4
+    models:
+      - provider: openai
+        model: openai/gpt-4
+        request_timeout: 7
+        max_tokens: 256

rasa/cli/project_templates/tutorial/config.yml

@@ -1,11 +1,14 @@
 recipe: default.v1
 language: en
 pipeline:
-  - name: SingleStepLLMCommandGenerator
-    llm:
-      model_name: gpt-4
+- name: SingleStepLLMCommandGenerator
+  llm:
+    provider: rasa
+    model: rasa/cmd_gen_codellama_13b_calm_demo
+    api_base: "https://tutorial-llm.rasa.ai"
+  flow_retrieval:
+    active: false
 
 policies:
   - name: FlowPolicy
-#  - name: EnterpriseSearchPolicy
-#  - name: RulePolicy
+#  - name: EnterpriseSearchPolicy

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

@@ -1,6 +1,6 @@
 flows:
   transfer_money:
-    description: This flow lets users send money to friends and family.
+    description: Help users send money to friends and family.
     steps:
       - collect: recipient
       - collect: amount

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

@@ -4,3 +4,8 @@ flows:
     name: pattern chitchat
     steps:
       - action: utter_free_chitchat_response
+  pattern_search:
+    description: Flow for handling knowledge-based questions
+    name: pattern search
+    steps:
+      - action: utter_free_chitchat_response

rasa/cli/project_templates/tutorial/domain.yml

@@ -19,3 +19,17 @@ responses:
 
   utter_transfer_complete:
     - text: "All done. {amount} has been sent to {recipient}."
+
+  utter_free_chitchat_response:
+    - text: "placeholder"
+      metadata:
+        rephrase: True
+        rephrase_prompt: |
+          The following is a conversation with an AI assistant built with Rasa.
+          The assistant can help the user transfer money.
+          The assistant is helpful, creative, clever, and very friendly.
+          The user is making small talk, and the assistant should respond, keeping things light.
+          Context / previous conversation with the user:
+          {{history}}
+          {{current_input}}
+          Suggested AI Response:

rasa/cli/project_templates/tutorial/endpoints.yml

@@ -41,5 +41,10 @@ action_endpoint:
 #  password: password
 #  queue: queue
 
+# Allow rephrasing of responses using a Rasa-hosted model
 nlg:
   type: rephrase
+  llm:
+    provider: rasa
+    model: rasa/cmd_gen_codellama_13b_calm_demo
+    api_base: "https://tutorial-llm.rasa.ai"

rasa/cli/run.py

@@ -6,6 +6,7 @@ from typing import List, Text
 from rasa.api import run as rasa_run
 from rasa.cli import SubParsersAction
 from rasa.cli.arguments import run as arguments
+from rasa.cli.arguments.default_arguments import SkipYamlValidation
 from rasa.cli.utils import get_validated_path
 from rasa.exceptions import ModelNotFound
 from rasa.shared.constants import (
@@ -15,6 +16,7 @@ from rasa.shared.constants import (
     DEFAULT_MODELS_PATH,
     DOCS_BASE_URL,
 )
+from rasa.shared.core.domain import Domain
 from rasa.shared.utils.cli import print_error
 
 logger = logging.getLogger(__name__)
@@ -87,6 +89,11 @@ def run(args: argparse.Namespace) -> None:
         args.credentials, "credentials", DEFAULT_CREDENTIALS_PATH, True
     )
 
+    if SkipYamlValidation.DOMAIN.value in args.skip_yaml_validation:
+        Domain.validate_yaml = False
+    else:
+        Domain.validate_yaml = True
+
     if args.enable_api:
         if not args.remote_storage:
             args.model = _validate_model_path(args.model, "model", DEFAULT_MODELS_PATH)

rasa/cli/scaffold.py

@@ -128,20 +128,22 @@ def print_run_or_instructions(args: argparse.Namespace) -> None:
             setattr(args, a, None)
 
         args.port = constants.DEFAULT_SERVER_PORT
+        args.voice = False
+        args.skip_yaml_validation = ["domain"]
 
         inspect(args)
     else:
         if args.no_prompt:
             print(
                 "If you want to speak to the assistant, "
-                "run 'rasa shell' at any time inside "
+                "run 'rasa inspect' at any time inside "
                 "the project directory."
             )
         else:
             print_success(
                 "Ok 👍🏼. "
                 "If you want to speak to the assistant, "
-                "run 'rasa shell' at any time inside "
+                "run 'rasa inspect' at any time inside "
                 "the project directory."
             )
 

rasa/cli/studio/upload.py

@@ -32,25 +32,10 @@ def add_subparser(
     set_upload_arguments(upload_parser)
 
 
-def add_flows_param(
-    parser: argparse.ArgumentParser,
-    help_text: str = "Name of flows file to upload to Rasa Studio. Works with --calm",
-    default_path: str = "flows.yml",
-) -> None:
-    parser.add_argument(
-        "--flows",
-        default=default_path,
-        nargs="+",
-        type=str,
-        help=help_text,
-    )
-
-
 def set_upload_arguments(parser: argparse.ArgumentParser) -> None:
     """Add arguments for running `rasa upload`."""
     add_data_param(parser, data_type="training")
     add_domain_param(parser)
-    add_flows_param(parser)
     add_config_param(parser)
     add_endpoint_param(parser, help_text="Path to the endpoints file.")