rasa-pro 3.12.19__tar.gz → 3.12.20__tar.gz

{rasa_pro-3.12.19 → rasa_pro-3.12.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rasa-pro
-Version: 3.12.19
+Version: 3.12.20
 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

{rasa_pro-3.12.19 → rasa_pro-3.12.20}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "rasa-pro"
-version = "3.12.19"
+version = "3.12.20"
 description = "State-of-the-art open-core Conversational AI framework for Enterprises that natively leverages generative AI for effortless assistant development."
 authors = [ "Rasa Technologies GmbH <hi@rasa.com>",]
 maintainers = [ "Tom Bocklisch <tom@rasa.com>",]
@@ -374,6 +374,7 @@ convention = "google"
 
 
 
+
 [tool.poetry.group.dev.dependencies]
 ruff = ">=0.3.5,<0.4.0"
 docker = "~7.1.0"

{rasa_pro-3.12.19 → rasa_pro-3.12.20}/rasa/core/channels/voice_stream/asr/azure.py

@@ -3,6 +3,8 @@ import os
 from dataclasses import dataclass
 from typing import Any, AsyncIterator, Dict, Optional
 
+import structlog
+
 from rasa.core.channels.voice_stream.asr.asr_engine import ASREngine, ASREngineConfig
 from rasa.core.channels.voice_stream.asr.asr_event import (
     ASREvent,
@@ -13,6 +15,8 @@ from rasa.core.channels.voice_stream.audio_bytes import HERTZ, RasaAudioBytes
 from rasa.shared.constants import AZURE_SPEECH_API_KEY_ENV_VAR
 from rasa.shared.exceptions import ConnectionException
 
+logger = structlog.get_logger(__name__)
+
 
 @dataclass
 class AzureASRConfig(ASREngineConfig):
@@ -61,6 +65,11 @@ class AzureASR(ASREngine[AzureASRConfig]):
             and self.config.speech_endpoint is None
         ):
             self.config.speech_region = "eastus"
+            logger.warning(
+                "voice_channel.asr.azure.no_region",
+                message="No speech region configured, using 'eastus' as default",
+                region="eastus",
+            )
         speech_config = speechsdk.SpeechConfig(
             subscription=os.environ[AZURE_SPEECH_API_KEY_ENV_VAR],
             region=self.config.speech_region,

{rasa_pro-3.12.19 → rasa_pro-3.12.20}/rasa/core/channels/voice_stream/twilio_media_streams.py

@@ -135,6 +135,13 @@ class TwilioMediaStreamsInputChannel(VoiceInputChannel):
     def name(cls) -> str:
         return "twilio_media_streams"
 
+    def get_sender_id(self, call_parameters: CallParameters) -> str:
+        """Get the sender ID for the channel.
+
+        Twilio Media Streams uses the Stream ID as Sender ID because
+        it is required in OutputChannel.send_text_message to send messages."""
+        return call_parameters.stream_id  # type: ignore[return-value]
+
     def channel_bytes_to_rasa_audio_bytes(self, input_bytes: bytes) -> RasaAudioBytes:
         return RasaAudioBytes(base64.b64decode(input_bytes))
 

{rasa_pro-3.12.19 → rasa_pro-3.12.20}/rasa/core/channels/voice_stream/voice_channel.py

@@ -288,6 +288,17 @@ class VoiceInputChannel(InputChannel):
         self.monitor_silence = monitor_silence
         self.tts_cache = TTSCache(tts_config.get("cache_size", 1000))
 
+        logger.info(
+            "voice_channel.initialized",
+            server_url=self.server_url,
+            asr_config=self.asr_config,
+            tts_config=self.tts_config,
+        )
+
+    def get_sender_id(self, call_parameters: CallParameters) -> str:
+        """Get the sender ID for the channel."""
+        return call_parameters.call_id
+
     async def monitor_silence_timeout(self, asr_event_queue: asyncio.Queue) -> None:
         timeout = call_state.silence_timeout
         if not timeout:
@@ -334,9 +345,9 @@ class VoiceInputChannel(InputChannel):
     ) -> None:
         output_channel = self.create_output_channel(channel_websocket, tts_engine)
         message = UserMessage(
-            "/session_start",
-            output_channel,
-            call_parameters.stream_id,
+            text="/session_start",
+            output_channel=output_channel,
+            sender_id=self.get_sender_id(call_parameters),
             input_channel=self.name(),
             metadata=asdict(call_parameters),
         )
@@ -393,6 +404,9 @@ class VoiceInputChannel(InputChannel):
                     await asr_engine.send_audio_chunks(channel_action.audio_bytes)
                 elif isinstance(channel_action, EndConversationAction):
                     # end stream event came from the other side
+                    await self.handle_disconnect(
+                        channel_websocket, on_new_message, tts_engine, call_parameters
+                    )
                     break
 
         async def receive_asr_events() -> None:
@@ -449,9 +463,9 @@ class VoiceInputChannel(InputChannel):
             call_state.is_user_speaking = False  # type: ignore[attr-defined]
             output_channel = self.create_output_channel(voice_websocket, tts_engine)
             message = UserMessage(
-                e.text,
-                output_channel,
-                call_parameters.stream_id,
+                text=e.text,
+                output_channel=output_channel,
+                sender_id=self.get_sender_id(call_parameters),
                 input_channel=self.name(),
                 metadata=asdict(call_parameters),
             )
@@ -462,10 +476,27 @@ class VoiceInputChannel(InputChannel):
         elif isinstance(e, UserSilence):
             output_channel = self.create_output_channel(voice_websocket, tts_engine)
             message = UserMessage(
-                "/silence_timeout",
-                output_channel,
-                call_parameters.stream_id,
+                text="/silence_timeout",
+                output_channel=output_channel,
+                sender_id=self.get_sender_id(call_parameters),
                 input_channel=self.name(),
                 metadata=asdict(call_parameters),
             )
             await on_new_message(message)
+
+    async def handle_disconnect(
+        self,
+        channel_websocket: Websocket,
+        on_new_message: Callable[[UserMessage], Awaitable[Any]],
+        tts_engine: TTSEngine,
+        call_parameters: CallParameters,
+    ) -> None:
+        """Handle disconnection from the channel."""
+        output_channel = self.create_output_channel(channel_websocket, tts_engine)
+        message = UserMessage(
+            text="/session_end",
+            output_channel=output_channel,
+            sender_id=self.get_sender_id(call_parameters),
+            input_channel=self.name(),
+        )
+        await on_new_message(message)

{rasa_pro-3.12.19 → rasa_pro-3.12.20}/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_pro-3.12.19 → rasa_pro-3.12.20}/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_pro-3.12.19 → rasa_pro-3.12.20}/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_pro-3.12.19 → rasa_pro-3.12.20}/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_pro-3.12.19 → rasa_pro-3.12.20}/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_pro-3.12.19 → rasa_pro-3.12.20}/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.20"