rasa-pro 3.11.4__py3-none-any.whl → 3.12.0__py3-none-any.whl

rasa/shared/core/flows/flow_step_sequence.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import List, Dict, Text, Any, Optional
+from typing import Any, Dict, List, Optional, Text
 
 from rasa.shared.core.flows.flow_step import FlowStep, step_from_json
 from rasa.shared.core.flows.steps.internal import InternalFlowStep

rasa/shared/core/flows/flows_list.py

@@ -2,21 +2,21 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from pathlib import Path
-from typing import List, Generator, Any, Optional, Dict, Text, Set, Union
+from typing import Any, Dict, Generator, List, Optional, Set, Text, Union
 
 import rasa.shared.utils.io
 from rasa.shared.core.flows import Flow
 from rasa.shared.core.flows.flow_path import FlowPathsList
 from rasa.shared.core.flows.validation import (
+    DuplicatedFlowIdException,
+    validate_called_flows_exists,
     validate_flow,
     validate_link_in_call_restriction,
-    validate_called_flows_exists,
     validate_linked_flows_exists,
     validate_nlu_trigger,
     validate_patterns_are_not_called_or_linked,
     validate_patterns_are_not_calling_or_linking_other_flows,
     validate_step_ids_are_unique,
-    DuplicatedFlowIdException,
 )
 from rasa.shared.core.slots import Slot
 

rasa/shared/core/flows/flows_yaml_schema.json

@@ -217,6 +217,12 @@
                             "reset_after_flow_ends": {
                                 "type": "boolean"
                             },
+                            "ask_confirm_digressions": {
+                                "$ref": "#/$defs/ask_confirm_digressions"
+                            },
+                            "block_digressions": {
+                                "$ref": "#/$defs/block_digressions"
+                            },
                             "utter": {
                                 "type": "string"
                             },
@@ -247,6 +253,32 @@
                 }
             }
         },
+        "ask_confirm_digressions": {
+            "oneOf": [
+                {
+                    "type": "boolean"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "block_digressions": {
+            "oneOf": [
+                {
+                    "type": "boolean"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
         "flow": {
             "required": [
                 "steps",
@@ -256,9 +288,37 @@
             "additionalProperties": false,
             "schema_name": "dictionary with flow properties",
             "properties": {
+                "name": {
+                    "type": "string"
+                },
                 "description": {
                     "type": "string"
                 },
+                "translation": {
+                    "type": "object",
+                    "schema_name": "flow translation mapping",
+                    "properties": {
+                        "metadata": {
+                            "type": "object"
+                        }
+                    },
+                    "patternProperties": {
+                        "^(?!metadata$).+": {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "required": [
+                                "name"
+                            ],
+                            "properties": {
+                                "name": {
+                                    "type": "string"
+                                },
+                                "metadata": {}
+                            }
+                        }
+                    },
+                    "additionalProperties": false
+                },
                 "if": {
                     "type": [
                         "string",
@@ -268,9 +328,6 @@
                 "always_include_in_prompt": {
                     "type": "boolean"
                 },
-                "name": {
-                    "type": "string"
-                },
                 "nlu_trigger": {
                     "$ref": "#/$defs/nlu_trigger"
                 },
@@ -282,6 +339,15 @@
                 },
                 "persisted_slots": {
                     "$ref": "#/$defs/persisted_slots"
+                },
+                "ask_confirm_digressions": {
+                    "$ref": "#/$defs/ask_confirm_digressions"
+                },
+                "block_digressions": {
+                    "$ref": "#/$defs/block_digressions"
+                },
+                "run_pattern_completed": {
+                    "type": "boolean"
                 }
             }
         },

rasa/shared/core/flows/nlu_trigger.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import List, Dict, Any, Optional
+from typing import Any, Dict, List, Optional
 
 from rasa.shared.exceptions import YamlException
 from rasa.shared.nlu.constants import INTENT, INTENT_NAME_KEY, PREDICTED_CONFIDENCE_KEY

rasa/shared/core/flows/steps/__init__.py

@@ -1,13 +1,13 @@
-from .no_operation import NoOperationFlowStep
 from .action import ActionFlowStep
+from .call import CallFlowStep
 from .collect import CollectInformationFlowStep
 from .continuation import ContinueFlowStep
 from .end import EndFlowStep
 from .internal import InternalFlowStep
 from .link import LinkFlowStep
+from .no_operation import NoOperationFlowStep
 from .set_slots import SetSlotsFlowStep
 from .start import StartFlowStep
-from .call import CallFlowStep
 
 # to make ruff happy and use the imported names
 all_steps = [

rasa/shared/core/flows/steps/action.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional, Text, Dict, Any, Set
+from typing import Any, Dict, Optional, Set, Text
 
 from rasa.shared.constants import UTTER_PREFIX
 from rasa.shared.core.flows.flow_step import FlowStep

rasa/shared/core/flows/steps/call.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Generator, Optional, Text, Dict, Any
+from typing import TYPE_CHECKING, Any, Dict, Generator, Optional, Text
 
 from rasa.shared.core.flows.flow_step import FlowStep
 

rasa/shared/core/flows/steps/collect.py

@@ -1,46 +1,16 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
-from typing import Dict, Any, List, Set, Text
-
-from rasa.shared.constants import UTTER_ASK_PREFIX, ACTION_ASK_PREFIX
+from dataclasses import dataclass, field
+from typing import Any, Dict, List, Set, Text
+
+from rasa.shared.constants import ACTION_ASK_PREFIX, UTTER_ASK_PREFIX
+from rasa.shared.core.constants import (
+    KEY_ASK_CONFIRM_DIGRESSIONS,
+    KEY_BLOCK_DIGRESSIONS,
+)
 from rasa.shared.core.flows.flow_step import FlowStep
-
-
-@dataclass
-class SlotRejection:
-    """A pair of validation condition and an utterance for the case of failure."""
-
-    if_: str
-    """The condition that should be checked."""
-    utter: str
-    """The utterance that should be executed if the condition is met."""
-
-    @staticmethod
-    def from_dict(data: Dict[str, Any]) -> SlotRejection:
-        """Create a SlotRejection object from serialized data.
-
-        Args:
-            data: data for a SlotRejection object in a serialized format
-
-        Returns:
-            A SlotRejection object
-        """
-        return SlotRejection(
-            if_=data["if"],
-            utter=data["utter"],
-        )
-
-    def as_dict(self) -> Dict[str, Any]:
-        """Serialize the SlotRejection object.
-
-        Returns:
-            the SlotRejection object as serialized data
-        """
-        return {
-            "if": self.if_,
-            "utter": self.utter,
-        }
+from rasa.shared.core.flows.utils import extract_digression_prop
+from rasa.shared.core.slots import SlotRejection
 
 
 @dataclass
@@ -59,6 +29,10 @@ class CollectInformationFlowStep(FlowStep):
     """Whether to always ask the question even if the slot is already filled."""
     reset_after_flow_ends: bool = True
     """Whether to reset the slot value at the end of the flow."""
+    ask_confirm_digressions: List[str] = field(default_factory=list)
+    """The flow id digressions for which the assistant should ask for confirmation."""
+    block_digressions: List[str] = field(default_factory=list)
+    """The flow id digressions that should be blocked during the flow step."""
 
     @classmethod
     def from_json(
@@ -86,6 +60,10 @@ class CollectInformationFlowStep(FlowStep):
                 SlotRejection.from_dict(rejection)
                 for rejection in data.get("rejections", [])
             ],
+            ask_confirm_digressions=extract_digression_prop(
+                KEY_ASK_CONFIRM_DIGRESSIONS, data
+            ),
+            block_digressions=extract_digression_prop(KEY_BLOCK_DIGRESSIONS, data),
             **base.__dict__,
         )
 
@@ -101,6 +79,10 @@ class CollectInformationFlowStep(FlowStep):
         data["ask_before_filling"] = self.ask_before_filling
         data["reset_after_flow_ends"] = self.reset_after_flow_ends
         data["rejections"] = [rejection.as_dict() for rejection in self.rejections]
+        data["ask_confirm_digressions"] = self.ask_confirm_digressions
+        data["block_digressions"] = (
+            self.block_digressions if self.block_digressions else False
+        )
 
         return data
 

rasa/shared/core/flows/steps/internal.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Dict, Text, Any
+from typing import Any, Dict, Text
 
 from rasa.shared.core.flows.flow_step import FlowStep
 

rasa/shared/core/flows/steps/link.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Text, Dict, Any
+from typing import Any, Dict, Text
 
 from rasa.shared.core.flows.flow_step import FlowStep
 

rasa/shared/core/flows/steps/no_operation.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
-from dataclasses import dataclass
 
-from typing import Dict, Text, Any
+from dataclasses import dataclass
+from typing import Any, Dict, Text
 
 from rasa.shared.core.flows.flow_step import FlowStep
 

rasa/shared/core/flows/steps/set_slots.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import List, Dict, Any, Text
+from typing import Any, Dict, List, Text
 
 from rasa.shared.core.flows.flow_step import FlowStep
 

rasa/shared/core/flows/utils.py

@@ -1,15 +1,21 @@
-from typing import Set
+from typing import TYPE_CHECKING, Any, Dict, List, Set, Text
+
 from rasa.shared.utils.io import raise_deprecation_warning
 
+if TYPE_CHECKING:
+    from rasa.shared.core.flows.flow import FlowLanguageTranslation
+
+
 RESET_PROPERTY_NAME = "reset_after_flow_ends"
 PERSIST_PROPERTY_NAME = "persisted_slots"
+ALL_LABEL = "ALL"
 
 
-def warn_deprecated_collect_step_config(flow_id: str, collect_step: str) -> None:
+def warn_deprecated_collect_step_config() -> None:
     """Warns about deprecated reset_after_flow_ends usage in collect steps."""
     raise_deprecation_warning(
-        f"Configuring '{RESET_PROPERTY_NAME}' in collect step '{collect_step}' is "
-        f"deprecated and will be removed in Rasa Pro 4.0.0. In flow id '{flow_id}', "
+        f"Configuring '{RESET_PROPERTY_NAME}' in collect steps is "
+        f"deprecated and will be removed in Rasa Pro 4.0.0. In the parent flow, "
         f"please use the '{PERSIST_PROPERTY_NAME}' "
         "property at the flow level instead."
     )
@@ -37,3 +43,37 @@ def get_invalid_slot_persistence_config_error_message(
         f"are neither used in a collect step nor a set_slot step of the flow. "
         f"Please remove such slots from the '{PERSIST_PROPERTY_NAME}' property."
     )
+
+
+def extract_digression_prop(prop: str, data: Dict[str, Any]) -> List[str]:
+    """Extracts the digression property from the data.
+
+    There can be two types of properties: ask_confirm_digressions and
+    block_digressions.
+    """
+    digression_property = data.get(prop, [])
+
+    if isinstance(digression_property, bool):
+        digression_property = [ALL_LABEL] if digression_property else []
+
+    return digression_property
+
+
+def extract_translations(
+    translation_data: Dict[Text, Any],
+) -> Dict[Text, "FlowLanguageTranslation"]:
+    """Extracts translations from a dictionary.
+
+    Args:
+        translation_data: The dictionary containing the translations.
+
+    Returns:
+        A dictionary containing the extracted translations.
+    """
+    from rasa.shared.core.flows.flow import FlowLanguageTranslation
+
+    return {
+        language_code: FlowLanguageTranslation.parse_obj({**data})
+        for language_code, data in translation_data.items()
+        if language_code != "metadata"
+    }

rasa/shared/core/flows/validation.py

@@ -4,13 +4,11 @@ import re
 import typing
 from collections import defaultdict
 from dataclasses import dataclass
-from typing import Optional, Set, Text, List
+from typing import List, Optional, Set, Text
 
 from rasa.shared.constants import (
     RASA_DEFAULT_FLOW_PATTERN_PREFIX,
     RASA_PATTERN_HUMAN_HANDOFF,
-)
-from rasa.shared.constants import (
     RASA_PATTERN_INTERNAL_ERROR,
 )
 from rasa.shared.core.flows.flow import Flow
@@ -19,8 +17,8 @@ from rasa.shared.core.flows.flow_step import (
 )
 from rasa.shared.core.flows.flow_step_links import (
     BranchingFlowStepLink,
-    IfFlowStepLink,
     ElseFlowStepLink,
+    IfFlowStepLink,
 )
 from rasa.shared.core.flows.flow_step_sequence import FlowStepSequence
 from rasa.shared.core.flows.steps.call import CallFlowStep
@@ -29,9 +27,9 @@ from rasa.shared.core.flows.steps.constants import CONTINUE_STEP_PREFIX, DEFAULT
 from rasa.shared.core.flows.steps.link import LinkFlowStep
 from rasa.shared.core.flows.steps.set_slots import SetSlotsFlowStep
 from rasa.shared.core.flows.utils import (
-    warn_deprecated_collect_step_config,
     get_duplicate_slot_persistence_config_error_message,
     get_invalid_slot_persistence_config_error_message,
+    warn_deprecated_collect_step_config,
 )
 from rasa.shared.exceptions import RasaException
 
@@ -725,7 +723,7 @@ def validate_slot_persistence_configuration(flow: Flow) -> None:
             flow_slots.add(step.collect)
             if not step.reset_after_flow_ends:
                 collect_step = step.collect
-                warn_deprecated_collect_step_config(flow_id, collect_step)
+                warn_deprecated_collect_step_config()
                 if has_flow_level_persistence:
                     raise DuplicateSlotPersistConfigException(flow_id, collect_step)
 

rasa/shared/core/generator.py

@@ -1,49 +1,48 @@
-from collections import defaultdict, namedtuple, deque
-
 import copy
 import logging
 import random
+from collections import defaultdict, deque, namedtuple
 from contextlib import contextmanager
-
-from tqdm import tqdm
 from typing import (
-    Optional,
+    Any,
+    DefaultDict,
+    Deque,
+    Dict,
+    Generator,
+    Iterable,
     List,
-    Text,
+    Optional,
     Set,
-    Dict,
+    Text,
     Tuple,
-    Deque,
-    DefaultDict,
-    Any,
-    Iterable,
-    Generator,
 )
 
+from tqdm import tqdm
+
+import rasa.shared.utils.io
 from rasa.shared.constants import DOCS_URL_STORIES
 from rasa.shared.core.constants import SHOULD_NOT_BE_SET
 from rasa.shared.core.domain import Domain, State
 from rasa.shared.core.events import (
     ActionExecuted,
-    UserUttered,
     ActionReverted,
-    UserUtteranceReverted,
-    Restarted,
+    ActiveLoop,
     Event,
+    Restarted,
     SlotSet,
-    ActiveLoop,
+    UserUtteranceReverted,
+    UserUttered,
 )
-from rasa.shared.core.trackers import DialogueStateTracker, FrozenState
 from rasa.shared.core.slots import Slot
+from rasa.shared.core.trackers import DialogueStateTracker, FrozenState
 from rasa.shared.core.training_data.structures import (
-    StoryGraph,
+    GENERATED_CHECKPOINT_PREFIX,
     STORY_START,
-    StoryStep,
     RuleStep,
-    GENERATED_CHECKPOINT_PREFIX,
+    StoryGraph,
+    StoryStep,
 )
 from rasa.shared.utils.io import is_logging_disabled
-import rasa.shared.utils.io
 
 logger = logging.getLogger(__name__)