rasa-pro 3.12.0.dev12__py3-none-any.whl → 3.12.0rc1__py3-none-any.whl

rasa/core/processor.py

@@ -25,6 +25,7 @@ from rasa.core.channels.channel import (
     OutputChannel,
     UserMessage,
 )
+from rasa.core.constants import KEY_IS_CALM_SYSTEM, KEY_IS_COEXISTENCE_ASSISTANT
 from rasa.core.http_interpreter import RasaNLUHttpInterpreter
 from rasa.core.lock_store import LockStore
 from rasa.core.nlg import NaturalLanguageGenerator
@@ -35,6 +36,12 @@ from rasa.dialogue_understanding.commands import (
     NoopCommand,
     SetSlotCommand,
 )
+from rasa.dialogue_understanding.commands.utils import (
+    create_validate_frames_from_slot_set_events,
+)
+from rasa.dialogue_understanding.patterns.validate_slot import (
+    ValidateSlotPatternFlowStackFrame,
+)
 from rasa.dialogue_understanding.utils import add_commands_to_message_parse_data
 from rasa.engine import loader
 from rasa.engine.constants import (
@@ -201,10 +208,7 @@ class MessageProcessor:
             )
             return None
 
-        if not self.message_contains_commands(tracker.latest_message):
-            tracker = await self.run_action_extract_slots(
-                message.output_channel, tracker
-            )
+        tracker = await self.run_action_extract_slots(message.output_channel, tracker)
 
         await self._run_prediction_loop(message.output_channel, tracker)
 
@@ -218,7 +222,9 @@ class MessageProcessor:
         return None
 
     async def run_action_extract_slots(
-        self, output_channel: OutputChannel, tracker: DialogueStateTracker
+        self,
+        output_channel: OutputChannel,
+        tracker: DialogueStateTracker,
     ) -> DialogueStateTracker:
         """Run action to extract slots and update the tracker accordingly.
 
@@ -233,6 +239,10 @@ class MessageProcessor:
             ACTION_EXTRACT_SLOTS, self.domain, self.action_endpoint
         )
         metadata = await self._add_flows_to_metadata()
+        metadata[KEY_IS_CALM_SYSTEM] = self.message_contains_commands(
+            tracker.latest_message
+        )
+        metadata[KEY_IS_COEXISTENCE_ASSISTANT] = self._is_coexistence_assistant(tracker)
 
         extraction_events = await action_extract_slots.run(
             output_channel, self.nlg, tracker, self.domain, metadata
@@ -1251,6 +1261,12 @@ class MessageProcessor:
         # events and return values are used to update
         # the tracker state after an action has been taken
         try:
+            validate_frames: List[ValidateSlotPatternFlowStackFrame] = []
+            # check if the last action was a correction action
+            # before validating the corrected slots
+            if tracker.latest_action_name == ACTION_CORRECT_FLOW_SLOT:
+                tracker, validate_frames = self.validate_corrected_slots(tracker)
+
             # Use temporary tracker as we might need to discard the policy events in
             # case of a rejection.
             temporary_tracker = tracker.copy()
@@ -1262,6 +1278,12 @@ class MessageProcessor:
 
                 if isinstance(action, FormAction):
                     flows_metadata = await self._add_flows_to_metadata()
+                    flows_metadata[KEY_IS_CALM_SYSTEM] = self.message_contains_commands(
+                        temporary_tracker.latest_message
+                    )
+                    flows_metadata[KEY_IS_COEXISTENCE_ASSISTANT] = (
+                        self._is_coexistence_assistant(temporary_tracker)
+                    )
                     metadata = prediction.action_metadata or {}
                     metadata.update(flows_metadata)
 
@@ -1276,6 +1298,14 @@ class MessageProcessor:
                 events = await action.run(
                     output_channel, nlg, temporary_tracker, self.domain
                 )
+
+            if validate_frames:
+                stack = tracker.stack
+                for frame in validate_frames:
+                    stack.push(frame)
+                new_events = tracker.create_stack_updated_events(stack)
+                tracker.update_with_events(new_events)
+
             self._log_action_and_events_on_tracker(tracker, action, events, prediction)
         except ActionExecutionRejection:
             events = [
@@ -1479,18 +1509,51 @@ class MessageProcessor:
         Returns:
             bool: True if any node in the graph schema uses `FlowPolicy`.
         """
