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

rasa/e2e_test/e2e_test_runner.py

@@ -1,9 +1,10 @@
 import asyncio
+import copy
 import datetime
 import difflib
 import logging
 from asyncio import CancelledError
-from typing import Dict, List, Optional, Text, Tuple, Union
+from typing import Any, Dict, List, Optional, Text, Tuple, Union
 from urllib.parse import urlparse
 
 import rasa.shared.utils.io
@@ -19,6 +20,7 @@ from rasa.utils.endpoints import EndpointConfig
 from rasa.e2e_test.e2e_test_case import (
     ActualStepOutput,
     Fixture,
+    Metadata,
     TestCase,
     TestStep,
 )
@@ -85,6 +87,8 @@ class E2ETestRunner:
         collector: CollectingOutputChannel,
         steps: List[TestStep],
         sender_id: Text,
+        test_case_metadata: Optional[Metadata] = None,
+        input_metadata: Optional[List[Metadata]] = None,
     ) -> TEST_TURNS_TYPE:
         """Runs dialogue prediction.
 
@@ -94,12 +98,12 @@ class E2ETestRunner:
             sender_id: The test case name with added timestamp suffix.
 
         Returns:
-        Test turns: {turn_sequence (int) : TestStep or ActualStepOutput}.
+            Test turns: {turn_sequence (int) : TestStep or ActualStepOutput}.
         """
         turns: TEST_TURNS_TYPE = {}
         event_cursor = 0
 
-        tracker = await self.agent.processor.fetch_tracker_with_initial_session(  # type: ignore[union-attr]  # noqa: E501
+        tracker = await self.agent.processor.fetch_tracker_with_initial_session(  # type: ignore[union-attr]
             sender_id
         )
         # turn -1 i used to contain events that happen during
@@ -123,12 +127,24 @@ class E2ETestRunner:
                 )
                 continue
 
+            metadata = test_case_metadata.metadata if test_case_metadata else {}
+
+            if input_metadata:
+                step_metadata = self.filter_metadata_for_input(
+                    step.metadata_name, input_metadata
+                )
+                step_metadata_dict = step_metadata.metadata if step_metadata else {}
+                metadata = self.merge_metadata(
+                    sender_id, step.text, metadata, step_metadata_dict
+                )
+
             try:
                 await self.agent.handle_message(
                     UserMessage(
                         step.text,
                         collector,
                         sender_id,
+                        metadata=metadata,
                     )
                 )
             except CancelledError:
@@ -147,6 +163,49 @@ class E2ETestRunner:
             )
         return turns
 
