rasa-pro 3.14.0.dev6__py3-none-any.whl → 3.14.0.dev7__py3-none-any.whl

rasa/dialogue_understanding/commands/cancel_flow_command.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import re
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List
 
 import structlog
 
@@ -16,7 +16,6 @@ from rasa.dialogue_understanding.commands.command_syntax_manager import (
 )
 from rasa.dialogue_understanding.patterns.cancel import CancelPatternFlowStackFrame
 from rasa.dialogue_understanding.stack.dialogue_stack import DialogueStack
-from rasa.dialogue_understanding.stack.frames import DialogueStackFrame
 from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
     FlowStackFrameType,
     UserFlowStackFrame,
@@ -74,8 +73,7 @@ class CancelFlowCommand(Command):
             # we should never get here as we should always find the user flow
             # that was canceled.
             raise ValueError(
-                f"Could not find a user flow frame to cancel. "
-                f"Current stack: {stack}."
+                f"Could not find a user flow frame to cancel. Current stack: {stack}."
             )
 
     def run_command_on_tracker(
@@ -175,80 +173,3 @@ class CancelFlowCommand(Command):
             CommandSyntaxManager.get_syntax_version(),
             mapper[CommandSyntaxManager.get_default_syntax_version()],
         )
-
-    def cancel_flow(
-        self,
-        tracker: DialogueStateTracker,
-        stack: DialogueStack,
-        flow_id: str,
-    ) -> List[Event]:
-        """Cancels a flow by flow id."""
-        applied_events: List[Event] = []
-
-        frames_to_cancel, user_frame_to_cancel = self._collect_frames_to_cancel(
-            stack, flow_id
-        )
-
-        # if the flow is not on the stack, do nothing
-        if user_frame_to_cancel is None:
-            structlogger.error(
-                "cancel_flow_command.cancel_flow.no_user_frame_to_cancel",
-                command=self,
-            )
-            return []
-
-        frames_ids_to_cancel = [frame.frame_id for frame in frames_to_cancel]
-
-        stack.push(
-            CancelPatternFlowStackFrame(
-                canceled_name=flow_id,
-                canceled_frames=frames_ids_to_cancel,
-            )
-        )
-
-        # create flow cancelled event
-        applied_events.extend(
-            [
-                FlowCancelled(
-                    user_frame_to_cancel.flow_id, user_frame_to_cancel.step_id
-                ),
-            ]
-        )
-
-        update_stack_events = tracker.create_stack_updated_events(stack)
-
-        return applied_events + update_stack_events
-
-    def _collect_frames_to_cancel(
-        self, stack: DialogueStack, target_flow_id: str
-    ) -> Tuple[List[DialogueStackFrame], Optional[UserFlowStackFrame]]:
-        """Collect frames that need to be cancelled.
-
-        Args:
-            stack: The stack to collect frames from.
-            target_flow_id: The ID of the flow to cancel.
-
-        Returns:
-            A tuple containing (frames_to_cancel, frame_to_cancel).
-        """
-        frames_to_cancel: List[DialogueStackFrame] = []
-        frame_found = False
-        frame_to_cancel = None
-
-        for frame in stack.frames:
-            if isinstance(frame, UserFlowStackFrame) and (
-                frame.frame_type == FlowStackFrameType.REGULAR
-                or frame.frame_type == FlowStackFrameType.INTERRUPT
-            ):
-                if frame.flow_id == target_flow_id:
-                    frames_to_cancel.append(frame)
-                    frame_to_cancel = frame
-                    frame_found = True
-                    continue
-                elif frame_found:
-                    break
-
-            if frame_found:
-                frames_to_cancel.append(frame)
-
-        return list(frames_to_cancel), frame_to_cancel

rasa/dialogue_understanding/commands/start_flow_command.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import re
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional
 
 import structlog
 
@@ -11,17 +11,15 @@ from rasa.dialogue_understanding.commands.command_syntax_manager import (
     CommandSyntaxManager,
     CommandSyntaxVersion,
 )