+        flow_policy_class_path = "rasa.core.policies.flow_policy.FlowPolicy"
+        return self._is_component_present_in_graph_nodes(flow_policy_class_path)
+
+    @staticmethod
+    def _is_coexistence_assistant(tracker: DialogueStateTracker) -> bool:
+        """Inspect the tracker to decide if we are in coexistence.
+
+        Returns:
+            bool: True if the tracker contains the routine slot.
+        """
+        return tracker.slots.get(ROUTE_TO_CALM_SLOT) is not None
+
+    def _is_component_present_in_graph_nodes(self, component_path: Text) -> bool:
+        """Check if a component is present in the graph nodes.
+
+        Args:
+            component_path: The path of the component to check for.
+
+        Returns:
+            `True` if the component is present in the graph nodes, `False` otherwise.
+        """
         # Get the graph schema's nodes from the graph runner.
         nodes: dict[str, Any] = self.graph_runner._graph_schema.nodes  # type: ignore[attr-defined]
 
-        flow_policy_class_path = "rasa.core.policies.flow_policy.FlowPolicy"
-        # Iterate over the nodes and check if any node uses `FlowPolicy`.
         for node_name, schema_node in nodes.items():
             if (
                 schema_node.uses is not None
                 and f"{schema_node.uses.__module__}.{schema_node.uses.__name__}"
-                == flow_policy_class_path
+                == component_path
             ):
                 return True
 
-        # Return False if no node is found using `FlowPolicy`.
         return False
+
+    def validate_corrected_slots(
+        self,
+        tracker: DialogueStateTracker,
+    ) -> Tuple[DialogueStateTracker, List[ValidateSlotPatternFlowStackFrame]]:
+        """Validate the slots that were corrected in the tracker."""
+        prior_tracker_events = list(reversed(tracker.events))
+        tracker, validate_frames = create_validate_frames_from_slot_set_events(
+            tracker,
+            prior_tracker_events,
+            should_break=True,
+            update_corrected_slots=True,
+        )
+
+        return tracker, validate_frames

rasa/core/run.py

@@ -283,9 +283,10 @@ def serve_application(
         endpoints.lock_store if endpoints else None
     )
 
-    telemetry.track_server_start(
-        input_channels, endpoints, model_path, number_of_workers, enable_api
-    )
+    if not inspect:
+        telemetry.track_server_start(
+            input_channels, endpoints, model_path, number_of_workers, enable_api
+        )
 
     rasa.utils.common.update_sanic_log_level(
         log_file, use_syslog, syslog_address, syslog_port, syslog_protocol

rasa/dialogue_understanding/commands/can_not_handle_command.py

@@ -5,6 +5,10 @@ from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Text
 
 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,
 )
@@ -74,7 +78,14 @@ class CannotHandleCommand(Command):
 
     def to_dsl(self) -> str:
         """Converts the command to a DSL string."""
-        return "cannot handle"
+        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:
@@ -86,4 +97,11 @@ class CannotHandleCommand(Command):
 
     @staticmethod
     def regex_pattern() -> str:
-        return r"^cannot handle$"
+        mapper = {
+            CommandSyntaxVersion.v1: r"CannotHandle\(\)",
+            CommandSyntaxVersion.v2: r"^[^\w]*cannot handle$",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/cancel_flow_command.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import copy
 import re
 from dataclasses import dataclass
 from typing import Any, Dict, List
@@ -7,7 +8,12 @@ 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.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
@@ -89,7 +95,8 @@ class CancelFlowCommand(Command):
         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
 
@@ -106,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,
             )
         )
@@ -114,6 +123,21 @@ 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:
@@ -124,7 +148,14 @@ class CancelFlowCommand(Command):
 
     def to_dsl(self) -> str:
         """Converts the command to a DSL string."""
