rasa-pro 3.12.19__py3-none-any.whl → 3.12.25__py3-none-any.whl

rasa/dialogue_understanding/generator/command_generator.py

@@ -114,7 +114,7 @@ class CommandGenerator:
             # slot asked by the active collect step.
             # Or return a CannotHandleCommand if no matching command is found.
             commands = self._filter_commands_during_force_slot_filling(
-                commands, available_flows, tracker
+                commands, flows, tracker
             )
 
             commands_dicts = [command.as_dict() for command in commands]
@@ -383,14 +383,14 @@ class CommandGenerator:
     @staticmethod
     def _filter_commands_during_force_slot_filling(
         commands: List[Command],
-        available_flows: FlowsList,
+        flows: FlowsList,
         tracker: Optional[DialogueStateTracker] = None,
     ) -> List[Command]:
         """Filter commands during a collect step that has set `force_slot_filling`.
 
         Args:
             commands: The commands to filter.
-            available_flows: The available flows.
+            flows: All flows.
             tracker: The tracker.
 
         Returns:
@@ -407,7 +407,7 @@ class CommandGenerator:
             )
             return commands
 
-        updated_flows = find_updated_flows(tracker, available_flows)
+        updated_flows = find_updated_flows(tracker, flows)
         if updated_flows:
             structlogger.debug(
                 "command_generator.filter_commands_during_force_slot_filling.running_flows_were_updated",
@@ -416,7 +416,7 @@ class CommandGenerator:
             return [HandleCodeChangeCommand()]
 
         stack = tracker.stack
-        step = get_current_collect_step(stack, available_flows)
+        step = get_current_collect_step(stack, flows)
 
         if step is None or not step.force_slot_filling:
             return commands

rasa/dialogue_understanding/processor/command_processor.py

@@ -64,12 +64,6 @@ from rasa.shared.nlu.constants import COMMANDS
 
 structlogger = structlog.get_logger()
 
-CANNOT_HANDLE_REASON = (
-    "A command generator attempted to set a slot "
-    "with a value extracted by an extractor "
-    "that is incompatible with the slot mapping type."
-)
-
 
 def contains_command(commands: List[Command], typ: Type[Command]) -> bool:
     """Check if a list of commands contains a command of a given type.
