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

rasa/dialogue_understanding/commands/__init__.py

@@ -8,6 +8,9 @@ from rasa.dialogue_understanding.commands.chit_chat_answer_command import (
 )
 from rasa.dialogue_understanding.commands.clarify_command import ClarifyCommand
 from rasa.dialogue_understanding.commands.command import Command
+from rasa.dialogue_understanding.commands.continue_agent_command import (
+    ContinueAgentCommand,
+)
 from rasa.dialogue_understanding.commands.correct_slots_command import (
     CorrectedSlot,
     CorrectSlotsCommand,
@@ -29,6 +32,9 @@ from rasa.dialogue_understanding.commands.noop_command import NoopCommand
 from rasa.dialogue_understanding.commands.repeat_bot_messages_command import (
     RepeatBotMessagesCommand,
 )
+from rasa.dialogue_understanding.commands.restart_agent_command import (
+    RestartAgentCommand,
+)
 from rasa.dialogue_understanding.commands.restart_command import RestartCommand
 from rasa.dialogue_understanding.commands.session_end_command import SessionEndCommand
 from rasa.dialogue_understanding.commands.session_start_command import (
@@ -62,4 +68,6 @@ __all__ = [
     "SessionEndCommand",
     "RepeatBotMessagesCommand",
     "RestartCommand",
+    "ContinueAgentCommand",
+    "RestartAgentCommand",
 ]

rasa/dialogue_understanding/commands/cancel_flow_command.py

@@ -2,10 +2,13 @@ from __future__ import annotations
 
 import re
 from dataclasses import dataclass
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional, Tuple
 
 import structlog
 
+from rasa.core.policies.flows.flow_executor import (
+    remove_agent_stack_frame,
+)
 from rasa.dialogue_understanding.commands.command import Command
 from rasa.dialogue_understanding.commands.command_syntax_manager import (
     CommandSyntaxManager,
@@ -13,12 +16,13 @@ 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,
 )
 from rasa.dialogue_understanding.stack.utils import top_user_flow_frame
-from rasa.shared.core.events import Event, FlowCancelled
+from rasa.shared.core.events import AgentCancelled, Event, FlowCancelled
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
 
@@ -48,8 +52,7 @@ class CancelFlowCommand(Command):
         """Selects the frames that were canceled.
 
         Args:
-            dialogue_stack: The dialogue stack.
-            current_flow: The current flow.
+            stack: The dialogue stack.
 
         Returns:
         The frames that were canceled.
@@ -106,6 +109,19 @@ class CancelFlowCommand(Command):
             )
             return []
 
+        if agent_frame := original_tracker.stack.find_active_agent_stack_frame_for_flow(
+            current_flow.id
+        ):
+            structlogger.debug(
+                "cancel_command.remove_agent_stack_frame",
+                command=self,
+                frame=agent_frame,
+            )
+            remove_agent_stack_frame(stack, agent_frame.agent_id)
+            applied_events.append(
+                AgentCancelled(agent_id=agent_frame.agent_id, flow_id=current_flow.id)
+            )
+
         # we pass in the original dialogue stack (before any of the currently
         # predicted commands were applied) to make sure we don't cancel any
         # frames that were added by the currently predicted commands.
@@ -159,3 +175,80 @@ 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/chit_chat_answer_command.py

@@ -12,6 +12,10 @@ from rasa.dialogue_understanding.commands.free_form_answer_command import (
     FreeFormAnswerCommand,
 )
 from rasa.dialogue_understanding.patterns.chitchat import ChitchatPatternFlowStackFrame
+from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
+    AgentStackFrame,
+    AgentState,
+)
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
@@ -52,6 +56,13 @@ class ChitChatAnswerCommand(FreeFormAnswerCommand):
             The events to apply to the tracker.
         """
         stack = tracker.stack
+
+        # if the top stack frame is an agent stack frame, we need to
+        # update the state to INTERRUPTED
+        if top_stack_frame := stack.top():
+            if isinstance(top_stack_frame, AgentStackFrame):
+                top_stack_frame.state = AgentState.INTERRUPTED
+
         stack.push(ChitchatPatternFlowStackFrame())
         return tracker.create_stack_updated_events(stack)
 

rasa/dialogue_understanding/commands/clarify_command.py

@@ -13,6 +13,10 @@ from rasa.dialogue_understanding.commands.command_syntax_manager import (
 )
 from rasa.dialogue_understanding.commands.utils import extract_cleaned_options
 from rasa.dialogue_understanding.patterns.clarify import ClarifyPatternFlowStackFrame
+from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
+    AgentStackFrame,
+    AgentState,
+)
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
@@ -85,6 +89,12 @@ class ClarifyCommand(Command):
             if flow is not None
         ]
 
+        # if the top stack frame is an agent stack frame, we need to
+        # update the state to INTERRUPTED
+        if top_stack_frame := stack.top():
+            if isinstance(top_stack_frame, AgentStackFrame):
+                top_stack_frame.state = AgentState.INTERRUPTED
+
         stack.push(ClarifyPatternFlowStackFrame(names=names))
         return tracker.create_stack_updated_events(stack)
 

rasa/dialogue_understanding/commands/continue_agent_command.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass
+from typing import Any, Dict, List
+
+import structlog
+
+from rasa.dialogue_understanding.commands.command import Command
+from rasa.dialogue_understanding.commands.command_syntax_manager import (
+    CommandSyntaxManager,
+    CommandSyntaxVersion,
+)
+from rasa.shared.core.events import Event
+from rasa.shared.core.flows import FlowsList
+from rasa.shared.core.trackers import DialogueStateTracker
+
+structlogger = structlog.get_logger()
+
+
+@dataclass
+class ContinueAgentCommand(Command):
+    """A command to continue the currently active agent's execution."""
+
+    @classmethod
+    def command(cls) -> str:
+        """Returns the command type."""
+        return "continue agent"
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> ContinueAgentCommand:
+        """Converts the dictionary to a command.
+
+        Returns:
+            The converted dictionary.
+        """
+        return ContinueAgentCommand()
+
+    def run_command_on_tracker(
+        self,
+        tracker: DialogueStateTracker,
+        all_flows: FlowsList,
+        original_tracker: DialogueStateTracker,
+    ) -> List[Event]:
+        """Runs the command on the tracker.
+
+        Args:
+            tracker: The tracker to run the command on.
+            all_flows: All flows in the assistant.
+            original_tracker: The tracker before any command was executed.
+
+        Returns:
+            The events to apply to the tracker.
+        """
+        # do nothing
+        return []
+
+    def __hash__(self) -> int:
+        return hash(self.command())
+
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, ContinueAgentCommand)
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: "ContinueAgent()",
+            CommandSyntaxVersion.v2: "continue agent",
+            CommandSyntaxVersion.v3: "continue agent",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @classmethod
+    def from_dsl(cls, match: re.Match, **kwargs: Any) -> ContinueAgentCommand:
+        """Converts a DSL string to a command."""
+        return ContinueAgentCommand()
+
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"ContinueAgent\(\)",
+            CommandSyntaxVersion.v2: r"""^[\s\W\d]*continue agent['"`]*$""",
+            CommandSyntaxVersion.v3: r"""^[\s\W\d]*continue agent['"`]*$""",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/knowledge_answer_command.py

@@ -12,6 +12,10 @@ from rasa.dialogue_understanding.commands.free_form_answer_command import (
     FreeFormAnswerCommand,
 )
 from rasa.dialogue_understanding.patterns.search import SearchPatternFlowStackFrame
