rasa-pro 3.11.2__py3-none-any.whl → 3.11.3a1.dev1__py3-none-any.whl

rasa/cli/studio/actions.py

@@ -0,0 +1,48 @@
+import argparse
+from typing import List
+
+from rasa.cli import SubParsersAction
+from rasa.shared.constants import DEFAULT_ACTIONS_PATH
+
+from rasa.studio.actions import handle_actions
+from rasa_sdk.cli.arguments import action_arg
+
+
+def add_subparser(
+    subparsers: SubParsersAction, parents: List[argparse.ArgumentParser]
+) -> None:
+    """Add the studio actions parser.
+
+    Args:
+        subparsers: subparser we are going to attach to
+        parents: Parent parsers, needed to ensure tree structure in argparse
+    """
+    actions_parser = subparsers.add_parser(
+        "actions",
+        parents=parents,
+        conflict_handler="resolve",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        help=("Run Rasa actions server locally and connect it to studio."),
+    )
+
+    actions_parser.set_defaults(func=handle_actions)
+
+    set_studio_actions_arguments(actions_parser)
+
+
+def set_studio_actions_arguments(parser: argparse.ArgumentParser) -> None:
+    """Add arguments for running `rasa studio download`."""
+    parser.add_argument(
+        "assistant_name",
+        default=None,
+        nargs=1,
+        type=str,
+        help="Name of the assistant on Rasa Studio",
+    )
+
+    parser.add_argument(
+        "--actions",
+        type=action_arg,
+        default=DEFAULT_ACTIONS_PATH,
+        help="name of action package to be loaded",
+    )

rasa/cli/studio/studio.py

@@ -9,6 +9,7 @@ import rasa.shared.utils.cli
 import rasa.cli.studio.download
 import rasa.cli.studio.train
 import rasa.cli.studio.upload
+import rasa.cli.studio.actions
 from rasa.studio.auth import StudioAuth
 from rasa.studio.config import StudioConfig
 