-        return "cancel flow"
+        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:
@@ -133,4 +164,49 @@ class CancelFlowCommand(Command):
 
     @staticmethod
     def regex_pattern() -> str:
-        return r"^cancel flow$"
+        mapper = {
+            CommandSyntaxVersion.v1: r"CancelFlow\(\)",
+            CommandSyntaxVersion.v2: r"^[^\w]*cancel flow$",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )
+
+
+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

@@ -5,6 +5,10 @@ from dataclasses import dataclass
 from typing import Any, Dict, List
 
 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
@@ -48,7 +52,14 @@ class ChangeFlowCommand(Command):
 
     def to_dsl(self) -> str:
         """Converts the command to a DSL string."""
-        return "change"
+        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:
@@ -57,4 +68,11 @@ class ChangeFlowCommand(Command):
 
     @staticmethod
     def regex_pattern() -> str:
-        return r"^change"
+        mapper = {
+            CommandSyntaxVersion.v1: r"ChangeFlow\(\)",
+            CommandSyntaxVersion.v2: r"^[^\w]*change$",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/chit_chat_answer_command.py

@@ -4,6 +4,10 @@ import re
 from dataclasses import dataclass
 from typing import Any, Dict, List
 
+from rasa.dialogue_understanding.commands.command_syntax_manager import (
+    CommandSyntaxManager,
+    CommandSyntaxVersion,
+)
 from rasa.dialogue_understanding.commands.free_form_answer_command import (
     FreeFormAnswerCommand,
 )
@@ -59,7 +63,14 @@ class ChitChatAnswerCommand(FreeFormAnswerCommand):
 
     def to_dsl(self) -> str:
         """Converts the command to a DSL string."""
-        return "offtopic reply"
+        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:
@@ -68,4 +79,11 @@ class ChitChatAnswerCommand(FreeFormAnswerCommand):
 
     @staticmethod
     def regex_pattern() -> str:
-        return r"^offtopic reply$"
+        mapper = {
+            CommandSyntaxVersion.v1: r"ChitChat\(\)",
+            CommandSyntaxVersion.v2: r"^[^\w]*offtopic reply$",
+        }
+        return mapper.get(
+            CommandSyntaxManager.get_syntax_version(),
+            mapper[CommandSyntaxManager.get_default_syntax_version()],
+        )

rasa/dialogue_understanding/commands/clarify_command.py

@@ -7,6 +7,10 @@ from typing import Any, Dict, List, Optional
 import structlog
 
 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
@@ -74,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)
 
@@ -89,7 +99,14 @@ class ClarifyCommand(Command):
 
     def to_dsl(self) -> str:
         """Converts the command to a DSL string."""
-        return f"disambiguate flows {' '.join(self.options)}"
+        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]:
@@ -99,4 +116,13 @@ class ClarifyCommand(Command):
 
     @staticmethod
     def regex_pattern() -> str:
-        return r"^disambiguate flows([\"\'a-zA-Z0-9_, ]*)$"
+        mapper = {
+            CommandSyntaxVersion.v1: r"Clarify\(([\"\'a-zA-Z0-9_, ]*)\)",
+            CommandSyntaxVersion.v2: (
+                r"^[^\w]*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,9 +1,8 @@
 from __future__ import annotations
 
 import dataclasses
-import re
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List
 
 import rasa.shared.utils.common
 from rasa.shared.core.events import Event
@@ -85,17 +84,3 @@ class Command:
             The events to apply to the tracker.
         """
         raise NotImplementedError()
-
-    def to_dsl(self) -> str:
-        """Converts the command to a DSL string."""
-        raise NotImplementedError()
-
-    @classmethod
-    def from_dsl(cls, match: re.Match, **kwargs: Any) -> Optional[Command]:
-        """Converts the DSL string to a command."""
-        raise NotImplementedError()
-
-    @staticmethod
-    def regex_pattern() -> str:
-        """Returns the regex pattern for the command."""
-        raise NotImplementedError()

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.warn(
+                "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

@@ -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(