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

rasa/dialogue_understanding/patterns/correction.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
+
 from dataclasses import dataclass, field
-from typing import Any, Dict, Text, List, Optional
+from typing import Any, Dict, List, Optional, Text
 
 import structlog
+
 from rasa.core.actions import action
 from rasa.core.channels import OutputChannel
 from rasa.core.nlg import NaturalLanguageGenerator
@@ -26,7 +28,7 @@ from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
 from rasa.shared.core.constants import ACTION_CORRECT_FLOW_SLOT
 from rasa.shared.core.domain import Domain
 from rasa.shared.core.events import Event, SlotSet
-from rasa.shared.core.flows.flow import ContinueFlowStep, END_STEP, START_STEP
+from rasa.shared.core.flows.flow import END_STEP, START_STEP, ContinueFlowStep
 from rasa.shared.core.trackers import DialogueStateTracker
 
 structlogger = structlog.get_logger()
@@ -52,6 +54,8 @@ class CorrectionPatternFlowStackFrame(PatternFlowStackFrame):
     """The ID of the flow to reset to."""
     reset_step_id: Optional[str] = None
     """The ID of the step to reset to."""
+    new_slot_values: List[Any] = field(default_factory=list)
+    """The new values for the corrected slots."""
 
     @classmethod
     def type(cls) -> str:
@@ -68,6 +72,10 @@ class CorrectionPatternFlowStackFrame(PatternFlowStackFrame):
         Returns:
             The created `DialogueStackFrame`.
         """
+        new_slot_values = [
+            val.get("value") for _, val in data["corrected_slots"].items()
+        ]
+
         return CorrectionPatternFlowStackFrame(
             frame_id=data["frame_id"],
             step_id=data["step_id"],
@@ -75,6 +83,7 @@ class CorrectionPatternFlowStackFrame(PatternFlowStackFrame):
             corrected_slots=data["corrected_slots"],
             reset_flow_id=data["reset_flow_id"],
             reset_step_id=data["reset_step_id"],
+            new_slot_values=new_slot_values,
         )
 
 
@@ -116,7 +125,12 @@ class ActionCorrectFlowSlot(action.Action):
             )
             events.extend(tracker.create_stack_updated_events(updated_stack))
 
-        events.extend([SlotSet(k, v) for k, v in top.corrected_slots.items()])
+        events.extend(
+            [
+                SlotSet(name, value=val.get("value"), filled_by=val.get("filled_by"))
+                for name, val in top.corrected_slots.items()
+            ]
+        )
         return events
 
 

rasa/dialogue_understanding/patterns/default_flows_for_patterns.yml

@@ -1,6 +1,17 @@
 version: "3.1"
 responses:
 
+  utter_ask_continue_previous_flow:
+    - text: "Confirm if you would like to continue with the initial topic: {{context.interrupted_flow_id}}?"
+      metadata:
+        rephrase: True
+        template: jinja
+      buttons:
+        - title: Continue with the previous topic.
+          payload: /SetSlots(continue_previous_flow=True)
+        - title: Switch to new topic.
+          payload: /SetSlots(continue_previous_flow=False)
+
   utter_ask_rephrase:
     - text: I’m sorry I am unable to understand you, could you please rephrase?
 
@@ -9,6 +20,20 @@ responses:
       metadata:
         rephrase: True
 
+  utter_block_digressions:
+    - text: "We can look into {{ context.interrupting_flow_id }} later. Let's focus on the current topic: {{ context.interrupted_flow_id }}."
+      metadata:
+        rephrase: True
+        template: jinja
+    - text: "Let's continue with the current topic: {{ context.interrupted_flow_id }}."
+      condition:
+        - type: slot
+          name: continue_previous_flow
+          value: True
+      metadata:
+        rephrase: True
+        template: jinja
+
   utter_boolean_slot_rejection:
     - text: "Sorry, the value you provided, `{{value}}`, is not valid. Please respond with a valid value."
       metadata:
@@ -35,8 +60,14 @@ responses:
         rephrase: True
         template: jinja
 
+  utter_continue_interruption:
+    - text: "Let's continue with the chosen topic instead: {{ context.interrupting_flow_id }}."
+      metadata:
+        rephrase: True
+        template: jinja
+
   utter_corrected_previous_input:
-    - text: "Ok, I am updating {{ context.corrected_slots.keys()|join(', ') }} to {{ context.corrected_slots.values()|join(', ') }} respectively."
+    - text: "Ok, I am updating {{ context.corrected_slots.keys()|join(', ') }} to {{ context.new_slot_values | join(', ') }} respectively."
       metadata:
         rephrase: True
         template: jinja
@@ -119,7 +150,10 @@ slots:
     type: float
     initial_value: 0.0
     max_value: 1000000
-
+  continue_previous_flow:
+    type: bool
+    mappings:
+      - type: from_llm
 
 flows:
   pattern_cancel_flow:
@@ -163,6 +197,7 @@ flows:
     steps:
       - action: action_clarify_flows
       - action: utter_clarification_options_rasa
+      - action: action_listen
 
   pattern_code_change:
     description: Conversation repair flow for cleaning the stack after an assistant update
@@ -212,6 +247,31 @@ flows:
                 next: END
           - else: END
 
+  pattern_handle_digressions:
+    description: Conversation repair flow for handling digressions
+    name: pattern handle digressions
+    steps:
+      - noop: true
+        id: branching
+        next:
+          - if: context.ask_confirm_digressions contains context.interrupting_flow_id
+            then: continue_previous_flow
+          - if: context.block_digressions contains context.interrupting_flow_id
+            then: block_digression
+          - else: continue_digression
+      - id: continue_previous_flow
+        collect: continue_previous_flow
+        next:
+          - if: slots.continue_previous_flow
+            then: block_digression
+          - else: continue_digression
+      - id: block_digression
+        action: action_block_digression
+        next: END
+      - id: continue_digression
+        action: action_continue_digression
+        next: END
+
   pattern_human_handoff:
     description: Conversation repair flow for switching users to a human agent if their request can't be handled
     name: pattern human handoff
@@ -299,3 +359,19 @@ flows:
               - action: action_hangup
                 next: END
           - else: END
+
+  pattern_validate_slot:
+    description: Flow for running validations on slots
+    name: pattern validate slot
+    steps:
+      - id: start
+        action: action_run_slot_rejections
+        next:
+          - if: "slots.{{context.validate}} is not null"
+            then: END
+          - else: ask_refill
+      - id: ask_refill
+        action: "{{context.refill_utter}}"
+      - action: "{{context.refill_action}}"
+      - action: action_listen
+        next: start

rasa/dialogue_understanding/patterns/handle_digressions.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any, Dict, Set
+
+from rasa.dialogue_understanding.stack.frames import PatternFlowStackFrame
+from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
+from rasa.shared.core.constants import (
+    KEY_ASK_CONFIRM_DIGRESSIONS,
+    KEY_BLOCK_DIGRESSIONS,
+)
+
+FLOW_PATTERN_HANDLE_DIGRESSIONS = (
+    RASA_DEFAULT_FLOW_PATTERN_PREFIX + "handle_digressions"
+)
+
+
+@dataclass
+class HandleDigressionsPatternFlowStackFrame(PatternFlowStackFrame):
+    """A pattern flow stack frame that gets added if an interruption is completed."""
+
+    flow_id: str = FLOW_PATTERN_HANDLE_DIGRESSIONS
+    """The ID of the flow."""
+    interrupting_flow_id: str = ""
+    """The ID of the flow that interrupted the active flow."""
+    interrupted_flow_id: str = ""
+    """The name of the active flow that was interrupted."""
+    interrupted_step_id: str = ""
+    """The ID of the step that was interrupted."""
+    ask_confirm_digressions: Set[str] = field(default_factory=set)
+    """The set of interrupting flow names to confirm."""
+    block_digressions: Set[str] = field(default_factory=set)
+    """The set of interrupting flow names to block."""
+
+    @classmethod
+    def type(cls) -> str:
+        """Returns the type of the frame."""
+        return FLOW_PATTERN_HANDLE_DIGRESSIONS
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> HandleDigressionsPatternFlowStackFrame:
+        """Creates a `DialogueStackFrame` from a dictionary.
+
+        Args:
+            data: The dictionary to create the `DialogueStackFrame` from.
+
+        Returns:
+            The created `DialogueStackFrame`.
+        """
+        return HandleDigressionsPatternFlowStackFrame(
+            frame_id=data["frame_id"],
+            step_id=data["step_id"],
+            interrupted_step_id=data["interrupted_step_id"],
+            interrupted_flow_id=data["interrupted_flow_id"],
+            interrupting_flow_id=data["interrupting_flow_id"],
+            ask_confirm_digressions=set(data.get(KEY_ASK_CONFIRM_DIGRESSIONS, [])),
+            # This attribute must be converted to a set to enable usage
+            # of subset `contains` pypred operator in the default pattern
+            # conditional branching
+            block_digressions=set(data.get(KEY_BLOCK_DIGRESSIONS, [])),
+        )
+
+    def __eq__(self, other: Any) -> bool:
+        if not isinstance(other, HandleDigressionsPatternFlowStackFrame):
+            return False
+        return (
+            self.flow_id == other.flow_id
+            and self.interrupted_step_id == other.interrupted_step_id
+            and self.interrupted_flow_id == other.interrupted_flow_id
+            and self.interrupting_flow_id == other.interrupting_flow_id
+            and self.ask_confirm_digressions == other.ask_confirm_digressions
+            and self.block_digressions == other.block_digressions
+        )
+
+    def as_dict(self) -> Dict[str, Any]:
+        """Returns the frame as a dictionary."""
+        data = super().as_dict()
+        # converting back to list to avoid serialization issues
+        data[KEY_ASK_CONFIRM_DIGRESSIONS] = list(self.ask_confirm_digressions)
+        data[KEY_BLOCK_DIGRESSIONS] = list(self.block_digressions)
+        return data

rasa/dialogue_understanding/patterns/human_handoff.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import Any, Dict
 
 from rasa.dialogue_understanding.stack.frames import PatternFlowStackFrame
 from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
 
-
 FLOW_PATTERN_HUMAN_HANDOFF = RASA_DEFAULT_FLOW_PATTERN_PREFIX + "human_handoff"
 
 

rasa/dialogue_understanding/patterns/internal_error.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from dataclasses import dataclass, field
 from typing import Any, Dict, Optional, Text
 

rasa/dialogue_understanding/patterns/search.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import Any, Dict
 
 from rasa.dialogue_understanding.stack.frames import PatternFlowStackFrame
 from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
 
-
 FLOW_PATTERN_SEARCH = RASA_DEFAULT_FLOW_PATTERN_PREFIX + "search"
 
 

rasa/dialogue_understanding/patterns/session_start.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import Any, Dict
 
 from rasa.dialogue_understanding.stack.frames import PatternFlowStackFrame
 from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
 
-
 FLOW_PATTERN_SESSION_START = RASA_DEFAULT_FLOW_PATTERN_PREFIX + "session_start"
 
 

rasa/dialogue_understanding/patterns/skip_question.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import Any, Dict
 

rasa/dialogue_understanding/patterns/user_silence.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import Any, Dict
 
 from rasa.dialogue_understanding.stack.frames import PatternFlowStackFrame
 from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
 
-
 FLOW_PATTERN_USER_SILENCE = RASA_DEFAULT_FLOW_PATTERN_PREFIX + "user_silence"
 
 

rasa/dialogue_understanding/patterns/validate_slot.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any, Dict, List
+
+from rasa.dialogue_understanding.stack.frames import (
+    PatternFlowStackFrame,
+)
+from rasa.shared.constants import (
+    RASA_DEFAULT_FLOW_PATTERN_PREFIX,
+    REFILL_UTTER,
+    REJECTIONS,
+)
+from rasa.shared.core.slots import SlotRejection
+
+FLOW_PATTERN_VALIDATE_SLOT = RASA_DEFAULT_FLOW_PATTERN_PREFIX + "validate_slot"
+
+
+@dataclass
+class ValidateSlotPatternFlowStackFrame(PatternFlowStackFrame):
+    """A pattern flow stack frame to validate slots."""
+
+    flow_id: str = FLOW_PATTERN_VALIDATE_SLOT
+    """The ID of the flow."""
+    validate: str = ""
+    """The slot that should be validated."""
+    refill_utter: str = ""
+    """The utter action that should be executed to ask the user to refill the
+    information."""
+    refill_action: str = ""
+    """The action that should be executed to ask the user to refill the
+    information."""
+    rejections: List[SlotRejection] = field(default_factory=list)
+    """The predicate check that should be applied to the filled slot.
+    If a predicate check fails, its `utter` action indicated under rejections
+    will be executed.
+    """
+
+    @classmethod
+    def type(cls) -> str:
+        """Returns the type of the frame."""
+        return FLOW_PATTERN_VALIDATE_SLOT
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> ValidateSlotPatternFlowStackFrame:
+        """Creates a `DialogueStackFrame` from a dictionary.
+
+        Args:
+            data: The dictionary to create the `DialogueStackFrame` from.
+
+        Returns:
+            The created `DialogueStackFrame`.
+        """
+        rejections = [
+            SlotRejection.from_dict(rejection) for rejection in data.get(REJECTIONS, [])
+        ]
+
+        return ValidateSlotPatternFlowStackFrame(
+            frame_id=data["frame_id"],
+            step_id=data["step_id"],
+            validate=data["validate"],
+            refill_action=data["refill_action"],
+            refill_utter=data[REFILL_UTTER],
+            rejections=rejections,
+        )