rasa-pro 3.9.17__py3-none-any.whl → 3.10.3__py3-none-any.whl

rasa/dialogue_understanding/generator/multi_step/multi_step_llm_command_generator.py

@@ -179,101 +179,29 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
             return []
 
         try:
-            # retrieve relevant flows
-            filtered_flows = await self.filter_flows(message, flows, tracker)
-
-            # 1st step: Handle active flow
-            if tracker.has_active_user_flow:
-                commands_from_active_flow = (
-                    await self._predict_commands_for_active_flow(
-                        message,
-                        tracker,
-                        available_flows=filtered_flows,
-                        all_flows=flows,
-                    )
-                )
-            else:
-                commands_from_active_flow = []
-
-            # 2nd step: Check if we need to switch to another flow
-            contains_change_flow_command = any(
-                isinstance(command, ChangeFlowCommand)
-                for command in commands_from_active_flow
+            commands = await self._predict_commands_with_multi_step(
+                message, flows, tracker
             )
-            should_change_flows = (
-                not commands_from_active_flow or contains_change_flow_command
-            )
-
-            if should_change_flows:
-                commands_for_handling_flows = (
-                    await self._predict_commands_for_handling_flows(
-                        message,
-                        tracker,
-                        available_flows=filtered_flows,
-                        all_flows=flows,
-                    )
-                )
-            else:
-                commands_for_handling_flows = []
-
-            if contains_change_flow_command:
-                commands_from_active_flow.pop(
-                    commands_from_active_flow.index(ChangeFlowCommand())
-                )
+            commands = self._clean_up_commands(commands)
+        except ProviderClientAPIException:
+            # if any step resulted in API exception, the command prediction cannot
+            # be completed, "predict" the ErrorCommand
+            commands = [ErrorCommand()]
 
-            # 3rd step: Fill slots for started flows
-            newly_started_flows = FlowsList(
-                [
-                    flow
-                    for command in commands_for_handling_flows
-                    if (
-                        isinstance(command, StartFlowCommand)
-                        and (flow := filtered_flows.flow_by_id(command.flow))
-                        is not None
-                    )
-                ]
-            )
+        if not commands:
+            # if for any reason the final list of commands is empty,
+            # "predict" CannotHandle
+            commands = [CannotHandleCommand()]
 
-            commands_for_newly_started_flows = (
-                await self._predict_commands_for_newly_started_flows(
-                    message,
-                    tracker,
-                    newly_started_flows=newly_started_flows,
-                    all_flows=flows,
-                )
-            )
+        if tracker.has_coexistence_routing_slot:
+            # if coexistence feature is used, set the routing slot
+            commands += [SetSlotCommand(ROUTE_TO_CALM_SLOT, True)]
 
-        # if any step resulted in API exception,
-        # the command prediction cannot be completed,
-        # raise ErrorCommand
-        except ProviderClientAPIException:
-            return [ErrorCommand()]
-
-        # concatenate predicted commands
-        commands = list(
-            set(
-                commands_from_active_flow
-                + commands_for_handling_flows
-                + commands_for_newly_started_flows
-            )
-        )
-        commands = self._clean_up_commands(commands)
         structlogger.debug(
-            "multi_step_llm_command_generator" ".predict_commands" ".finished",
+            "multi_step_llm_command_generator.predict_commands.finished",
             commands=commands,
         )
 
-        # if for any reason the final list of commands is empty,
-        # return CannotHandle
-        if not commands:
-            # if action_list is None, we couldn't get any response from the LLM
-            commands = [CannotHandleCommand()]
-        else:
-            # if the LLM command generator predicted valid commands and the
-            # coexistence feature is used, set the routing slot
-            if tracker.has_coexistence_routing_slot:
-                commands += [SetSlotCommand(ROUTE_TO_CALM_SLOT, True)]
-
         return commands
 
     @classmethod
@@ -440,6 +368,97 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
                 file_path = path / file_name
                 rasa.shared.utils.io.write_text_file(template, file_path)
 
+    async def _predict_commands_with_multi_step(
+        self,
+        message: Message,
+        flows: FlowsList,
+        tracker: DialogueStateTracker,
+    ) -> List[Command]:
+        """Predict commands using the LLM.
+
+        Args:
+            message: The message from the user.
+            flows: The flows available to the user.
+            tracker: The tracker containing the current state of the conversation.
+
+        Returns:
+            The commands generated by the llm.
+
+        Raises:
+            ProviderClientAPIException: If API calls raised an error.
+        """
+        # retrieve relevant flows
+        filtered_flows = await self.filter_flows(message, flows, tracker)
+
+        # 1st step: Handle active flow
+        if tracker.has_active_user_flow:
+            commands_from_active_flow = await self._predict_commands_for_active_flow(
+                message,
+                tracker,
+                available_flows=filtered_flows,
+                all_flows=flows,
+            )
+        else:
+            commands_from_active_flow = []
+
+        # 2nd step: Check if we need to switch to another flow
+        contains_change_flow_command = any(
+            isinstance(command, ChangeFlowCommand)
+            for command in commands_from_active_flow
+        )
+        should_change_flows = (
+            not commands_from_active_flow or contains_change_flow_command
+        )
+
+        if should_change_flows:
+            commands_for_handling_flows = (
+                await self._predict_commands_for_handling_flows(
+                    message,
+                    tracker,
+                    available_flows=filtered_flows,
+                    all_flows=flows,
+                )
+            )
+        else:
+            commands_for_handling_flows = []
+
+        if contains_change_flow_command:
+            commands_from_active_flow.pop(
+                commands_from_active_flow.index(ChangeFlowCommand())
+            )
+
+        # 3rd step: Fill slots for started flows
+        newly_started_flows = FlowsList(
+            [
+                flow
+                for command in commands_for_handling_flows
+                if (
+                    isinstance(command, StartFlowCommand)
+                    and (flow := filtered_flows.flow_by_id(command.flow)) is not None
+                )
+            ]
+        )
+
+        commands_for_newly_started_flows = (
+            await self._predict_commands_for_newly_started_flows(
+                message,
+                tracker,
+                newly_started_flows=newly_started_flows,
+                all_flows=flows,
+            )
+        )
+
+        # concatenate predicted commands
+        commands = list(
+            set(
+                commands_from_active_flow
+                + commands_for_handling_flows
+                + commands_for_newly_started_flows
+            )
+        )
+
+        return commands
+
     async def _predict_commands_for_active_flow(
         self,
         message: Message,

rasa/dialogue_understanding/generator/nlu_command_adapter.py

@@ -2,13 +2,15 @@ from typing import Dict, Text, Any, Optional, List
 
 import structlog
 
-
 from rasa.dialogue_understanding.commands import (
     Command,
     StartFlowCommand,
     SetSlotCommand,
 )
 from rasa.dialogue_understanding.commands.set_slot_command import SetSlotExtractor
+from rasa.dialogue_understanding.commands.utils import (
+    triggerable_pattern_to_command_class,
+)
 from rasa.dialogue_understanding.generator import CommandGenerator
 from rasa.engine.graph import GraphComponent, ExecutionContext
 from rasa.engine.recipes.default_recipe import DefaultV1Recipe
@@ -25,6 +27,7 @@ from rasa.shared.core.trackers import DialogueStateTracker
 from rasa.shared.nlu.constants import ENTITIES, INTENT
 from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.nlu.training_data.training_data import TrainingData
+from rasa.utils.log_utils import log_llm
 
 structlogger = structlog.get_logger()
 
@@ -126,13 +129,22 @@ class NLUCommandAdapter(GraphComponent, CommandGenerator):
             clean_up_commands,
         )
 
-        structlogger.info("nlu_command_adapter.cleaning_commands", commands=commands)
+        log_llm(
+            logger=structlogger,
+            log_module="NLUCommandAdapter",
+            log_event="nlu_command_adapter.predict_commands.finished",
+            commands=commands,
+        )
+
         if commands:
             commands = clean_up_commands(
                 commands, tracker, flows, self._execution_context
             )
-            structlogger.info(
-                "nlu_command_adapter.clean_commands", clean_commands=commands
+            log_llm(
+                logger=structlogger,
+                log_module="NLUCommandAdapter",
+                log_event="nlu_command_adapter.clean_commands",
+                commands=commands,
             )
 
         return commands
@@ -162,7 +174,12 @@ class NLUCommandAdapter(GraphComponent, CommandGenerator):
 
         for flow in flows:
             if flow.nlu_triggers and flow.nlu_triggers.is_triggered(message):
-                commands.append(StartFlowCommand(flow.id))
+                if flow.is_rasa_default_flow:
+                    pattern_command = triggerable_pattern_to_command_class.get(flow.id)
+                    if pattern_command:
+                        commands.append(pattern_command())
+                else:
+                    commands.append(StartFlowCommand(flow.id))
 
         # there should be just one flow that can be triggered by the predicted intent
         # this is checked when loading the flows
@@ -180,7 +197,12 @@ class NLUCommandAdapter(GraphComponent, CommandGenerator):
         set_slot_commands = _issue_set_slot_commands(message, tracker, flows, domain)
         commands.extend(set_slot_commands)
 
-        structlogger.info("nlu_command_adapter.predict_commands", commands=commands)
+        log_llm(
+            logger=structlogger,
+            log_module="NLUCommandAdapter",
+            log_event="nlu_command_adapter.predict_commands",
+            commands=commands,
+        )
 
         return commands
 

rasa/dialogue_understanding/generator/single_step/single_step_llm_command_generator.py

@@ -1,8 +1,9 @@
 import importlib.resources
 import re
-import structlog
 from typing import Dict, Any, List, Optional, Text
 
+import structlog
+
 import rasa.shared.utils.io
 from rasa.dialogue_understanding.commands import (
     Command,
@@ -16,9 +17,6 @@ from rasa.dialogue_understanding.commands import (
     ClarifyCommand,
     CannotHandleCommand,
 )
-from rasa.dialogue_understanding.generator.llm_based_command_generator import (
-    LLMBasedCommandGenerator,
-)
 from rasa.dialogue_understanding.generator.constants import (
     LLM_CONFIG_KEY,
     USER_INPUT_CONFIG_KEY,
@@ -27,17 +25,24 @@ from rasa.dialogue_understanding.generator.constants import (
 from rasa.dialogue_understanding.generator.flow_retrieval import (
     FlowRetrieval,
 )
+from rasa.dialogue_understanding.generator.llm_based_command_generator import (
+    LLMBasedCommandGenerator,
+)
 from rasa.dialogue_understanding.stack.utils import top_flow_frame
 from rasa.engine.graph import ExecutionContext
 from rasa.engine.recipes.default_recipe import DefaultV1Recipe
 from rasa.engine.storage.resource import Resource
 from rasa.engine.storage.storage import ModelStorage
-from rasa.shared.constants import ROUTE_TO_CALM_SLOT
+from rasa.shared.constants import (
+    ROUTE_TO_CALM_SLOT,
+    PROMPT_CONFIG_KEY,
+    PROMPT_TEMPLATE_CONFIG_KEY,
+)
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.trackers import DialogueStateTracker
-from rasa.shared.nlu.constants import TEXT
-from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.exceptions import ProviderClientAPIException
+from rasa.shared.nlu.constants import TEXT, LLM_COMMANDS, LLM_PROMPT
+from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.utils.io import deep_container_fingerprint
 from rasa.shared.utils.llm import (
     get_prompt_template,
@@ -82,7 +87,7 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
         )
 
         # Set the prompt template
-        if config.get("prompt"):
+        if config.get(PROMPT_CONFIG_KEY):
             structlogger.warning(
                 "single_step_llm_command_generator.init",
                 event_info=(
@@ -91,7 +96,11 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
                     "Please use the config parameter 'prompt_template' instead. "
                 ),
             )
-        config_prompt = config.get("prompt") or config.get("prompt_template") or None
+        config_prompt = (
+            config.get(PROMPT_CONFIG_KEY)
+            or config.get(PROMPT_TEMPLATE_CONFIG_KEY)
+            or None
+        )
         self.prompt_template = prompt_template or get_prompt_template(
             config_prompt,
             DEFAULT_COMMAND_PROMPT_TEMPLATE,
@@ -104,8 +113,8 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
     def get_default_config() -> Dict[str, Any]:
         """The component's default config (see parent class for full docstring)."""
         return {
-            "prompt": None,  # Legacy
-            "prompt_template": None,
+            PROMPT_CONFIG_KEY: None,  # Legacy
+            PROMPT_TEMPLATE_CONFIG_KEY: None,
             USER_INPUT_CONFIG_KEY: None,
             LLM_CONFIG_KEY: None,
             FLOW_RETRIEVAL_KEY: FlowRetrieval.get_default_config(),
@@ -167,11 +176,51 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
             # cannot do anything if there are no flows or no tracker
             return []
 
-        # retrieve flows
         try:
-            filtered_flows = await self.filter_flows(message, flows, tracker)
+            commands = await self._predict_commands(message, flows, tracker)
         except ProviderClientAPIException:
-            return [ErrorCommand()]
+            # if command predictions resulted in API exception
+            # "predict" the ErrorCommand
+            commands = [ErrorCommand()]
+
+        if not commands:
+            # no commands are parsed or there's an invalid command
+            commands = [CannotHandleCommand()]
+
+        if tracker.has_coexistence_routing_slot:
+            # if coexistence feature is used, set the routing slot
+            commands += [SetSlotCommand(ROUTE_TO_CALM_SLOT, True)]
+
+        log_llm(
+            logger=structlogger,
+            log_module="SingleStepLLMCommandGenerator",
+            log_event="llm_command_generator.predict_commands.finished",
+            commands=commands,
+        )
+
+        return commands
+
+    async def _predict_commands(
+        self,
+        message: Message,
+        flows: FlowsList,
+        tracker: Optional[DialogueStateTracker] = None,
+    ) -> List[Command]:
+        """Predict commands using the LLM.
+
+        Args:
+            message: The message from the user.
+            flows: The flows available to the user.
+            tracker: The tracker containing the current state of the conversation.
+
+        Returns:
+            The commands generated by the llm.
+
+        Raises:
+            ProviderClientAPIException: If API calls raised an error.
+        """
+        # retrieve flows
+        filtered_flows = await self.filter_flows(message, flows, tracker)
 
         flow_prompt = self.render_template(message, tracker, filtered_flows, flows)
         log_llm(
@@ -181,14 +230,11 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
             prompt=flow_prompt,
         )
 
-        try:
-            action_list = await self.invoke_llm(flow_prompt)
-            # The check for 'None' maintains compatibility with older versions
-            # of LLMCommandGenerator. In previous implementations, 'invoke_llm'
-            # might return 'None' to indicate a failure to generate actions.
-            if action_list is None:
-                return [ErrorCommand()]
-        except ProviderClientAPIException:
+        action_list = await self.invoke_llm(flow_prompt)
+        # The check for 'None' maintains compatibility with older versions
+        # of LLMCommandGenerator. In previous implementations, 'invoke_llm'
+        # might return 'None' to indicate a failure to generate actions.
+        if action_list is None:
             return [ErrorCommand()]
 
         log_llm(
@@ -200,23 +246,26 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
 
         commands = self.parse_commands(action_list, tracker, flows)
 
-        if not commands:
-            # no commands are parsed or there's an invalid command
-            commands = [CannotHandleCommand()]
-        else:
-            # if the LLM command generator predicted valid commands and the
-            # coexistence feature is used, set the routing slot
-            if tracker.has_coexistence_routing_slot:
-                commands += [SetSlotCommand(ROUTE_TO_CALM_SLOT, True)]
+        self._update_message_parse_data_for_fine_tuning(message, commands, flow_prompt)
 
-        log_llm(
-            logger=structlogger,
-            log_module="SingleStepLLMCommandGenerator",
-            log_event="llm_command_generator.predict_commands.finished",
-            commands=commands,
-        )
         return commands
 
+    @staticmethod
+    def _update_message_parse_data_for_fine_tuning(
+        message: Message, commands: List[Command], prompt: str
+    ) -> None:
+        from rasa.llm_fine_tuning.annotation_module import preparing_fine_tuning_data
+
+        if preparing_fine_tuning_data:
+            # Add commands and prompt to the message object in order to create
+            # prompt -> commands pairs for fine-tuning
+            message.set(
+                LLM_COMMANDS,
+                [command.as_dict() for command in commands],
+                add_to_output=True,
+            )
+            message.set(LLM_PROMPT, prompt, add_to_output=True)
+
     @classmethod
     def parse_commands(
         cls, actions: Optional[str], tracker: DialogueStateTracker, flows: FlowsList
@@ -285,7 +334,11 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
     @classmethod
     def fingerprint_addon(cls: Any, config: Dict[str, Any]) -> Optional[str]:
         """Add a fingerprint of the knowledge base for the graph."""
-        config_prompt = config.get("prompt") or config.get("prompt_template") or None
+        config_prompt = (
+            config.get(PROMPT_CONFIG_KEY)
+            or config.get(PROMPT_TEMPLATE_CONFIG_KEY)
+            or None
+        )
         prompt_template = get_prompt_template(
             config_prompt,
             DEFAULT_COMMAND_PROMPT_TEMPLATE,

rasa/dialogue_understanding/patterns/default_flows_for_patterns.yml

@@ -55,7 +55,7 @@ responses:
         template: jinja
 
   utter_free_chitchat_response:
-    - text: "Sorry, I'm not able to answer that right now."
+    - text: placeholder_this_utterance_needs_the_rephraser
       metadata:
         rephrase: True
         rephrase_prompt: |
@@ -160,9 +160,9 @@ flows:
         action: action_run_slot_rejections
       - action: validate_{{context.collect}}
         next:
-          - if: "slots.{{context.collect}} is not null"
-            then: END
-          - else: ask_collect
+        - if: "slots.{{context.collect}} is not null"
+          then: END
+        - else: ask_collect
       - id: ask_collect
         action: "{{context.utter}}"
       - action: "{{context.collect_action}}"
@@ -205,17 +205,17 @@ flows:
     steps:
       - noop: true
         next:
-          - if: "'{{context.error_type}}' = 'rasa_internal_error_user_input_too_long'"
-            then:
-              - action: utter_user_input_too_long_error_rasa
-                next: END
-          - if: "'{{context.error_type}}' = 'rasa_internal_error_user_input_empty'"
-            then:
-              - action: utter_user_input_empty_error_rasa
-                next: END
-          - else:
-              - action: utter_internal_error_rasa
-                next: END
+        - if: "'{{context.error_type}}' = 'rasa_internal_error_user_input_too_long'"
+          then:
+          - action: utter_user_input_too_long_error_rasa
+            next: END
+        - if: "'{{context.error_type}}' = 'rasa_internal_error_user_input_empty'"
+          then:
+            - action: utter_user_input_empty_error_rasa
+              next: END
+        - else:
+            - action: utter_internal_error_rasa
+              next: END
 
 
   pattern_restart:

rasa/dialogue_understanding/patterns/session_start.py

@@ -0,0 +1,37 @@
+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"
+
+
+@dataclass
+class SessionStartPatternFlowStackFrame(PatternFlowStackFrame):
+    """A flow stack frame that can get added at the beginning of the conversation."""
+
+    flow_id: str = FLOW_PATTERN_SESSION_START
+    """The ID of the flow."""
+
+    @classmethod
+    def type(cls) -> str:
+        """Returns the type of the frame."""
+        return FLOW_PATTERN_SESSION_START
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> SessionStartPatternFlowStackFrame:
+        """Creates a `DialogueStackFrame` from a dictionary.
+
+        Args:
+            data: The dictionary to create the `DialogueStackFrame` from.
+
+        Returns:
+            The created `DialogueStackFrame`.
+        """
+        return SessionStartPatternFlowStackFrame(
+            frame_id=data["frame_id"],
+            step_id=data["step_id"],
+        )

rasa/dialogue_understanding/processor/command_processor.py

@@ -487,23 +487,22 @@ def clean_up_slot_command(
     stack = tracker.stack
 
     resulting_commands = commands_so_far[:]
+    if command.name in slots_so_far and command.name != ROUTE_TO_CALM_SLOT:
+        slot = tracker.slots.get(command.name)
+        if slot is None:
+            structlogger.debug(
+                "command_processor.clean_up_slot_command.skip_command_slot_not_in_domain",
+                command=command,
+            )
+            return resulting_commands
 
-    slot = tracker.slots.get(command.name)
-    if slot is None:
-        structlogger.debug(
-            "command_processor.clean_up_slot_command.skip_command_slot_not_in_domain",
-            command=command,
-        )
-        return resulting_commands
-
-    if not should_slot_be_set(slot, command):
-        cannot_handle = CannotHandleCommand(reason=CANNOT_HANDLE_REASON)
-        if cannot_handle not in resulting_commands:
-            resulting_commands.append(cannot_handle)
+        if not should_slot_be_set(slot, command):
+            cannot_handle = CannotHandleCommand(reason=CANNOT_HANDLE_REASON)
+            if cannot_handle not in resulting_commands:
+                resulting_commands.append(cannot_handle)
 
-        return resulting_commands
+            return resulting_commands
 
-    if command.name in slots_so_far and command.name != ROUTE_TO_CALM_SLOT:
         current_collect_info = get_current_collect_step(stack, all_flows)
 
         if current_collect_info and current_collect_info.collect == command.name: