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

rasa/dialogue_understanding/commands/__init__.py

@@ -1,41 +1,41 @@
-from rasa.dialogue_understanding.commands.command import Command
-from rasa.dialogue_understanding.commands.free_form_answer_command import (
-    FreeFormAnswerCommand,
+from rasa.dialogue_understanding.commands.can_not_handle_command import (
+    CannotHandleCommand,
 )
 from rasa.dialogue_understanding.commands.cancel_flow_command import CancelFlowCommand
-from rasa.dialogue_understanding.commands.knowledge_answer_command import (
-    KnowledgeAnswerCommand,
-)
+from rasa.dialogue_understanding.commands.change_flow_command import ChangeFlowCommand
 from rasa.dialogue_understanding.commands.chit_chat_answer_command import (
     ChitChatAnswerCommand,
 )
-from rasa.dialogue_understanding.commands.restart_command import RestartCommand
-from rasa.dialogue_understanding.commands.skip_question_command import (
-    SkipQuestionCommand,
-)
-from rasa.dialogue_understanding.commands.can_not_handle_command import (
-    CannotHandleCommand,
-)
 from rasa.dialogue_understanding.commands.clarify_command import ClarifyCommand
+from rasa.dialogue_understanding.commands.command import Command
+from rasa.dialogue_understanding.commands.correct_slots_command import (
+    CorrectedSlot,
+    CorrectSlotsCommand,
+)
 from rasa.dialogue_understanding.commands.error_command import ErrorCommand
-from rasa.dialogue_understanding.commands.set_slot_command import SetSlotCommand
-from rasa.dialogue_understanding.commands.start_flow_command import StartFlowCommand
+from rasa.dialogue_understanding.commands.free_form_answer_command import (
+    FreeFormAnswerCommand,
+)
 from rasa.dialogue_understanding.commands.human_handoff_command import (
     HumanHandoffCommand,
 )
-from rasa.dialogue_understanding.commands.correct_slots_command import (
-    CorrectSlotsCommand,
-    CorrectedSlot,
+from rasa.dialogue_understanding.commands.knowledge_answer_command import (
+    KnowledgeAnswerCommand,
 )
 from rasa.dialogue_understanding.commands.noop_command import NoopCommand
-from rasa.dialogue_understanding.commands.change_flow_command import ChangeFlowCommand
+from rasa.dialogue_understanding.commands.repeat_bot_messages_command import (
+    RepeatBotMessagesCommand,
+)
+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 (
     SessionStartCommand,
 )
-from rasa.dialogue_understanding.commands.session_end_command import SessionEndCommand
-from rasa.dialogue_understanding.commands.repeat_bot_messages_command import (
-    RepeatBotMessagesCommand,
+from rasa.dialogue_understanding.commands.set_slot_command import SetSlotCommand
+from rasa.dialogue_understanding.commands.skip_question_command import (
+    SkipQuestionCommand,
 )
+from rasa.dialogue_understanding.commands.start_flow_command import StartFlowCommand
 
 __all__ = [
     "Command",

rasa/dialogue_understanding/commands/can_not_handle_command.py

@@ -1,9 +1,14 @@
 from __future__ import annotations
 
+import re
 from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Text
 
-from rasa.dialogue_understanding.commands import Command
+from rasa.dialogue_understanding.commands.command import Command
+from rasa.dialogue_understanding.commands.command_syntax_manager import (
+    CommandSyntaxManager,
+    CommandSyntaxVersion,
+)
 from rasa.dialogue_understanding.patterns.cannot_handle import (
     CannotHandlePatternFlowStackFrame,
 )
@@ -12,6 +17,8 @@ from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
 
+DATA_KEY_CANNOT_HANDLE_REASON = "cannot_handle_reason"
+
 
 @dataclass
 class CannotHandleCommand(Command):
@@ -68,3 +75,33 @@ class CannotHandleCommand(Command):
             return False
 
         return other.reason == self.reason
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: "CannotHandle()",
+            CommandSyntaxVersion.v2: "cannot handle",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @classmethod
+    def from_dsl(cls, match: re.Match, **kwargs: Any) -> CannotHandleCommand:
+        """Converts a DSL string to a command."""
+        reason = kwargs.get("data", {}).get(
+            DATA_KEY_CANNOT_HANDLE_REASON, RASA_PATTERN_CANNOT_HANDLE_DEFAULT
+        )
+        return CannotHandleCommand(reason)
+
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"CannotHandle\(\)",
+            CommandSyntaxVersion.v2: r"""^[\s\W\d]*cannot handle['"`]*$""",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/cancel_flow_command.py

@@ -1,19 +1,26 @@
 from __future__ import annotations
 
+import copy
+import re
 from dataclasses import dataclass
 from typing import Any, Dict, List
 
 import structlog
 
-from rasa.dialogue_understanding.commands import Command
+from rasa.dialogue_understanding.commands.command import Command
+from rasa.dialogue_understanding.commands.command_syntax_manager import (
+    CommandSyntaxManager,
+    CommandSyntaxVersion,
+)
 from rasa.dialogue_understanding.patterns.cancel import CancelPatternFlowStackFrame
+from rasa.dialogue_understanding.patterns.clarify import ClarifyPatternFlowStackFrame
 from rasa.dialogue_understanding.stack.dialogue_stack import DialogueStack
 from rasa.dialogue_understanding.stack.frames import UserFlowStackFrame
 from rasa.dialogue_understanding.stack.frames.flow_stack_frame import FlowStackFrameType
+from rasa.dialogue_understanding.stack.utils import top_user_flow_frame
 from rasa.shared.core.events import Event, FlowCancelled
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
-from rasa.dialogue_understanding.stack.utils import top_user_flow_frame
 
 structlogger = structlog.get_logger()
 
@@ -45,7 +52,8 @@ class CancelFlowCommand(Command):
             current_flow: The current flow.
 
         Returns:
-            The frames that were canceled."""
+        The frames that were canceled.
+        """
         canceled_frames = []
         # we need to go through the original stack dump in reverse order
         # to find the frames that were canceled. we cancel everything from
@@ -83,12 +91,12 @@ class CancelFlowCommand(Command):
         Returns:
             The events to apply to the tracker.
         """
-
         stack = tracker.stack
         original_stack = original_tracker.stack
 
         applied_events: List[Event] = []
-
+        # capture the top frame before we push new frames onto the stack
+        initial_top_frame = stack.top()
         user_frame = top_user_flow_frame(original_stack)
         current_flow = user_frame.flow(all_flows) if user_frame else None
 
@@ -105,7 +113,9 @@ class CancelFlowCommand(Command):
 
         stack.push(
             CancelPatternFlowStackFrame(
-                canceled_name=current_flow.readable_name(),
+                canceled_name=current_flow.readable_name(
+                    language=tracker.current_language
+                ),
                 canceled_frames=canceled_frames,
             )
         )
@@ -113,13 +123,90 @@ class CancelFlowCommand(Command):
         if user_frame:
             applied_events.append(FlowCancelled(user_frame.flow_id, user_frame.step_id))
 
+        if initial_top_frame and isinstance(
+            initial_top_frame, ClarifyPatternFlowStackFrame
+        ):
+            structlogger.debug(
+                "command_executor.cancel_flow.cancel_clarification_options",
+                clarification_options=initial_top_frame.clarification_options,
+            )
+            applied_events += cancel_all_pending_clarification_options(
+                initial_top_frame,
+                original_stack,
+                canceled_frames,
+                all_flows,
+                stack,
+            )
+
         return applied_events + tracker.create_stack_updated_events(stack)
 
     def __hash__(self) -> int:
         return hash(self.command())
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, CancelFlowCommand):
-            return False
+        return isinstance(other, CancelFlowCommand)
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: "CancelFlow()",
+            CommandSyntaxVersion.v2: "cancel flow",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @classmethod
+    def from_dsl(cls, match: re.Match, **kwargs: Any) -> CancelFlowCommand:
+        """Converts a DSL string to a command."""
+        return CancelFlowCommand()
+
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"CancelFlow\(\)",
+            CommandSyntaxVersion.v2: r"""^[\s\W\d]*cancel flow['"`]*$""",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
 
-        return True
+def cancel_all_pending_clarification_options(
+    initial_top_frame: ClarifyPatternFlowStackFrame,
+    original_stack: DialogueStack,
+    canceled_frames: List[str],
+    all_flows: FlowsList,
+    stack: DialogueStack,
+) -> List[FlowCancelled]:
+    """Cancel all pending clarification options.
+
+    This is a special case when the assistant asks the user to clarify
+    which pending digression flow to start after the completion of an active flow.
+    If the user chooses to cancel all options, this function takes care of
+    updating the stack by removing all pending flow stack frames
+    listed as clarification options.
+    """
+    clarification_names = set(initial_top_frame.names)
+    to_be_canceled_frames = []
+    applied_events = []
+    for frame in reversed(original_stack.frames):
+        if frame.frame_id in canceled_frames:
+            continue
+
+        to_be_canceled_frames.append(frame.frame_id)
+        if isinstance(frame, UserFlowStackFrame):
+            readable_flow_name = frame.flow(all_flows).readable_name()
+            if readable_flow_name in clarification_names:
+                stack.push(
+                    CancelPatternFlowStackFrame(
+                        canceled_name=readable_flow_name,
+                        canceled_frames=copy.deepcopy(to_be_canceled_frames),
+                    )
+                )
+                applied_events.append(FlowCancelled(frame.flow_id, frame.step_id))
+                to_be_canceled_frames.clear()
+
+    return applied_events

rasa/dialogue_understanding/commands/change_flow_command.py

@@ -1,8 +1,14 @@
 from __future__ import annotations
 
+import re
 from dataclasses import dataclass
 from typing import Any, Dict, List
-from rasa.dialogue_understanding.commands import Command
+
+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
@@ -11,7 +17,8 @@ from rasa.shared.core.trackers import DialogueStateTracker
 @dataclass
 class ChangeFlowCommand(Command):
     """A command to indicate a change of flows was requested by the command
-    generator."""
+    generator.
+    """
 
     @classmethod
     def command(cls) -> str:
@@ -42,3 +49,30 @@ class ChangeFlowCommand(Command):
 
     def __hash__(self) -> int:
         return hash(self.command())
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: "ChangeFlow()",
+            CommandSyntaxVersion.v2: "change",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @staticmethod
+    def from_dsl(match: re.Match, **kwargs: Any) -> ChangeFlowCommand:
+        """Converts the DSL string to a command."""
+        return ChangeFlowCommand()
+
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"ChangeFlow\(\)",
+            CommandSyntaxVersion.v2: r"""^[\s\W\d]*change['"`]*$""",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/chit_chat_answer_command.py

@@ -1,8 +1,16 @@
 from __future__ import annotations
 
+import re
 from dataclasses import dataclass
 from typing import Any, Dict, List
-from rasa.dialogue_understanding.commands import FreeFormAnswerCommand
+
+from rasa.dialogue_understanding.commands.command_syntax_manager import (
+    CommandSyntaxManager,
+    CommandSyntaxVersion,
+)
+from rasa.dialogue_understanding.commands.free_form_answer_command import (
+    FreeFormAnswerCommand,
+)
 from rasa.dialogue_understanding.patterns.chitchat import ChitchatPatternFlowStackFrame
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
@@ -51,7 +59,31 @@ class ChitChatAnswerCommand(FreeFormAnswerCommand):
         return hash(self.command())
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, ChitChatAnswerCommand):
-            return False
+        return isinstance(other, ChitChatAnswerCommand)
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: "ChitChat()",
+            CommandSyntaxVersion.v2: "offtopic reply",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @classmethod
+    def from_dsl(cls, match: re.Match, **kwargs: Any) -> ChitChatAnswerCommand:
+        """Converts the DSL string to a command."""
+        return ChitChatAnswerCommand()
 
-        return True
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"ChitChat\(\)",
+            CommandSyntaxVersion.v2: r"""^[\s\W\d]*offtopic reply['"`]*$""",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/clarify_command.py

@@ -1,10 +1,17 @@
 from __future__ import annotations
 
+import re
 from dataclasses import dataclass
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 import structlog
-from rasa.dialogue_understanding.commands import Command
+
+from rasa.dialogue_understanding.commands.command import Command
+from rasa.dialogue_understanding.commands.command_syntax_manager import (
+    CommandSyntaxManager,
+    CommandSyntaxVersion,
+)
+from rasa.dialogue_understanding.commands.utils import extract_cleaned_options
 from rasa.dialogue_understanding.patterns.clarify import ClarifyPatternFlowStackFrame
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
@@ -54,7 +61,6 @@ class ClarifyCommand(Command):
         Returns:
             The events to apply to the tracker.
         """
-
         flows = [all_flows.flow_by_id(opt) for opt in self.options]
         clean_options = [flow.id for flow in flows if flow is not None]
         if len(clean_options) != len(self.options):
@@ -72,7 +78,13 @@ class ClarifyCommand(Command):
 
         stack = tracker.stack
         relevant_flows = [all_flows.flow_by_id(opt) for opt in clean_options]
-        names = [flow.readable_name() for flow in relevant_flows if flow is not None]
+
+        names = [
+            flow.readable_name(language=tracker.current_language)
+            for flow in relevant_flows
+            if flow is not None
+        ]
+
         stack.push(ClarifyPatternFlowStackFrame(names=names))
         return tracker.create_stack_updated_events(stack)
 
@@ -84,3 +96,33 @@ class ClarifyCommand(Command):
             return False
 
         return other.options == self.options
+
+    def to_dsl(self) -> str:
+        """Converts the command to a DSL string."""
+        mapper = {
+            CommandSyntaxVersion.v1: f"Clarify({', '.join(self.options)})",
+            CommandSyntaxVersion.v2: f"disambiguate flows {' '.join(self.options)}",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+    @classmethod
+    def from_dsl(cls, match: re.Match, **kwargs: Any) -> Optional[ClarifyCommand]:
+        """Converts the DSL string to a command."""
+        cleaned_options = extract_cleaned_options(match.group(1))
+        return ClarifyCommand(cleaned_options)
+
+    @staticmethod
+    def regex_pattern() -> str:
+        mapper = {
+            CommandSyntaxVersion.v1: r"Clarify\(([\"\'a-zA-Z0-9_, ]*)\)",
+            CommandSyntaxVersion.v2: (
+                r"""^[\s\W\d]*disambiguate flows (["'a-zA-Z0-9_, ]*)['"`]*$"""
+            ),
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/command.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
 import dataclasses
+from dataclasses import dataclass
 from typing import Any, Dict, List
+
+import rasa.shared.utils.common
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
-import rasa.shared.utils.common
 
 
 @dataclass

rasa/dialogue_understanding/commands/command_syntax_manager.py

@@ -0,0 +1,55 @@
+from enum import Enum
+from typing import Optional
+
+import structlog
+
+
+class CommandSyntaxVersion(Enum):
+    """Defines different syntax versions for commands."""
+
+    v1 = "v1"
+    v2 = "v2"
+
+
+structlogger = structlog.get_logger()
+
+
+class CommandSyntaxManager:
+    """A class to manage the command syntax version. It is used to set and get the
+    command syntax version. This class provides a way to introduce new syntax versions
+    for commands in the future. Hence, it is for internal use only.
+    """
+
+    _version = None  # Directly store the version as a class attribute
+
+    @classmethod
+    def set_syntax_version(cls, version: CommandSyntaxVersion) -> None:
+        """Sets the command syntax version on the class itself.
+        This method is called only once at the time of LLMCommandGenerator
+        initialization to set the command syntax version, which ensures that the command
+        syntax version remains consistent throughout the lifetime of the generator.
+        """
+        if cls._version:
+            structlogger.debug(
+                "command_syntax_manager.syntax_version_already_set",
+                event_info=(
+                    f"The command syntax version has already been set. Overwriting "
+                    f"the existing version with the new version - {version}."
+                ),
+            )
+        cls._version = version
+
+    @classmethod
+    def get_syntax_version(cls) -> Optional[CommandSyntaxVersion]:
+        """Fetches the stored command syntax version."""
+        return cls._version
+
+    @staticmethod
+    def get_default_syntax_version() -> CommandSyntaxVersion:
+        """Returns the default command syntax version."""
+        return CommandSyntaxVersion.v1
+
+    @classmethod
+    def reset_syntax_version(cls) -> None:
+        """Resets the command syntax version. Implemented for use in testing."""
+        cls._version = None

rasa/dialogue_understanding/commands/correct_slots_command.py

@@ -5,7 +5,8 @@ from typing import Any, Dict, List, Optional
 
 import structlog
 
-from rasa.dialogue_understanding.commands import Command
+import rasa.dialogue_understanding.stack.utils as utils
+from rasa.dialogue_understanding.commands.command import Command
 from rasa.dialogue_understanding.patterns.correction import (
     FLOW_PATTERN_CORRECTION_ID,
     CorrectionPatternFlowStackFrame,
@@ -15,12 +16,11 @@ from rasa.dialogue_understanding.stack.frames.flow_stack_frame import (
     BaseFlowStackFrame,
 )
 from rasa.shared.core.events import Event
+from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.flows.flow_step import FlowStepWithFlowReference
 from rasa.shared.core.flows.steps.constants import END_STEP
 from rasa.shared.core.flows.steps.continuation import ContinueFlowStep
-from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
-import rasa.dialogue_understanding.stack.utils as utils
 
 structlogger = structlog.get_logger()
 
@@ -31,6 +31,7 @@ class CorrectedSlot:
 
     name: str
     value: Any
+    filled_by: Optional[str] = None
 
 
 @dataclass
@@ -54,7 +55,9 @@ class CorrectSlotsCommand(Command):
         try:
             return CorrectSlotsCommand(
                 corrected_slots=[
-                    CorrectedSlot(s["name"], value=s["value"])
+                    CorrectedSlot(
+                        s["name"], value=s["value"], filled_by=s.get("filled_by", None)
+                    )
                     for s in data["corrected_slots"]
                 ]
             )
@@ -135,7 +138,10 @@ class CorrectSlotsCommand(Command):
         proposed_slots = {}
         for corrected_slot in self.corrected_slots:
             if tracker.get_slot(corrected_slot.name) != corrected_slot.value:
-                proposed_slots[corrected_slot.name] = corrected_slot.value
+                proposed_slots[corrected_slot.name] = {
+                    "value": corrected_slot.value,
+                    "filled_by": corrected_slot.filled_by,
+                }
             else:
                 structlogger.debug(
                     "command_executor.skip_correction.slot_already_set", command=self
@@ -240,6 +246,9 @@ class CorrectSlotsCommand(Command):
             corrected_slots=proposed_slots,
             reset_flow_id=earliest_collect.flow_id if earliest_collect else None,
             reset_step_id=earliest_collect.step.id if earliest_collect else None,
+            new_slot_values=[
+                value.get("value") for slot, value in proposed_slots.items()
+            ],
         )
 
     def run_command_on_tracker(

rasa/dialogue_understanding/commands/error_command.py

@@ -5,7 +5,7 @@ from typing import Any, Dict, List, Text
 
 import structlog
 
-from rasa.dialogue_understanding.commands import Command
+from rasa.dialogue_understanding.commands.command import Command
 from rasa.dialogue_understanding.patterns.internal_error import (
     InternalErrorPatternFlowStackFrame,
 )

rasa/dialogue_understanding/commands/free_form_answer_command.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
-from rasa.dialogue_understanding.commands import Command
+
+from rasa.dialogue_understanding.commands.command import Command
 
 
 @dataclass

rasa/dialogue_understanding/commands/handle_code_change_command.py

@@ -5,12 +5,12 @@ from typing import Any, Dict, List
 
 import structlog
 
-from rasa.dialogue_understanding.commands import Command
+from rasa.dialogue_understanding.commands.command import Command
 from rasa.dialogue_understanding.patterns.code_change import CodeChangeFlowStackFrame
+from rasa.dialogue_understanding.stack.utils import top_user_flow_frame
 from rasa.shared.core.events import Event
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
-from rasa.dialogue_understanding.stack.utils import top_user_flow_frame
 
 structlogger = structlog.get_logger()