@@ -405,7 +399,12 @@ def clean_up_commands(
     """
     domain = domain if domain else Domain.empty()
 
-    slots_so_far, active_flow = filled_slots_for_active_flow(tracker, all_flows)
+    slots_so_far, _ = filled_slots_for_active_flow(tracker, all_flows)
+
+    # update the slots so far with the slots that were set in the tracker
+    slots_so_far.update(
+        {event.key for event in tracker.events if isinstance(event, SlotSet)}
+    )
 
     clean_commands: List[Command] = []
 
@@ -588,6 +587,11 @@ def clean_up_slot_command(
             "command_processor.clean_up_slot_command.skip_command_slot_not_in_domain",
             command=command,
         )
+        resulting_commands.append(
+            CannotHandleCommand(
+                reason="The slot predicted by the LLM is not defined in the domain."
+            )
+        )
         return resulting_commands
 
     if not should_slot_be_set(slot, command, resulting_commands):
@@ -606,7 +610,10 @@ def clean_up_slot_command(
             for command in resulting_commands
         )
 
-        cannot_handle = CannotHandleCommand(reason=CANNOT_HANDLE_REASON)
+        cannot_handle = CannotHandleCommand(
+            reason="A command generator attempted to set a slot with a value extracted "
+            "by an extractor that is incompatible with the slot mapping type."
+        )
         if not slot_command_exists_already and cannot_handle not in resulting_commands:
             resulting_commands.append(cannot_handle)
 
@@ -640,9 +647,9 @@ def clean_up_slot_command(
             resulting_commands.append(command)
             return resulting_commands
 
-        if (slot := tracker.slots.get(command.name)) is not None and slot.value == str(
-            command.value
-        ):
+        if (slot := tracker.slots.get(command.name)) is not None and str(
+            slot.value
+        ) == str(command.value):
             # the slot is already set, we don't need to set it again
             structlogger.debug(
                 "command_processor.clean_up_slot_command.skip_command_slot_already_set",

rasa/e2e_test/e2e_test_coverage_report.py

@@ -21,7 +21,7 @@ from rasa.shared.core.flows.flow_path import FlowPath, FlowPathsList, PathNode
 FLOW_NAME_COL_NAME = "Flow Name"
 NUM_STEPS_COL_NAME = "Num Steps"
 MISSING_STEPS_COL_NAME = "Missing Steps"
-LINE_NUMBERS_COL_NAME = "Line Numbers"
+LINE_NUMBERS_COL_NAME = "Line Numbers for Missing Steps"
 COVERAGE_COL_NAME = "Coverage"
 
 FLOWS_KEY = "flows"

rasa/llm_fine_tuning/annotation_module.py

@@ -9,8 +9,8 @@ from rasa.e2e_test.e2e_test_case import ActualStepOutput, TestCase, TestStep, Te
 from rasa.e2e_test.e2e_test_runner import TEST_TURNS_TYPE, E2ETestRunner
 from rasa.llm_fine_tuning.conversations import Conversation, ConversationStep
 from rasa.llm_fine_tuning.storage import StorageContext
-from rasa.shared.core.constants import USER
-from rasa.shared.core.events import UserUttered
+from rasa.shared.core.constants import BOT, USER
+from rasa.shared.core.events import BotUttered, UserUttered
 from rasa.shared.core.trackers import DialogueStateTracker
 from rasa.shared.exceptions import FinetuningDataPreparationException
 from rasa.shared.nlu.constants import LLM_COMMANDS, LLM_PROMPT
@@ -83,16 +83,18 @@ def generate_conversation(
         Conversation.
     """
     steps = []
-    tracker_event_indices = [
-        i for i, event in enumerate(tracker.events) if isinstance(event, UserUttered)
-    ]
-
-    if len(test_case.steps) != len(tracker_event_indices):
-        raise FinetuningDataPreparationException(
-            "Number of test case steps and tracker events do not match."
-        )
 
     if assertions_used:
+        tracker_event_indices = [
+            i
+            for i, event in enumerate(tracker.events)
+            if isinstance(event, UserUttered)
+        ]
+        if len(test_case.steps) != len(tracker_event_indices):
+            raise FinetuningDataPreparationException(
+                "Number of test case steps and tracker events do not match."
+            )
+
         # we only have user steps, extract the bot response from the bot uttered
         # events of the test turn
         for i, (original_step, tracker_event_index) in enumerate(
@@ -110,8 +112,30 @@ def generate_conversation(
             )
             steps.extend(_create_bot_test_steps(test_turns[i]))
     else:
+        tracker_event_indices = [
+            i
+            for i, event in enumerate(tracker.events)
+            if isinstance(event, UserUttered) or isinstance(event, BotUttered)
+        ]
+
+        # Generally, we expect one or more bot response(s) for each user utterance
+        # in the test case, so that we can evaluate the actual bot response.
+        # If the test case ends with one or more user utterance(s) instead,
+        # we should thus trim those from the test case steps.
+        # This only applies to test cases that have at least one bot utterance;
+        # otherwise, all test case steps would be removed.
+        has_bot_utterance = any(step.actor == BOT for step in test_case.steps)
+        i = len(test_case.steps)
+        if has_bot_utterance:
+            while i > 0 and test_case.steps[i - 1].actor == USER:
+                i -= 1
+        test_case_steps = test_case.steps[:i]
+
+        # If the number of test case steps and tracker events differ,
+        # using zip ensures we only process pairs that exist in both lists.
+        # Prevents index errors and ensures we don't process unmatched steps or events.
         for i, (original_step, tracker_event_index) in enumerate(
-            zip(test_case.steps, tracker_event_indices)
+            zip(test_case_steps, tracker_event_indices)
         ):
             if original_step.actor == USER:
                 previous_turn = _get_previous_actual_step_output(test_turns, i)
@@ -127,6 +151,14 @@ def generate_conversation(
             else:
                 steps.append(original_step)
 
+        # the tracker should only include events up to the last bot utterance
+        # so that the resulting transcript ends with the last bot utterance too
+        # only applies to test cases that have at least one bot utterance
+        if has_bot_utterance and test_case.steps and test_case.steps[-1].actor == USER:
+            event_to_go_to = tracker_event_indices[len(test_case_steps)] - 1
+            timestamp = tracker.events[event_to_go_to].timestamp
+            tracker = tracker.travel_back_in_time(timestamp)
+
     # Some messages in an e2e test case could be mapped to commands via
     # 'NLUCommandAdapter', e.g. the message will not be annotated with a prompt and
     # commands pair. Only convert steps that have a prompt and commands present into a

rasa/shared/core/constants.py

@@ -181,6 +181,7 @@ class SetSlotExtractor(Enum):
 # the keys for `State` (USER, PREVIOUS_ACTION, SLOTS, ACTIVE_LOOP)
 # represent the origin of a `SubState`
 USER = "user"
+BOT = "bot"
 SLOTS = "slots"
 
 USE_TEXT_FOR_FEATURIZATION = "use_text_for_featurization"

rasa/shared/core/flows/constants.py

@@ -9,3 +9,5 @@ KEY_FILE_PATH = "file_path"
 KEY_PERSISTED_SLOTS = "persisted_slots"
 KEY_RUN_PATTERN_COMPLETED = "run_pattern_completed"
 KEY_TRANSLATION = "translation"
+KEY_CALLED_FLOW = "called_flow"
+KEY_LINKED_FLOW = "linked_flow"

rasa/shared/core/flows/flow.py

@@ -4,7 +4,7 @@ import copy
 from dataclasses import dataclass, field
 from functools import cached_property
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, Text, Union
+from typing import Any, Dict, List, Optional, Set, Text, Tuple, Union
 
 import structlog
 from pydantic import BaseModel
@@ -15,10 +15,12 @@ from rasa.engine.language import Language
 from rasa.shared.constants import RASA_DEFAULT_FLOW_PATTERN_PREFIX
 from rasa.shared.core.flows.constants import (
     KEY_ALWAYS_INCLUDE_IN_PROMPT,
+    KEY_CALLED_FLOW,
     KEY_DESCRIPTION,
     KEY_FILE_PATH,
     KEY_ID,
     KEY_IF,
+    KEY_LINKED_FLOW,
     KEY_NAME,
     KEY_NLU_TRIGGER,
     KEY_PERSISTED_SLOTS,
@@ -41,6 +43,7 @@ from rasa.shared.core.flows.steps import (
     CallFlowStep,
     CollectInformationFlowStep,
     EndFlowStep,
+    LinkFlowStep,
     StartFlowStep,
 )
 from rasa.shared.core.flows.steps.constants import (
@@ -61,6 +64,8 @@ class FlowLanguageTranslation(BaseModel):
     """The human-readable name of the flow."""
 
     class Config:
+        """Configuration for the FlowLanguageTranslation model."""
+
         extra = "ignore"
 
 
@@ -232,9 +237,9 @@ class Flow:
         return translation.name if translation else None
 
     def readable_name(self, language: Optional[Language] = None) -> str:
-        """
-        Returns the flow's name in the specified language if available; otherwise
-        falls back to the flow's name, and finally the flow's ID.
+        """Returns the flow's name in the specified language if available.
+
+        Otherwise, falls back to the flow's name, and finally the flow's ID.
 
         Args:
             language: Preferred language code.
@@ -488,6 +493,9 @@ class Flow:
         current_path: FlowPath,
         all_paths: FlowPathsList,
         visited_step_ids: Set[str],
+        call_stack: Optional[
+            List[Tuple[Optional[FlowStep], Optional[Flow], str]]
+        ] = None,
     ) -> None:
         """Processes the flow steps recursively.
 
@@ -496,19 +504,25 @@ class Flow:
             current_path: The current path being constructed.
             all_paths: The list where completed paths are added.
             visited_step_ids: A set of steps that have been visited to avoid cycles.
+            call_stack: Tuple list of (flow, path, flow_type) to track path when \
+                calling flows through call and link steps.
 
         Returns:
             None: This function modifies all_paths in place by appending new paths
             as they are found.
         """
+        if call_stack is None:
+            call_stack = []
+
         # Check if the step is relevant for testable_paths extraction.
-        # We only create new path nodes for ActionFlowStep, CallFlowStep and
-        # CollectInformationFlowStep because these are externally visible
-        # changes in the assistant's behaviour (trackable in the e2e tests).
+        # We only create new path nodes for CollectInformationFlowStep,
+        # ActionFlowStep, CallFlowStep and LinkFlowStep,
+        # because these are externally visible changes
+        # in the assistant's behaviour (trackable in the e2e tests).
         # For other flow steps, we only follow their links.
-        # We decided to ignore calls to other flows in our coverage analysis.
         should_add_node = isinstance(
-            current_step, (CollectInformationFlowStep, ActionFlowStep, CallFlowStep)
+            current_step,
+            (CollectInformationFlowStep, ActionFlowStep, CallFlowStep, LinkFlowStep),
         )
         if should_add_node:
             # Add current step to the current path that is being constructed.
@@ -520,10 +534,45 @@ class Flow:
                 )
             )
 
+        # Check if the current step has already been visited or
+        # if the end of the path has been reached.
+        # If so, and we’re not within a called flow, we terminate the current path.
+        # This also applies for when we're inside a linked flow and reach its end.
+        # If we're inside a called flow and reach its end,
+        # continue with the next steps in its parent flow.
         if current_step.id in visited_step_ids or self.is_end_of_path(current_step):
-            # Found a cycle, or reached an end step, do not proceed further.
-            all_paths.paths.append(copy.deepcopy(current_path))
-            # Remove the last node from the path if it was added.
+            # Shallow copy is sufficient, since we only pop from the list and
+            # don't mutate the objects inside the tuples.
+            # The state of FlowStep and Flow does not change during the traversal.
+            call_stack_copy = call_stack.copy()
+            # parent_flow_type could be any of: None, i.e. main flow,
+            # KEY_CALLED_FLOW(=called_flow) or KEY_LINKED_FLOW(=linked_flow)
+            parent_step, parent_flow, parent_flow_type = (
+                call_stack_copy.pop() if call_stack_copy else (None, None, None)
+            )
+
+            # Check if within a called flow.
+            # If within linked flow, stop the traversal as this takes precedence.
+            if parent_step and parent_flow_type == KEY_CALLED_FLOW:
+                # As we have reached the END step of a called flow, we need to
+                # continue with the next links of the parent step.
+                if parent_flow is not None:
+                    for link in parent_step.next.links:
+                        parent_flow._handle_link(
+                            current_path,
+                            all_paths,
+                            visited_step_ids,
+                            link,
+                            call_stack_copy,
+                        )
+
+            else:
+                # Found a cycle, or reached an end step, do not proceed further.
+                all_paths.paths.append(copy.deepcopy(current_path))
+
+            # Backtrack: remove the last node after reaching a terminal step.
+            # Ensures the path is correctly backtracked, after a path ends or
+            # a cycle is detected.
             if should_add_node:
                 current_path.nodes.pop()
             return
@@ -531,6 +580,62 @@ class Flow:
         # Mark current step as visited in this path.
         visited_step_ids.add(current_step.id)
 
+        # If the current step is a call step, we need to resolve the call
+        # and continue with the steps of the called flow.
+        if isinstance(current_step, CallFlowStep):
+            # Get the steps of the called flow and continue with them.
+            called_flow = current_step.called_flow_reference
+            if called_flow and (
+                start_step_in_called_flow := called_flow.first_step_in_flow()
+            ):
+                call_stack.append((current_step, self, KEY_CALLED_FLOW))
+                called_flow._go_over_steps(
+                    start_step_in_called_flow,
+                    current_path,
+                    all_paths,
+                    visited_step_ids,
+                    call_stack,
+                )
+
+                # After processing the steps of the called (child) flow,
+                # remove them from the visited steps
+                # to allow the calling (parent) flow to revisit them later.
+                visited_step_ids.remove(current_step.id)
+                call_stack.pop()
+
+                # Backtrack: remove the last node
+                # after returning from a called (child) flow.
+                # Ensures the parent flow can continue exploring other branches.
+                if should_add_node:
+                    current_path.nodes.pop()
+            return
+
+        # If the current step is a LinkFlowStep, step into the linked flow,
+        # process its links, and do not return from that flow anymore.
+        if isinstance(current_step, LinkFlowStep):
+            # Get the steps of the linked flow and continue with them.
+            linked_flow = current_step.linked_flow_reference
+            if linked_flow and (
+                start_step_in_linked_flow := linked_flow.first_step_in_flow()
+            ):
+                call_stack.append((current_step, self, KEY_LINKED_FLOW))
+                linked_flow._go_over_steps(
+                    start_step_in_linked_flow,
+                    current_path,
+                    all_paths,
+                    visited_step_ids,
+                    call_stack,
+                )
+                visited_step_ids.remove(current_step.id)
+                call_stack.pop()
+
+                # Backtrack: remove the last node
+                # after returning from a linked (child) flow.
+                # Ensures the parent can continue after the linked flow is processed.
+                if should_add_node:
+                    current_path.nodes.pop()
+            return
+
         # Iterate over all links of the current step.
         for link in current_step.next.links:
             self._handle_link(
@@ -538,12 +643,15 @@ class Flow:
                 all_paths,
                 visited_step_ids,
                 link,
+                call_stack,
             )
 
         # Backtrack the current step and remove it from the path.
         visited_step_ids.remove(current_step.id)
 
-        # Remove the last node from the path if it was added.
+        # Backtrack: remove the last node
+        # after processing all links of the current step.
+        # Ensures the next recursion can start once all links are explored.
         if should_add_node:
             current_path.nodes.pop()
 
@@ -553,6 +661,9 @@ class Flow:
         all_paths: FlowPathsList,
         visited_step_ids: Set[str],
         link: FlowStepLink,
+        call_stack: Optional[
+            List[Tuple[Optional[FlowStep], Optional[Flow], str]]
+        ] = None,
     ) -> None:
         """Handles the next step in a flow.
 
@@ -561,6 +672,8 @@ class Flow:
             all_paths: The list where completed paths are added.
             visited_step_ids: A set of steps that have been visited to avoid cycles.
             link: The link to be followed.
+            call_stack: Tuple list of (flow, path, flow_type) to track path when \
+                calling flows through call and link steps..
 
         Returns:
             None: This function modifies all_paths in place by appending new paths
@@ -575,6 +688,7 @@ class Flow:
                     current_path,
                     all_paths,
                     visited_step_ids,
+                    call_stack,
                 )
                 return
         # IfFlowStepLink and ElseFlowStepLink are conditional links.
@@ -588,6 +702,7 @@ class Flow:
                         current_path,
                         all_paths,
                         visited_step_ids,
+                        call_stack,
                     )
                 return
             else:
@@ -598,6 +713,7 @@ class Flow:
                         current_path,
                         all_paths,
                         visited_step_ids,
+                        call_stack,
                     )
                     return
 

rasa/shared/core/flows/flows_list.py

@@ -36,6 +36,7 @@ class FlowsList:
     def __post_init__(self) -> None:
         """Initializes the FlowsList object."""
         self._resolve_called_flows()
+        self._resolve_linked_flows()
 
     def __iter__(self) -> Generator[Flow, None, None]:
         """Iterates over the flows."""
@@ -103,7 +104,10 @@ class FlowsList:
         )
 
     def _resolve_called_flows(self) -> None:
-        """Resolves the called flows."""
+        """Resolves the called flows.
+
+        `Resolving` here means connecting the step to the actual `Flow` object.
+        """
         from rasa.shared.core.flows.steps import CallFlowStep
 
         for flow in self.underlying_flows:
@@ -112,6 +116,19 @@ class FlowsList:
                     # only resolve the reference, if it isn't already resolved
                     step.called_flow_reference = self.flow_by_id(step.call)
 
+    def _resolve_linked_flows(self) -> None:
+        """Resolves the linked flows.
+
+        `Resolving` here means connecting the step to the actual `Flow` object.
+        """
+        from rasa.shared.core.flows.steps import LinkFlowStep
+
+        for flow in self.underlying_flows:
+            for step in flow.steps:
+                if isinstance(step, LinkFlowStep) and not step.linked_flow_reference:
+                    # only resolve the reference, if it isn't already resolved
+                    step.linked_flow_reference = self.flow_by_id(step.link)
+
     def as_json_list(self) -> List[Dict[Text, Any]]:
         """Serialize the FlowsList object to list format and not to the original dict.
 

rasa/shared/core/flows/steps/link.py

@@ -1,9 +1,12 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Any, Dict, Text
+from typing import TYPE_CHECKING, Any, Dict, Text
 
-from rasa.shared.core.flows.flow_step import FlowStep
+from rasa.shared.core.flows.flow_step import FlowStep, Optional
+
+if TYPE_CHECKING:
+    from rasa.shared.core.flows.flow import Flow
 
 
 @dataclass
@@ -12,6 +15,8 @@ class LinkFlowStep(FlowStep):
 
     link: Text
     """The id of the flow that should be started subsequently."""
+    linked_flow_reference: Optional["Flow"] = None
+    """The flow that is linked to by this step."""
 
     def does_allow_for_next_step(self) -> bool:
         """Returns whether this step allows for following steps.

rasa/version.py

@@ -1,3 +1,3 @@
 # this file will automatically be changed,
 # do not add anything but the version number here!
-__version__ = "3.12.19"
+__version__ = "3.12.25"

{rasa_pro-3.12.19.dist-info → rasa_pro-3.12.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rasa-pro
-Version: 3.12.19
+Version: 3.12.25
 Summary: State-of-the-art open-core Conversational AI framework for Enterprises that natively leverages generative AI for effortless assistant development.
 Keywords: nlp,machine-learning,machine-learning-library,bot,bots,botkit,rasa conversational-agents,conversational-ai,chatbot,chatbot-framework,bot-framework
 Author: Rasa Technologies GmbH
@@ -81,7 +81,7 @@ Requires-Dist: portalocker (>=2.7.0,<3.0.0)
 Requires-Dist: presidio-analyzer (>=2.2.33,<2.2.34)
 Requires-Dist: presidio-anonymizer (>=2.2.354,<3.0.0)
 Requires-Dist: prompt-toolkit (>=3.0.28,<3.0.29)
-Requires-Dist: protobuf (>=4.23.3,<4.25.4)
+Requires-Dist: protobuf (>=4.25.8,<4.26.0)
 Requires-Dist: psutil (>=5.9.5,<6.0.0)
 Requires-Dist: psycopg2-binary (>=2.9.9,<2.10.0)
 Requires-Dist: pycountry (>=22.3.5,<23.0.0)
@@ -116,7 +116,7 @@ Requires-Dist: scikit-learn (>=1.5.1,<1.6.0)
 Requires-Dist: scipy (>=1.13.1,<1.14.0)
 Requires-Dist: sentencepiece[sentencepiece] (>=0.1.99,<0.2.0) ; extra == "transformers" or extra == "full"
 Requires-Dist: sentry-sdk (>=2.8.0,<3)
-Requires-Dist: setuptools (>=78.1.0,<78.2.0)
+Requires-Dist: setuptools (>=78.1.1,<78.2.0)
 Requires-Dist: sklearn-crfsuite (>=0.3.6,<0.4.0)
 Requires-Dist: skops (>=0.10.0,<0.11.0)
 Requires-Dist: slack-sdk (>=3.27.1,<3.28.0)