-from rasa.dialogue_understanding.stack.dialogue_stack import DialogueStack
-from rasa.dialogue_understanding.stack.frames.dialogue_stack_frame import (
-    DialogueStackFrame,
+from rasa.dialogue_understanding.commands.utils import (
+    remove_pattern_continue_interrupted_frames,
+    resume_flow,
 )
 from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
-    AgentStackFrame,
     AgentState,
     FlowStackFrameType,
     UserFlowStackFrame,
 )
-from rasa.dialogue_understanding.stack.frames.pattern_frame import PatternFlowStackFrame
 from rasa.dialogue_understanding.stack.utils import (
     is_continue_interrupted_flow_active,
     top_user_flow_frame,
@@ -29,10 +27,8 @@ from rasa.dialogue_understanding.stack.utils import (
 )
 from rasa.shared.core.events import (
     AgentInterrupted,
-    AgentResumed,
     Event,
     FlowInterrupted,
-    FlowResumed,
 )
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
@@ -108,7 +104,7 @@ class StartFlowCommand(Command):
             # predicted a start flow command for the flow which is on top of the stack,
             # we just need to remove the pattern_continue_interrupted frame(s) from the
             # stack
-            stack = _remove_pattern_continue_interrupted_frames(stack)
+            stack = remove_pattern_continue_interrupted_frames(stack)
             return applied_events + tracker.create_stack_updated_events(stack)
 
         # if the flow is already on the stack, resume it
@@ -118,11 +114,22 @@ class StartFlowCommand(Command):
         ):
             # if pattern_continue_interrupted is active, we need to remove it
             # from the stack before resuming the flow
-            stack = _remove_pattern_continue_interrupted_frames(stack)
-            return self.resume_flow(tracker, stack, original_user_frame)
+            stack = remove_pattern_continue_interrupted_frames(stack)
+            applied_events.extend(resume_flow(self.flow, tracker, stack))
+            # the current active flow is interrupted
+            applied_events.append(
+                FlowInterrupted(
+                    original_user_frame.flow_id, original_user_frame.step_id
+                )
+            )
+            return applied_events
 
         frame_type = FlowStackFrameType.REGULAR
 
+        # remove the pattern_continue_interrupted frames from the stack
+        # if it is currently active but the user digressed from the pattern
+        stack = remove_pattern_continue_interrupted_frames(stack)
+
         if original_top_flow:
             # if the original top flow is not the same as the flow to start,
             # interrupt the current active flow
@@ -198,105 +205,3 @@ class StartFlowCommand(Command):
             CommandSyntaxManager.get_syntax_version(),
             mapper[CommandSyntaxManager.get_default_syntax_version()],
         )
-
-    def resume_flow(
-        self,
-        tracker: DialogueStateTracker,
-        stack: DialogueStack,
-        original_user_frame: UserFlowStackFrame,
-    ) -> List[Event]:
-        """Resumes a flow by reordering frames."""
-        applied_events: List[Event] = []
-
-        # Resume existing flow by reordering frames
-        frames_to_resume, user_frame_to_resume = self._collect_frames_to_resume(
-            stack, self.flow
-        )
-
-        # if the flow is not on the stack, do nothing
-        # this should not happen, but just in case
-        if user_frame_to_resume is None:
-            structlogger.error(
-                "start_flow_command.resume_flow.no_user_frame_to_resume",
-                command=self,
-            )
-            return []
-
-        # move the frames to the top of the stack, e.g. reorder the frames
-        # on the stack
-        stack.move_frames_to_top(frames_to_resume)
-        agent_stack_frame = next(
-            (frame for frame in frames_to_resume if isinstance(frame, AgentStackFrame)),
-            None,
-        )
-        if agent_stack_frame:
-            agent_id = agent_stack_frame.agent_id
-            applied_events.append(AgentResumed(agent_id, agent_stack_frame.flow_id))
-
-        # Create flow interruption and resumption events
-        applied_events.extend(
-            [
-                # the current active flow is interrupted
-                FlowInterrupted(
-                    original_user_frame.flow_id, original_user_frame.step_id
-                ),
-                # the flow, which was on the stack, is resumed
-                FlowResumed(user_frame_to_resume.flow_id, user_frame_to_resume.step_id),
-            ]
-        )
-
-        return applied_events + tracker.create_stack_updated_events(stack)
-
-    def _collect_frames_to_resume(
-        self, stack: DialogueStack, target_flow_id: str
-    ) -> Tuple[List[DialogueStackFrame], Optional[UserFlowStackFrame]]:
-        """Collect frames that need to be resumed for the target flow.
-
-        Args:
-            stack: The stack to collect frames from.
-            target_flow_id: The ID of the flow to resume.
-
-        Returns:
-            A tuple containing (frames_to_resume, frame_to_resume).
-        """
-        frames_to_resume: List[DialogueStackFrame] = []
-        frame_found = False
-        frame_to_resume = None
-
-        for frame in stack.frames:
-            if isinstance(frame, UserFlowStackFrame) and (
-                frame.frame_type == FlowStackFrameType.REGULAR
-                or frame.frame_type == FlowStackFrameType.INTERRUPT
-            ):
-                if frame.flow_id == target_flow_id:
-                    frames_to_resume.append(frame)
-                    frame_to_resume = frame
-                    frame_found = True
-                    continue
-                elif frame_found:
-                    break
-
-            if frame_found:
-                frames_to_resume.append(frame)
-
-        return list(frames_to_resume), frame_to_resume
-
-
-def _remove_pattern_continue_interrupted_frames(stack: DialogueStack) -> DialogueStack:
-    """Remove pattern_continue_interrupted frames from the stack."""
-    if not is_continue_interrupted_flow_active(stack):
-        return stack
-
-    # remove pattern_continue_interrupted from the stack
-    top_frame = stack.top()
-    while isinstance(top_frame, PatternFlowStackFrame):
-        # If the top frame is a pattern frame, we need to remove it
-        # before continuing with the active user flow frame.
-        # This prevents the pattern frame
-        # from being left on the stack when the flow is started
-        # which would prevent pattern_completed to be triggered
-        # once the user flow is completed.
-        stack.pop()
-        top_frame = stack.top()
-
-    return stack

rasa/dialogue_understanding/commands/utils.py

@@ -5,9 +5,21 @@ import structlog
 from rasa.dialogue_understanding.patterns.validate_slot import (
     ValidateSlotPatternFlowStackFrame,
 )
+from rasa.dialogue_understanding.stack.dialogue_stack import DialogueStack
+from rasa.dialogue_understanding.stack.frames.dialogue_stack_frame import (
+    DialogueStackFrame,
+)
+from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
+    AgentStackFrame,
+    FlowStackFrameType,
+    UserFlowStackFrame,
+)
+from rasa.dialogue_understanding.stack.frames.pattern_frame import PatternFlowStackFrame
 from rasa.shared.constants import ACTION_ASK_PREFIX, UTTER_ASK_PREFIX
 from rasa.shared.core.events import (
+    AgentResumed,
     Event,
+    FlowResumed,
     SlotSet,
 )
 from rasa.shared.core.flows import FlowsList
@@ -154,3 +166,109 @@ def find_default_flows_collecting_slot(
             for step in flow.get_collect_steps()
         )
     ]