@@ -33,6 +34,7 @@ def add_subparser(
     rasa.cli.studio.train.add_subparser(studio_subparsers, parents)
     rasa.cli.studio.upload.add_subparser(studio_subparsers, parents)
     rasa.cli.studio.download.add_subparser(studio_subparsers, parents)
+    rasa.cli.studio.actions.add_subparser(studio_subparsers, parents)
 
     _add_config_subparser(studio_subparsers, parents)
     _add_login_subparser(studio_subparsers, parents)

rasa/core/actions/direct_custom_actions_executor.py

@@ -1,6 +1,8 @@
+from functools import lru_cache
 from importlib.util import find_spec
 from typing import (
     Any,
+    ClassVar,
     Dict,
     Text,
 )
@@ -21,6 +23,8 @@ structlogger = structlog.get_logger(__name__)
 
 
 class DirectCustomActionExecutor(CustomActionExecutor):
+    _actions_module_registered: ClassVar[bool] = False
+
     def __init__(self, action_name: str, action_endpoint: EndpointConfig):
         """Initializes the direct custom action executor.
 
@@ -30,9 +34,34 @@ class DirectCustomActionExecutor(CustomActionExecutor):
         """
         self.action_name = action_name
         self.action_endpoint = action_endpoint
-        self.action_executor = ActionExecutor()
+        self.action_executor = self._create_action_executor()
+        self.register_actions_from_a_module()
+        self.action_executor.reload()
+
+    @staticmethod
+    @lru_cache(maxsize=1)
+    def _create_action_executor() -> ActionExecutor:
+        """Creates and returns a cached ActionExecutor instance.
+
+        Returns:
+            ActionExecutor: The cached ActionExecutor instance.
+        """
+        return ActionExecutor()
 
     def register_actions_from_a_module(self) -> None:
+        """Registers actions from the specified module if not already registered.
+
+        This method checks if the actions module has already been registered to prevent
+        duplicate registrations. If not registered, it attempts to register the actions
+        module specified in the action endpoint configuration. If the module does not
+        exist, it raises a RasaException.
+
+        Raises:
+            RasaException: If the actions module specified does not exist.
+        """
+        if DirectCustomActionExecutor._actions_module_registered:
+            return
+
         module_name = self.action_endpoint.actions_module
         if not find_spec(module_name):
             raise RasaException(
@@ -42,6 +71,7 @@ class DirectCustomActionExecutor(CustomActionExecutor):
             )
 
         self.action_executor.register_package(module_name)
+        DirectCustomActionExecutor._actions_module_registered = True
 
     async def run(
         self,
@@ -63,7 +93,6 @@ class DirectCustomActionExecutor(CustomActionExecutor):
             "action.direct_custom_action_executor.run",
             action_name=self.action_name,
         )
-        self.register_actions_from_a_module()
 
         tracker_state = tracker.current_state(EventVerbosity.ALL)
         action_call = {

rasa/core/channels/development_inspector.py

@@ -88,6 +88,9 @@ class DevelopmentInspectProxy(InputChannel):
         """Called when a tracker has been updated."""
         if self.tracker_stream:
             tracker_dump = await self.get_tracker_state(sender_id)
+            # check if the underlying channel has an on_new_tracker_dump hook
+            if hasattr(self.underlying, "on_new_tracker_dump"):
+                await self.underlying.on_new_tracker_dump(sender_id, tracker_dump)
             await self.tracker_stream.broadcast(tracker_dump)
 
     async def on_message_proxy(

rasa/core/channels/socketio.py

@@ -212,6 +212,10 @@ class SocketIOInput(InputChannel):
             return None
         return SocketIOOutput(self.sio, self.bot_message_evt)
 
+    async def on_new_tracker_dump(self, sender_id: str, tracker_dump: str):
+        if self.sio:
+            await self.sio.emit("tracker", tracker_dump, room=sender_id)
+
     def blueprint(
         self, on_new_message: Callable[[UserMessage], Awaitable[Any]]
     ) -> Blueprint:
@@ -289,6 +293,7 @@ class SocketIOInput(InputChannel):
             metadata = data.get(self.metadata_key, {})
             if isinstance(metadata, Text):
                 metadata = json.loads(metadata)
+
             message = UserMessage(
                 data.get("message", ""),
                 output_channel,

rasa/dialogue_understanding/generator/command_generator.py

@@ -10,18 +10,25 @@ from rasa.dialogue_understanding.commands import (
     ErrorCommand,
 )
 from rasa.dialogue_understanding.commands.set_slot_command import SetSlotExtractor
+from rasa.shared.constants import (
+    RASA_PATTERN_INTERNAL_ERROR_USER_INPUT_TOO_LONG,
+    RASA_PATTERN_INTERNAL_ERROR_USER_INPUT_EMPTY,
+)
 from rasa.shared.core.constants import SlotMappingType
 from rasa.shared.core.domain import Domain
 from rasa.shared.core.flows import FlowsList
 from rasa.shared.core.slot_mappings import SlotFillingManager
 from rasa.shared.core.trackers import DialogueStateTracker
+from rasa.shared.nlu.constants import (
+    COMMANDS,
+    TEXT,
+    PREDICTED_COMMANDS,
+    PROMPTS,
+    KEY_USER_PROMPT,
+    KEY_SYSTEM_PROMPT,
+)
 from rasa.shared.nlu.training_data.message import Message
-from rasa.shared.nlu.constants import COMMANDS, TEXT
 from rasa.shared.utils.llm import DEFAULT_MAX_USER_INPUT_CHARACTERS
-from rasa.shared.constants import (
-    RASA_PATTERN_INTERNAL_ERROR_USER_INPUT_TOO_LONG,
-    RASA_PATTERN_INTERNAL_ERROR_USER_INPUT_EMPTY,
-)
 
 structlogger = structlog.get_logger()
 
@@ -193,6 +200,7 @@ class CommandGenerator:
             flows: The flows to use for command prediction.
             tracker: The tracker containing the conversation history up to now.
             **kwargs: Keyword arguments for forward compatibility.
+
         Returns:
         The predicted commands.
         """
@@ -341,3 +349,116 @@ class CommandGenerator:
         ]
 
         return filtered_commands
+
+    @staticmethod
+    def _add_commands_to_message_parse_data(
+        message: Message, component_name: str, commands: List[Command]
+    ) -> None:
+        """Add commands to the message parse data.
+
+        Commands are only added in case the flag 'record_commands_and_prompts' is set.
+        Example of predicted commands in the message parse data:
+            Message(data={
+              PREDICTED_COMMANDS: {
+                "MultiStepLLMCommandGenerator": [
+                    {"command": "set_slot", "name": "slot_name", "value": "slot_value"},
+                ],
+                "NLUCommandAdapter": [
+                    {"command": "start_flow", "name": "test_flow"},
+                ]
+              }
+            })
+        """
+        from rasa.dialogue_understanding.utils import record_commands_and_prompts
+
+        # only set commands if the flag "record_commands_and_prompts" is set to True
+        if not record_commands_and_prompts:
+            return
+
+        commands_as_dict = [command.as_dict() for command in commands]
+
+        if message.get(PREDICTED_COMMANDS) is not None:
+            predicted_commands = message.get(PREDICTED_COMMANDS)
+            if component_name in predicted_commands:
+                predicted_commands[component_name].extend(commands_as_dict)
+            else:
+                predicted_commands[component_name] = commands_as_dict
+        else:
+            predicted_commands = {component_name: commands_as_dict}
+
+        message.set(
+            PREDICTED_COMMANDS,
+            predicted_commands,
+            add_to_output=True,
+        )
+
+    @staticmethod
+    def _add_prompt_to_message_parse_data(
+        message: Message,
+        component_name: str,
+        prompt_name: str,
+        user_prompt: str,
+        system_prompt: Optional[str] = None,
+    ) -> None:
+        """Add prompt to the message parse data.
+
+        Prompt is only added in case the flag 'record_commands_and_prompts' is set.
+        Example of prompts in the message parse data:
+            Message(data={
+              PROMPTS: {
+                "MultiStepLLMCommandGenerator": [
+                    (
+                        "fill_slots_prompt",
+                        {
+                            "user_prompt": <prompt content>",
+                            "system_prompt": <prompt content>"
+                        }
+                    ),
+                    (
+                        "handle_flows_prompt",
+                        {
+                            "user_prompt": <prompt content>",
+                            "system_prompt": <prompt content>"
+                        }
+                    ),
+                ],
+                "SingleStepLLMCommandGenerator": [
+                    (
+                        "prompt_template",
+                        {
+                            "user_prompt": <prompt content>",
+                            "system_prompt": <prompt content>"
+                        }
+                    ),
+                ]
+              }
+            })
+        """
+        from rasa.dialogue_understanding.utils import record_commands_and_prompts
+
+        # only set prompt if the flag "record_commands_and_prompts" is set to True
+        if not record_commands_and_prompts:
+            return
+
+        prompt_tuple = (
+            prompt_name,
+            {
+                KEY_USER_PROMPT: user_prompt,
+                **({KEY_SYSTEM_PROMPT: system_prompt} if system_prompt else {}),
+            },
+        )
+
+        if message.get(PROMPTS) is not None:
+            prompts = message.get(PROMPTS)
+            if component_name in prompts:
+                prompts[component_name].append(prompt_tuple)
+            else:
+                prompts[component_name] = [prompt_tuple]
+        else:
+            prompts = {component_name: [prompt_tuple]}
+
+        message.set(
+            PROMPTS,
+            prompts,
+            add_to_output=True,
+        )

rasa/dialogue_understanding/generator/multi_step/multi_step_llm_command_generator.py

@@ -144,7 +144,6 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
         **kwargs: Any,
     ) -> "MultiStepLLMCommandGenerator":
         """Loads trained component (see parent class for full docstring)."""
-
         # Perform health check of the LLM client config
         llm_config = resolve_model_client_config(config.get(LLM_CONFIG_KEY, {}))
         cls.perform_llm_health_check(
@@ -200,6 +199,9 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
                 message, flows, tracker
             )
             commands = self._clean_up_commands(commands)
+            self._add_commands_to_message_parse_data(
+                message, MultiStepLLMCommandGenerator.__name__, commands
+            )
         except ProviderClientAPIException:
             # if any step resulted in API exception, the command prediction cannot
             # be completed, "predict" the ErrorCommand
@@ -542,6 +544,15 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
         )
 
         commands = self.parse_commands(actions, tracker, available_flows)
+
+        if commands:
+            self._add_prompt_to_message_parse_data(
+                message,
+                MultiStepLLMCommandGenerator.__name__,
+                "fill_slots_for_active_flow_prompt",
+                prompt,
+            )
+
         return commands
 
     async def _predict_commands_for_handling_flows(
@@ -585,6 +596,14 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
         # filter out flows that are already started and active
         commands = self._filter_redundant_start_flow_commands(tracker, commands)
 
+        if commands:
+            self._add_prompt_to_message_parse_data(
+                message,
+                MultiStepLLMCommandGenerator.__name__,
+                "handle_flows_prompt",
+                prompt,
+            )
+
         return commands
 
     @staticmethod
@@ -674,6 +693,14 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
             commands=commands,
         )
 
+        if commands:
+            self._add_prompt_to_message_parse_data(
+                message,
+                MultiStepLLMCommandGenerator.__name__,
+                "fill_slots_for_new_flow_prompt",
+                prompt,
+            )
+
         return commands
 
     def _prepare_inputs(

rasa/dialogue_understanding/generator/nlu_command_adapter.py

@@ -205,6 +205,9 @@ class NLUCommandAdapter(GraphComponent, CommandGenerator):
             commands=commands,
         )
 
+        CommandGenerator._add_commands_to_message_parse_data(
+            message, NLUCommandAdapter.__name__, commands
+        )
         return commands
 
 

rasa/dialogue_understanding/generator/single_step/single_step_llm_command_generator.py

@@ -137,7 +137,6 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
         **kwargs: Any,
     ) -> "SingleStepLLMCommandGenerator":
         """Loads trained component (see parent class for full docstring)."""
-
         # Perform health check of the LLM API endpoint
         llm_config = resolve_model_client_config(config.get(LLM_CONFIG_KEY, {}))
         cls.perform_llm_health_check(
@@ -282,6 +281,15 @@ class SingleStepLLMCommandGenerator(LLMBasedCommandGenerator):
         commands = self.parse_commands(action_list, tracker, flows)
 
         self._update_message_parse_data_for_fine_tuning(message, commands, flow_prompt)
+        self._add_commands_to_message_parse_data(
+            message, SingleStepLLMCommandGenerator.__name__, commands
+        )
+        self._add_prompt_to_message_parse_data(
+            message,
+            SingleStepLLMCommandGenerator.__name__,
+            "command_generator_prompt",
+            flow_prompt,
+        )
 
         return commands
 

rasa/dialogue_understanding/utils.py

@@ -0,0 +1,14 @@
+from contextlib import contextmanager
+from typing import Generator
+
+record_commands_and_prompts = False
+
+
+@contextmanager
+def set_record_commands_and_prompts() -> Generator:
+    global record_commands_and_prompts
+    record_commands_and_prompts = True
+    try:
+        yield
+    finally:
+        record_commands_and_prompts = False

rasa/dialogue_understanding_test/constants.py

@@ -0,0 +1,15 @@
+import rasa.e2e_test.constants as constants
+
+KEY_FIXTURES = constants.KEY_FIXTURES
+KEY_METADATA = constants.KEY_METADATA
+KEY_STUB_CUSTOM_ACTIONS = constants.KEY_STUB_CUSTOM_ACTIONS
+KEY_USER_INPUT = constants.KEY_USER_INPUT
+KEY_BOT_INPUT = constants.KEY_BOT_INPUT
+KEY_BOT_UTTERED = constants.KEY_BOT_UTTERED
+KEY_STEPS = constants.KEY_STEPS
+KEY_TEST_CASE = constants.KEY_TEST_CASE
+KEY_TEST_CASES = constants.KEY_TEST_CASES
+KEY_COMMANDS = "commands"
+
+ACTOR_USER = "user"
+ACTOR_BOT = "bot"

rasa/dialogue_understanding_test/du_test_case.py

@@ -0,0 +1,118 @@
+from typing import List, Optional, Dict, Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from rasa.dialogue_understanding.commands import Command
+from rasa.dialogue_understanding_test.constants import (
+    ACTOR_USER,
+    KEY_COMMANDS,
+    ACTOR_BOT,
+    KEY_TEST_CASE,
+    KEY_STEPS,
+    KEY_FIXTURES,
+    KEY_METADATA,
+    KEY_USER_INPUT,
+    KEY_BOT_INPUT,
+    KEY_BOT_UTTERED,
+)
+
+
+class DialogueUnderstandingOutput(BaseModel):
+    """Output containing prompts and generated commands by component.
+
+    Example of commands:
+        {
+            "MultiStepLLMCommandGenerator": [
+                {"command": "set_slot", "name": "slot_name", "value": "slot_value"},
+            ],
+            "NLUCommandAdapter": [
+                {"command": "start_flow", "name": "test_flow"},
+            ]
+        }
+
+    Example of prompts:
+        {
+            "MultiStepLLMCommandGenerator": [
+                (
+                    "fill_slots_prompt",
+                    {
+                        "user_prompt": "<prompt content>",
+                        "system_prompt": "<prompt content>"
+                    }
+                ),
+                (
+                    "handle_flows_prompt",
+                    {
+                        "user_prompt": "<prompt content>",
+                        "system_prompt": "<prompt content>"
+                    }
+                ),
+            ],
+        }
+    """
+
+    prompts: Dict[str, tuple[str, Dict[str, str]]]
+    commands: Dict[str, List[Command]]
+
+    model_config = ConfigDict(frozen=True)
+
+    def get_component_data(
+        self, component_name: str
+    ) -> tuple[Optional[tuple[str, Dict[str, str]]], List[Command]]:
+        """Get both the prompts and commands for a specific component."""
+        return self.prompts.get(component_name), self.commands.get(component_name, [])
+
+
+class DialogueUnderstandingTestStep(BaseModel):
+    actor: str
+    text: Optional[str] = None
+    template: Optional[str] = None
+    line: Optional[int] = None
+    metadata_name: Optional[str] = None
+    commands: Optional[List[Command]] = None
+    dialogue_understanding_output: Optional[DialogueUnderstandingOutput] = None
+
+    def as_dict(self) -> Dict[str, Any]:
+        if self.actor == ACTOR_USER:
+            if self.commands:
+                return {
+                    KEY_USER_INPUT: self.text,
+                    # TODO: The command should be converted into our DSL
+                    KEY_COMMANDS: [command.as_dict() for command in self.commands],
+                }
+            return {ACTOR_USER: self.text}
+        elif self.actor == ACTOR_BOT:
+            if self.text is not None:
+                return {KEY_BOT_INPUT: self.text}
+            elif self.template is not None:
+                return {KEY_BOT_UTTERED: self.template}
+
+        return {}
+
+
+class DialogueUnderstandingTestCase(BaseModel):
+    name: str
+    steps: list[DialogueUnderstandingTestStep] = Field(min_length=1)
+    file: Optional[str] = None
+    line: Optional[int] = None
+    fixture_names: Optional[List[str]] = None
+    metadata_name: Optional[str] = None
+
+    def full_name(self) -> str:
+        return f"{self.file}::{self.name}"
+
+    def as_dict(self) -> Dict[str, Any]:
+        result = {
+            KEY_TEST_CASE: self.name,
+            KEY_STEPS: [step.as_dict() for step in self.steps],
+        }
+        if self.fixture_names:
+            result[KEY_FIXTURES] = self.fixture_names
+        if self.metadata_name:
+            result[KEY_METADATA] = self.metadata_name
+        return result
+
+
+# Update forward references
+DialogueUnderstandingTestStep.model_rebuild()
+DialogueUnderstandingTestCase.model_rebuild()

rasa/dialogue_understanding_test/du_test_result.py

@@ -0,0 +1,11 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+from rasa.dialogue_understanding_test.du_test_case import DialogueUnderstandingTestCase
+
+
+class DialogueUnderstandingTestResult(BaseModel):
+    test_case: DialogueUnderstandingTestCase
+    passed: bool
+    error_line: Optional[int] = None

rasa/e2e_test/e2e_test_case.py

@@ -5,6 +5,7 @@ from typing import Any, Dict, List, Optional, Text, Union
 
 import structlog
 
+from rasa.dialogue_understanding_test.du_test_case import DialogueUnderstandingTestCase
 from rasa.e2e_test.assertions import Assertion
 from rasa.e2e_test.constants import (
     KEY_ASSERTIONS,
@@ -551,7 +552,7 @@ class Metadata:
 class TestSuite:
     """Class for representing all top level test suite keys."""
 
-    test_cases: List[TestCase]
+    test_cases: List[Union[TestCase, DialogueUnderstandingTestCase]]
     fixtures: List[Fixture]
     metadata: List[Metadata]
     stub_custom_actions: Dict[Text, StubCustomAction]

rasa/e2e_test/utils/io.py

@@ -404,7 +404,7 @@ def read_test_cases(path: str) -> TestSuite:
                 stub_data=stub_data,
             )
 
-    validate_test_case(test_case_name, input_test_cases)
+    validate_test_case(test_case_name, input_test_cases, fixtures, metadata)
     try:
         if stub_custom_actions:
             ensure_beta_feature_is_enabled(