+    @staticmethod
+    def merge_metadata(
+        sender_id: Text,
+        step_text: Text,
+        test_case_metadata: Dict[Text, Text],
+        step_metadata: Dict[Text, Text],
+    ) -> Dict[Text, Text]:
+        """Merges the test case and user step metadata.
+
+        Args:
+            sender_id: The test case name with added timestamp suffix.
+            step_text: The user step text.
+            test_case_metadata: The test case metadata dict.
+            step_metadata: The user step metadata dict.
+
+        Returns:
+            A dictionary with the merged metadata.
+        """
+        if not test_case_metadata:
+            return step_metadata
+        if not step_metadata:
+            return test_case_metadata
+
+        keys_to_overwrite = []
+
+        for key in step_metadata.keys():
+            if key in test_case_metadata.keys():
+                keys_to_overwrite.append(key)
+
+        if keys_to_overwrite:
+            test_case_name = sender_id.rsplit("_", 1)[0]
+            logger.warning(
+                f"Metadata {keys_to_overwrite} exist in both the test case "
+                f"'{test_case_name}' and the user step '{step_text}'. "
+                "The user step metadata takes precedence and will "
+                "override the test case metadata."
+            )
+
+        merged_metadata = copy.deepcopy(test_case_metadata)
+        merged_metadata.update(step_metadata)
+
+        return merged_metadata
+
     @staticmethod
     def get_actual_step_output(
         tracker: DialogueStateTracker,
@@ -310,10 +369,10 @@ class E2ETestRunner:
         if failed_step.text is not None:
             diff_test_text = f"{failed_step.actor}: {failed_step.text}"
             diff_actual_text = NO_RESPONSE
-            event: Optional[
-                Union[BotUttered, SlotSet]
-            ] = cls._find_first_non_matched_utterance(
-                test_response, bot_utter_test_steps
+            event: Optional[Union[BotUttered, SlotSet]] = (
+                cls._find_first_non_matched_utterance(
+                    test_response, bot_utter_test_steps
+                )
             )
             if event and isinstance(event, BotUttered):
                 test_response.remove_bot_uttered_event(event)
@@ -533,7 +592,7 @@ class E2ETestRunner:
         """
         if not fixtures:
             return
-        tracker = await self.agent.processor.fetch_tracker_with_initial_session(  # type: ignore[union-attr]  # noqa: E501
+        tracker = await self.agent.processor.fetch_tracker_with_initial_session(  # type: ignore[union-attr]
             sender_id
         )
 
@@ -564,11 +623,43 @@ class E2ETestRunner:
             )
         )
 
+    @staticmethod
+    def filter_metadata_for_input(
+        metadata_name: Optional[Text], test_suite_metadata: List[Metadata]
+    ) -> Optional[Metadata]:
+        """Filters the test suite metadata for a metadata name.
+
+        Args:
+            metadata_name: The test case or user step metadata name.
+            test_suite_metadata: The top level list of all metadata definitions.
+
+        Returns:
+            The filtered metadata.
+        """
+        if not metadata_name:
+            return None
+
+        filtered_metadata = list(
+            filter(
+                lambda metadata: metadata_name and metadata.name == metadata_name,
+                test_suite_metadata,
+            )
+        )
+
+        if not filtered_metadata:
+            logger.warning(
+                f"Metadata '{metadata_name}' is not defined in the input metadata."
+            )
+            return None
+
+        return filtered_metadata[0]
+
     async def run_tests(
         self,
         input_test_cases: List[TestCase],
         input_fixtures: List[Fixture],
         fail_fast: bool = False,
+        **kwargs: Any,
     ) -> List["TestResult"]:
         """Runs the test cases.
 
@@ -576,14 +667,16 @@ class E2ETestRunner:
             input_test_cases: Input test cases.
             input_fixtures: Input fixtures.
             fail_fast: Whether to fail fast.
+            **kwargs: Additional arguments which are passed here.
 
         Returns:
-        List of test results.
+            List of test results.
         """
         results = []
+        input_metadata = kwargs.get("input_metadata", None)
 
         # telemetry call for tracking test runs
-        track_e2e_test_run(input_test_cases, input_fixtures)
+        track_e2e_test_run(input_test_cases, input_fixtures, input_metadata)
 
         for test_case in input_test_cases:
             collector = CollectingOutputChannel()
@@ -597,8 +690,18 @@ class E2ETestRunner:
                 )
                 await self.set_up_fixtures(test_fixtures, sender_id)
 
+            test_case_metadata = None
+            if input_metadata:
+                test_case_metadata = self.filter_metadata_for_input(
+                    test_case.metadata_name, input_metadata
+                )
+
             tracker = await self.run_prediction_loop(
-                collector, test_case.steps, sender_id
+                collector,
+                test_case.steps,
+                sender_id,
+                test_case_metadata,
+                input_metadata,
             )
 
             test_result = self.generate_test_result(tracker, test_case)

rasa/e2e_test/e2e_test_schema.yml

@@ -13,6 +13,18 @@ mapping:
                   regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
                     type: any
 
+  metadata:
+    allowempty: True
+    type: "seq"
+    sequence:
+      - type: map
+        mapping:
+          regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+            type: map
+            mapping:
+              regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+                type: any
+
   test_cases:
     type: "seq"
     sequence:
@@ -27,6 +39,9 @@ mapping:
             sequence:
               - type: "str"
                 pattern: ^[a-zA-Z_]+[a-zA-Z0-9_]*$
+          metadata:
+            type: "str"
+            pattern: ^[a-zA-Z_]+[a-zA-Z0-9_]*$
           steps:
             type: "seq"
             matching: "any"
@@ -34,7 +49,10 @@ mapping:
               - type: map
                 mapping:
                   user:
+                    type: str
+                  metadata:
                     type: "str"
+                    pattern: ^[a-zA-Z_]+[a-zA-Z0-9_]*$
               - type: map
                 mapping:
                   utter:

rasa/engine/caching.py

@@ -305,7 +305,6 @@ class LocalTrainingCache(TrainingCache):
         with rasa.utils.common.TempDirectoryPath(tempdir_name) as temp_dir:
             tmp_path = Path(temp_dir)
             try:
-
                 output.to_cache(tmp_path, model_storage)
 
                 logger.debug(

rasa/engine/graph.py

@@ -108,10 +108,10 @@ class GraphSchema:
         nodes = {}
         for node_name, serialized_node in serialized_graph_schema["nodes"].items():
             try:
-                serialized_node[
-                    "uses"
-                ] = rasa.shared.utils.common.class_from_module_path(
-                    serialized_node["uses"]
+                serialized_node["uses"] = (
+                    rasa.shared.utils.common.class_from_module_path(
+                        serialized_node["uses"]
+                    )
                 )
 
                 resource = serialized_node["resource"]
@@ -172,6 +172,18 @@ class GraphSchema:
                 return True
         return False
 
+    def count_nodes_of_a_given_type(
+        self, node_type: Type, include_subtypes: bool = True
+    ) -> int:
+        """Counts the number of the nodes of specified class"""
+        counter = 0
+        for node in self.nodes.values():
+            if (node.uses is node_type) or (
+                include_subtypes and issubclass(node.uses, node_type)
+            ):
+                counter += 1
+        return counter
+
 
 class GraphComponent(ABC):
     """Interface for any component which will run in a graph."""
@@ -206,7 +218,7 @@ class GraphComponent(ABC):
 
     @classmethod
     def load(
-        cls,
+        cls: Any,
         config: Dict[Text, Any],
         model_storage: ModelStorage,
         resource: Resource,
@@ -267,7 +279,7 @@ class GraphComponent(ABC):
         return []
 
     @classmethod
-    def fingerprint_addon(cls, config: Dict[str, Any]) -> Optional[str]:
+    def fingerprint_addon(cls: Any, config: Dict[str, Any]) -> Optional[str]:
         """Adds additional data to the fingerprint calculation.
 
         This is useful if a component uses external data that is not provided

rasa/engine/recipes/config_files/default_config.yml

@@ -1,5 +1,5 @@
 # The config recipe.
-# https://rasa.com/docs/rasa/model-configuration/
+# https://rasa.com/docs/rasa-pro/nlu-based-assistants/model-configuration/
 recipe: default.v1
 
 # The assistant project unique identifier
@@ -7,7 +7,7 @@ recipe: default.v1
 assistant_id: placeholder_default
 
 # Configuration for the Rasa NLU components.
-# https://rasa.com/docs/rasa/components
+# https://rasa.com/docs/rasa-pro/nlu-based-assistants/components
 language: en
 
 pipeline:
@@ -31,7 +31,7 @@ pipeline:
     ambiguity_threshold: 0.1
 
 # Configuration for the Rasa Core policies.
-# https://rasa.com/docs/rasa/policies
+# https://rasa.com/docs/rasa-pro/concepts/policies/policy-overview/
 policies:
   - name: MemoizationPolicy
   - name: RulePolicy

rasa/engine/recipes/default_components.py

@@ -9,7 +9,7 @@ from rasa.dialogue_understanding.generator.nlu_command_adapter import NLUCommand
 from rasa.nlu.classifiers.diet_classifier import DIETClassifier
 from rasa.nlu.classifiers.fallback_classifier import FallbackClassifier
 from rasa.nlu.classifiers.keyword_intent_classifier import KeywordIntentClassifier
-from rasa.dialogue_understanding.generator.llm_command_generator import (
+from rasa.dialogue_understanding.generator import (
     LLMCommandGenerator,
 )
 from rasa.nlu.classifiers.llm_intent_classifier import LLMIntentClassifier

rasa/engine/recipes/default_recipe.py

@@ -157,10 +157,10 @@ class DefaultV1Recipe(Recipe):
             else:
                 unique_types = set(component_types)
 
-            cls._registered_components[
-                registered_class.__name__
-            ] = cls.RegisteredComponent(
-                registered_class, unique_types, is_trainable, model_from
+            cls._registered_components[registered_class.__name__] = (
+                cls.RegisteredComponent(
+                    registered_class, unique_types, is_trainable, model_from
+                )
             )
             return registered_class
 
@@ -699,7 +699,6 @@ class DefaultV1Recipe(Recipe):
         preprocessors: List[Text],
         train_nodes: Dict[Text, SchemaNode],
     ) -> Dict[Text, SchemaNode]:
-
         predict_config = copy.deepcopy(config)
         predict_nodes = {}
 

rasa/engine/recipes/recipe.py

@@ -33,7 +33,7 @@ class Recipe(abc.ABC):
 
         if name is None:
             rasa.shared.utils.io.raise_deprecation_warning(
-                "From Rasa Open Source 4.0.0 onwards it will be required to specify "
+                "From Rasa Pro 4.0.0 onwards it will be required to specify "
                 "a recipe in your model configuration. Defaulting to recipe "
                 f"'{DefaultV1Recipe.name}'."
             )

rasa/engine/runner/dask.py

@@ -222,9 +222,7 @@ async def execute_dask_graph(dsk: Dict[str, Any], result: List[str]) -> Any:
     state = {}
     keyorder = dask.local.order(dsk)  # type:ignore[no-untyped-call]
 
-    state = dask.local.start_state_from_dask(
-        dsk, cache=cache, sortkey=keyorder.get
-    )  # type:ignore[no-untyped-call]
+    state = dask.local.start_state_from_dask(dsk, cache=cache, sortkey=keyorder.get)  # type:ignore[no-untyped-call]
 
     if state["waiting"] and not state["ready"]:
         raise ValueError("Found no accessible jobs in dask")
@@ -237,17 +235,13 @@ async def execute_dask_graph(dsk: Dict[str, Any], result: List[str]) -> Any:
         # Notify task is running
         state["running"].add(key)
 
-        dependencies = dask.local.get_dependencies(
-            dsk, key
-        )  # type:ignore[no-untyped-call]
+        dependencies = dask.local.get_dependencies(dsk, key)  # type:ignore[no-untyped-call]
         # Prep args to send
         data = {dep: state["cache"][dep] for dep in dependencies}
 
         task_result = await _execute_task(dsk[key], data)
         state["cache"][key] = task_result
-        dask.local.finish_task(
-            dsk, key, state, results, keyorder.get
-        )  # type:ignore[no-untyped-call]
+        dask.local.finish_task(dsk, key, state, results, keyorder.get)  # type:ignore[no-untyped-call]
 
     # Main loop, wait on tasks to finish, insert new ones
     while state["ready"]:

rasa/engine/storage/local_model_storage.py

@@ -197,7 +197,6 @@ class LocalModelStorage(ModelStorage):
         logger.debug(f"Start to created model package for path '{model_archive_path}'.")
 
         with windows_safe_temporary_directory() as temp_dir:
-
             temporary_directory = Path(temp_dir)
 
             shutil.copytree(
@@ -222,7 +221,6 @@ class LocalModelStorage(ModelStorage):
 
     @staticmethod
     def _persist_metadata(metadata: ModelMetadata, temporary_directory: Path) -> None:
-
         rasa.shared.utils.io.dump_obj_as_json_to_file(
             temporary_directory / MODEL_ARCHIVE_METADATA_FILE, metadata.as_dict()
         )