+
+
+def resume_flow(
+    flow_to_resume: str,
+    tracker: DialogueStateTracker,
+    stack: DialogueStack,
+) -> List[Event]:
+    """Resumes a flow by reordering frames."""
+    applied_events: List[Event] = []
+
+    # Resume existing flow by reordering frames
+    frames_to_resume, user_frame_to_resume = collect_frames_to_resume(
+        stack, flow_to_resume
+    )
+
+    # if the flow is not on the stack, do nothing
+    # this should not happen, but just in case
+    if user_frame_to_resume is None:
+        structlogger.error(
+            "resume_flow.no_user_frame_to_resume",
+            flow_to_resume=flow_to_resume,
+        )
+        return []
+
+    # move the frames to the top of the stack, e.g. reorder the frames
+    # on the stack
+    stack.move_frames_to_top(frames_to_resume)
+
+    # create agent resumed events if the agent frame is now on top of the stack
+    agent_stack_frame = next(
+        (frame for frame in frames_to_resume if isinstance(frame, AgentStackFrame)),
+        None,
+    )
+    if agent_stack_frame:
+        agent_id = agent_stack_frame.agent_id
+        applied_events.append(AgentResumed(agent_id, agent_stack_frame.flow_id))
+
+    # Create flow interruption and resumption events
+    applied_events.extend(
+        [
+            # the flow, which was on the stack, is resumed
+            FlowResumed(user_frame_to_resume.flow_id, user_frame_to_resume.step_id),
+        ]
+    )
+
+    return applied_events + tracker.create_stack_updated_events(stack)
+
+
+def collect_frames_to_resume(
+    stack: DialogueStack,
+    target_flow_id: str,  # pyright: ignore[reportUndefinedVariable]
+) -> Tuple[List[DialogueStackFrame], Optional[UserFlowStackFrame]]:
+    """Collect frames that need to be resumed for the target flow.
+
+    Args:
+        stack: The stack to collect frames from.
+        target_flow_id: The ID of the flow to resume.
+
+    Returns:
+        A tuple containing (frames_to_resume, frame_to_resume).
+    """
+    frames_to_resume: List[DialogueStackFrame] = []
+    frame_found = False
+    frame_to_resume = None
+
+    for frame in stack.frames:
+        if isinstance(frame, UserFlowStackFrame) and (
+            frame.frame_type == FlowStackFrameType.REGULAR
+            or frame.frame_type == FlowStackFrameType.INTERRUPT
+        ):
+            if frame.flow_id == target_flow_id:
+                frames_to_resume.append(frame)
+                frame_to_resume = frame
+                frame_found = True
+                continue
+            elif frame_found:
+                break
+
+        if frame_found:
+            frames_to_resume.append(frame)
+
+    return list(frames_to_resume), frame_to_resume
+
+
+def remove_pattern_continue_interrupted_frames(stack: DialogueStack) -> DialogueStack:
+    """Remove pattern_continue_interrupted frames from the stack."""
+    from rasa.dialogue_understanding.stack.utils import (
+        is_continue_interrupted_flow_active,
+    )
+
+    if not is_continue_interrupted_flow_active(stack):
+        return stack
+
+    # remove pattern_continue_interrupted from the stack
+    top_frame = stack.top()
+    while isinstance(top_frame, PatternFlowStackFrame):
+        # If the top frame is a pattern frame, we need to remove it
+        # before continuing with the active user flow frame.
+        # This prevents the pattern frame
+        # from being left on the stack when the flow is started
+        # which would prevent pattern_completed to be triggered
+        # once the user flow is completed.
+        stack.pop()
+        top_frame = stack.top()
+
+    return stack

rasa/dialogue_understanding/patterns/clarify.py

@@ -61,19 +61,6 @@ class ActionClarifyFlows(action.Action):
         """Return the flow name."""
         return ACTION_CLARIFY_FLOWS
 
-    @staticmethod
-    def assemble_options_string(names: List[str]) -> str:
-        """Concatenate options to a human-readable string."""
-        clarification_message = ""
-        for i, name in enumerate(names):
-            if i == 0:
-                clarification_message += name
-            elif i == len(names) - 1:
-                clarification_message += f" or {name}"
-            else:
-                clarification_message += f", {name}"
-        return clarification_message
-
     async def run(
         self,
         output_channel: "OutputChannel",
@@ -83,6 +70,8 @@ class ActionClarifyFlows(action.Action):
         metadata: Optional[Dict[str, Any]] = None,
     ) -> List[Event]:
         """Correct the slots."""
+        from rasa.dialogue_understanding.utils import assemble_options_string
+
         stack = tracker.stack
         if not (top := stack.top()):
             structlogger.warning("action.clarify_flows.no_active_flow")
@@ -92,7 +81,7 @@ class ActionClarifyFlows(action.Action):
             structlogger.warning("action.clarify_flows.no_clarification_frame")
             return []
 
-        options_string = self.assemble_options_string(top.names)
+        options_string = assemble_options_string(top.names, conjunction="or")
         top.clarification_options = options_string
         # since we modified the stack frame, we need to update the stack
         return tracker.create_stack_updated_events(stack)