+from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
+    AgentStackFrame,
+    AgentState,
+)
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
@@ -52,6 +56,13 @@ class KnowledgeAnswerCommand(FreeFormAnswerCommand):
             The events to apply to the tracker.
         """
         stack = tracker.stack
+
+        # if the top stack frame is an agent stack frame, we need to
+        # update the state to INTERRUPTED
+        if top_stack_frame := stack.top():
+            if isinstance(top_stack_frame, AgentStackFrame):
+                top_stack_frame.state = AgentState.INTERRUPTED
+
         stack.push(SearchPatternFlowStackFrame())
         return tracker.create_stack_updated_events(stack)
 

rasa/dialogue_understanding/commands/restart_agent_command.py

@@ -0,0 +1,162 @@
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass
+from typing import Any, Dict, List, Optional
+
+from rasa.dialogue_understanding.commands.command import Command
+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.flow_stack_frame import (
+    AgentStackFrame,
+    AgentState,
+)
+from rasa.shared.core.events import AgentStarted, Event
+from rasa.shared.core.flows import FlowsList
+from rasa.shared.core.flows.steps import CallFlowStep
+from rasa.shared.core.trackers import DialogueStateTracker
+
+
+@dataclass
+class RestartAgentCommand(Command):
+    """A command to restart an agentic loop within a flow."""
+
+    agent_id: str
+
+    @classmethod
+    def command(cls) -> str:
+        """Returns the command type."""
+        return "restart agent"
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> RestartAgentCommand:
+        """Converts the dictionary to a command.
+
+        Returns:
+            The converted dictionary.
+        """
+        try:
+            return RestartAgentCommand(agent_id=data["agent_id"])
+        except KeyError as e:
+            raise ValueError(
+                f"Missing parameter '{e}' while parsing RestartAgentCommand."
+            ) from e
+
+    def run_command_on_tracker(
+        self,
+        tracker: DialogueStateTracker,
+        all_flows: FlowsList,
+        original_tracker: DialogueStateTracker,
+    ) -> List[Event]:
+        """Runs the command on the tracker.
+
+        Args:
+            tracker: The tracker to run the command on.
+            all_flows: All flows in the assistant.
+            original_tracker: The tracker before any command was executed.
+
+        Returns:
+            The events to apply to the tracker.
+        """
+        stack = tracker.stack
+
+        # get the agent flow
+        agent_flow_id = self._get_agent_flow(original_tracker)
+
+        # create a new agent stack frame to restart the agent
+        restart_agent_frame = self.create_restart_agent_stack_frame(
+            all_flows, agent_flow_id
+        )
+
+        # if the stack contains an agent stack frame with status
+        # "waiting for input" update the status to "interrupted"
+        self.update_agent_stack_frames_on_stack(stack)
+
+        # push the stack frame on the top of the stack
+        stack.push(restart_agent_frame)
+        return tracker.create_stack_updated_events(stack)
+
+    def __hash__(self) -> int:
+        return hash(self.command())
+
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, RestartAgentCommand)
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: f"RestartAgent({self.agent_id})",
+            CommandSyntaxVersion.v2: f"restart agent {self.agent_id}",
+            CommandSyntaxVersion.v3: f"restart agent {self.agent_id}",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @classmethod
+    def from_dsl(cls, match: re.Match, **kwargs: Any) -> RestartAgentCommand:
+        """Converts a DSL string to a command."""
+        return RestartAgentCommand(agent_id=str(match.group(1).strip()))
+
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"RestartAgent\(['\"]?([a-zA-Z0-9_-]+)['\"]?\)",
+            CommandSyntaxVersion.v2: (
+                r"""^[\s\W\d]*restart agent ['"`]?([a-zA-Z0-9_-]+)['"`]*"""
+            ),
+            CommandSyntaxVersion.v3: (
+                r"""^[\s\W\d]*restart agent ['"`]?([a-zA-Z0-9_-]+)['"`]*"""
+            ),
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    def create_restart_agent_stack_frame(
+        self, all_flows: FlowsList, agent_flow_id: str
+    ) -> AgentStackFrame:
+        # get the agent flow
+        agent_flow = all_flows.flow_by_id(agent_flow_id)
+        if not agent_flow:
+            raise ValueError(f"Agent flow {agent_flow_id} not found")
+
+        # find the call flow step for the agent
+        # set the state to "waiting for input" so that the agent can process
+        # the latest user message
+        for step in agent_flow.steps:
+            if isinstance(step, CallFlowStep) and step.call == self.agent_id:
+                return AgentStackFrame(
+                    frame_id=f"restart_agent_{self.agent_id}",
+                    flow_id=agent_flow_id,
+                    step_id=step.id,
+                    agent_id=self.agent_id,
+                    state=AgentState.WAITING_FOR_INPUT,
+                )
+
+        raise ValueError(f"Call step in agent flow {agent_flow_id} not found")
+
+    def update_agent_stack_frames_on_stack(self, stack: DialogueStack) -> None:
+        for frame in stack.frames:
+            if (
+                isinstance(frame, AgentStackFrame)
+                and frame.state == AgentState.WAITING_FOR_INPUT
+            ):
+                frame.state = AgentState.INTERRUPTED
+
+    def _get_agent_flow(self, tracker: DialogueStateTracker) -> Optional[str]:
+        # find events associated with the agent
+        agent_started_events = [
+            event
+            for event in tracker.events
+            if type(event) == AgentStarted and event.agent_id == self.agent_id
+        ]
+        # take the last one if the agent was started multiple times
+        if agent_started_events:
+            return agent_started_events[-1].flow_id
+        return None