rasa-pro 3.12.7.dev2__py3-none-any.whl → 3.12.8__py3-none-any.whl

rasa/dialogue_understanding/generator/multi_step/multi_step_llm_command_generator.py

@@ -52,6 +52,10 @@ from rasa.shared.exceptions import ProviderClientAPIException
 from rasa.shared.nlu.constants import TEXT
 from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.providers.llm.llm_response import LLMResponse
+from rasa.shared.utils.constants import (
+    LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON,
+    LOG_COMPONENT_SOURCE_METHOD_INIT,
+)
 from rasa.shared.utils.io import deep_container_fingerprint, raise_deprecation_warning
 from rasa.shared.utils.llm import (
     allowed_values_for_slot,
@@ -330,6 +334,8 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
         return get_prompt_template(
             config.get("prompt_templates", {}).get(key, {}).get(FILE_PATH_KEY),
             default_value,
+            log_source_component=MultiStepLLMCommandGenerator.__name__,
+            log_source_method=LOG_COMPONENT_SOURCE_METHOD_INIT,
         )
 
     @classmethod
@@ -786,17 +792,24 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
     @classmethod
     def fingerprint_addon(cls, config: Dict[str, Any]) -> Optional[str]:
         """Add a fingerprint for the graph."""
+        get_prompt_template_log_params = {
+            "log_source_component": MultiStepLLMCommandGenerator.__name__,
+            "log_source_method": LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON,
+        }
+
         handle_flows_template = get_prompt_template(
             config.get("prompt_templates", {})
             .get(HANDLE_FLOWS_KEY, {})
             .get(FILE_PATH_KEY),
             DEFAULT_HANDLE_FLOWS_TEMPLATE,
+            **get_prompt_template_log_params,
         )
         fill_slots_template = get_prompt_template(
             config.get("prompt_templates", {})
             .get(FILL_SLOTS_KEY, {})
             .get(FILE_PATH_KEY),
             DEFAULT_FILL_SLOTS_TEMPLATE,
+            **get_prompt_template_log_params,
         )
 
         llm_config = resolve_model_client_config(

rasa/dialogue_understanding/generator/single_step/compact_llm_command_generator.py

@@ -1,5 +1,5 @@
 import copy
-from typing import Any, Dict, List, Optional, Text
+from typing import Any, Dict, List, Literal, Optional, Text
 
 import structlog
 
@@ -58,6 +58,10 @@ from rasa.shared.exceptions import ProviderClientAPIException
 from rasa.shared.nlu.constants import LLM_COMMANDS, LLM_PROMPT, TEXT
 from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.providers.llm.llm_response import LLMResponse
+from rasa.shared.utils.constants import (
+    LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON,
+    LOG_COMPONENT_SOURCE_METHOD_INIT,
+)
 from rasa.shared.utils.io import deep_container_fingerprint
 from rasa.shared.utils.llm import (
     allowed_values_for_slot,
@@ -187,8 +191,8 @@ class CompactLLMCommandGenerator(LLMBasedCommandGenerator):
         )
 
         # Get the prompt template from the config or the default prompt template.
-        self.prompt_template = self.resolve_component_prompt_template(
-            self.config, prompt_template
+        self.prompt_template = self._resolve_component_prompt_template(
+            self.config, prompt_template, log_context=LOG_COMPONENT_SOURCE_METHOD_INIT
         )
 
         # Set the command syntax version to v2
@@ -539,7 +543,9 @@ class CompactLLMCommandGenerator(LLMBasedCommandGenerator):
         # and update the llm config with the resolved llm config.
         _config_copy = copy.deepcopy(config)
         _config_copy[LLM_CONFIG_KEY] = llm_config
-        prompt_template = cls.resolve_component_prompt_template(_config_copy)
+        prompt_template = cls._resolve_component_prompt_template(
+            _config_copy, log_context=LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON
+        )
 
         return deep_container_fingerprint(
             [prompt_template, llm_config, embedding_config]
@@ -555,20 +561,26 @@ class CompactLLMCommandGenerator(LLMBasedCommandGenerator):
         return CommandSyntaxVersion.v2
 
     @staticmethod
-    def resolve_component_prompt_template(
-        config: Dict[str, Any], prompt_template: Optional[str] = None
+    def _resolve_component_prompt_template(
+        config: Dict[str, Any],
+        prompt_template: Optional[str] = None,
+        log_context: Optional[Literal["init", "fingerprint_addon"]] = None,
     ) -> Optional[str]:
         """Get the prompt template from the config or the default prompt template."""
         # Get the default prompt template based on the model name.
         default_command_prompt_template = get_default_prompt_template_based_on_model(
-            config.get(LLM_CONFIG_KEY, {}) or {},
-            MODEL_PROMPT_MAPPER,
-            DEFAULT_COMMAND_PROMPT_TEMPLATE_FILE_NAME,
-            FALLBACK_COMMAND_PROMPT_TEMPLATE_FILE_NAME,
+            llm_config=config.get(LLM_CONFIG_KEY, {}) or {},
+            model_prompt_mapping=MODEL_PROMPT_MAPPER,
+            default_prompt_path=DEFAULT_COMMAND_PROMPT_TEMPLATE_FILE_NAME,
+            fallback_prompt_path=FALLBACK_COMMAND_PROMPT_TEMPLATE_FILE_NAME,
+            log_source_component=CompactLLMCommandGenerator.__name__,
+            log_source_method=log_context,
         )
 
         # Return the prompt template either from the config or the default prompt.
         return prompt_template or get_prompt_template(
             config.get(PROMPT_TEMPLATE_CONFIG_KEY),
             default_command_prompt_template,
+            log_source_component=CompactLLMCommandGenerator.__name__,
+            log_source_method=log_context,
         )

rasa/dialogue_understanding/generator/single_step/single_step_llm_command_generator.py

@@ -1,5 +1,5 @@
 import importlib.resources
-from typing import Any, Dict, Optional, Text
+from typing import Any, Dict, Literal, Optional, Text
 
 import structlog
 
@@ -25,8 +25,12 @@ from rasa.shared.constants import (
     PROMPT_CONFIG_KEY,
     PROMPT_TEMPLATE_CONFIG_KEY,
 )
+from rasa.shared.utils.constants import LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON
 from rasa.shared.utils.io import deep_container_fingerprint
-from rasa.shared.utils.llm import get_prompt_template, resolve_model_client_config
+from rasa.shared.utils.llm import (
+    get_prompt_template,
+    resolve_model_client_config,
+)
 
 DEFAULT_COMMAND_PROMPT_TEMPLATE = importlib.resources.read_text(
     "rasa.dialogue_understanding.generator.prompt_templates",
@@ -72,9 +76,6 @@ class SingleStepLLMCommandGenerator(CompactLLMCommandGenerator):
                     "Please use the config parameter 'prompt_template' instead. "
                 ),
             )
-        self.prompt_template = self.resolve_component_prompt_template(
-            config, prompt_template
-        )
 
         # Set the command syntax version to v1
         CommandSyntaxManager.set_syntax_version(
@@ -95,7 +96,9 @@ class SingleStepLLMCommandGenerator(CompactLLMCommandGenerator):
     @classmethod
     def fingerprint_addon(cls: Any, config: Dict[str, Any]) -> Optional[str]:
         """Add a fingerprint for the graph."""
-        prompt_template = cls.resolve_component_prompt_template(config)
+        prompt_template = cls._resolve_component_prompt_template(
+            config, log_context=LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON
+        )
         llm_config = resolve_model_client_config(
             config.get(LLM_CONFIG_KEY), SingleStepLLMCommandGenerator.__name__
         )
@@ -117,17 +120,29 @@ class SingleStepLLMCommandGenerator(CompactLLMCommandGenerator):
         return CommandSyntaxVersion.v1
 
     @staticmethod
-    def resolve_component_prompt_template(
-        config: Dict[str, Any], prompt_template: Optional[str] = None
+    def _resolve_component_prompt_template(
+        config: Dict[str, Any],
+        prompt_template: Optional[str] = None,
+        log_context: Optional[Literal["init", "fingerprint_addon"]] = None,
     ) -> Optional[str]:
         """Get the prompt template from the config or the default prompt template."""
-        # Get the default prompt template based on the model name.
-        config_prompt = (
+        # Case when model is being loaded
+        if prompt_template is not None:
+            return prompt_template
+
+        # The prompt can be configured in the config via the "prompt" (deprecated) or
+        # "prompt_template" properties
+        prompt_template_path = (
             config.get(PROMPT_CONFIG_KEY)
             or config.get(PROMPT_TEMPLATE_CONFIG_KEY)
             or None
         )
-        return prompt_template or get_prompt_template(
-            config_prompt,
+
+        # Try to load the template from the given path or fallback to the default for
+        # the component
+        return get_prompt_template(
+            prompt_template_path,
             DEFAULT_COMMAND_PROMPT_TEMPLATE,
+            log_source_component=SingleStepLLMCommandGenerator.__name__,
+            log_source_method=log_context,
         )

rasa/dialogue_understanding_test/du_test_case.py

@@ -241,19 +241,27 @@ class DialogueUnderstandingTestStep(BaseModel):
         # Safely extract commands from the step.
         commands = []
         for command in step.get(KEY_COMMANDS, []):
+            parsed_commands = None
             try:
-                commands.extend(
-                    parse_commands(
-                        command,
-                        flows,
-                        clarify_options_optional=True,
-                        additional_commands=custom_command_classes,
-                        default_commands_to_remove=remove_default_commands,
-                    )
+                parsed_commands = parse_commands(
+                    command,
+                    flows,
+                    clarify_options_optional=True,
+                    additional_commands=custom_command_classes,
+                    default_commands_to_remove=remove_default_commands,
                 )
             except (IndexError, ValueError) as e:
                 raise ValueError(f"Failed to parse command '{command}': {e}") from e
 
+            if not parsed_commands:
+                raise ValueError(
+                    f"Failed to parse command '{command}': command parser returned "
+                    f"None. Please make sure that you are using the correct command "
+                    f"syntax and the command arguments are valid."
+                )
+
+            commands.extend(parsed_commands)
+
         # Construct the DialogueUnderstandingTestStep
         return DialogueUnderstandingTestStep(
             actor=ACTOR_USER if ACTOR_USER in step else ACTOR_BOT,

rasa/llm_fine_tuning/paraphrasing/conversation_rephraser.py

@@ -19,6 +19,7 @@ from rasa.shared.constants import (
 )
 from rasa.shared.exceptions import ProviderClientAPIException
 from rasa.shared.providers.mappings import OPENAI_PROVIDER
+from rasa.shared.utils.constants import LOG_COMPONENT_SOURCE_METHOD_INIT
 from rasa.shared.utils.llm import (
     USER,
     get_prompt_template,
@@ -54,6 +55,8 @@ class ConversationRephraser:
         self.prompt_template = get_prompt_template(
             self.config.get(PROMPT_TEMPLATE_CONFIG_KEY),
             DEFAULT_REPHRASING_PROMPT_TEMPLATE,
+            log_source_component=ConversationRephraser.__name__,
+            log_source_method=LOG_COMPONENT_SOURCE_METHOD_INIT,
         )
 
     @staticmethod

rasa/shared/constants.py

@@ -238,6 +238,7 @@ EXTRA_PARAMETERS_KEY = "extra_parameters"
 MODEL_GROUP_ID_KEY = "model_group_id"
 MODEL_LIST_KEY = "model_list"
 LITELLM_PARAMS_KEY = "litellm_params"
+_VALIDATE_ENVIRONMENT_MISSING_KEYS_KEY = "missing_keys"
 
 LLM_API_HEALTH_CHECK_ENV_VAR = "LLM_API_HEALTH_CHECK"
 LLM_API_HEALTH_CHECK_DEFAULT_VALUE = "false"

rasa/shared/providers/_utils.py

@@ -1,7 +1,11 @@
+from typing import Any, Dict, Optional
+
 import structlog
 from litellm import validate_environment
 
 from rasa.shared.constants import (
+    API_BASE_CONFIG_KEY,
+    API_VERSION_CONFIG_KEY,
     AWS_ACCESS_KEY_ID_CONFIG_KEY,
     AWS_ACCESS_KEY_ID_ENV_VAR,
     AWS_REGION_NAME_CONFIG_KEY,
@@ -10,6 +14,9 @@ from rasa.shared.constants import (
     AWS_SECRET_ACCESS_KEY_ENV_VAR,
     AWS_SESSION_TOKEN_CONFIG_KEY,
     AWS_SESSION_TOKEN_ENV_VAR,
+    AZURE_API_BASE_ENV_VAR,
+    AZURE_API_VERSION_ENV_VAR,
+    DEPLOYMENT_CONFIG_KEY,
 )
 from rasa.shared.exceptions import ProviderClientValidationError
 from rasa.shared.providers.embedding._base_litellm_embedding_client import (
@@ -77,3 +84,79 @@ def validate_aws_setup_for_litellm_clients(
             missing_environment_variables=missing_environment_variables,
         )
         raise ProviderClientValidationError(event_info)
+
+
+def validate_azure_client_setup(
+    api_base: Optional[str],
+    api_version: Optional[str],
+    deployment: Optional[str],
+) -> None:
+    """Validates the Azure setup for LiteLLM Router clients to ensure
+     that all required configuration parameters are set.
+    Raises:
+        ProviderClientValidationError: If any required Azure configurations
+            is missing.
+    """
+
+    def generate_event_info_for_missing_setting(
+        setting: str,
+        setting_env_var: Optional[str] = None,
+        setting_config_key: Optional[str] = None,
+    ) -> str:
+        """Generate a part of the message with instructions on what to set
+        for the missing client setting.
+        """
+        info = "Set {setting} with {options}. "
+        options = ""
+        if setting_env_var is not None:
+            options += f"environment variable '{setting_env_var}'"
+        if setting_config_key is not None and setting_env_var is not None:
+            options += " or "
+        if setting_config_key is not None:
+            options += f"config key '{setting_config_key}'"
+
+        return info.format(setting=setting, options=options)
+
+    # All required settings for Azure OpenAI client
+    settings: Dict[str, Dict[str, Any]] = {
+        "API Base": {
+            "current_value": api_base,
+            "env_var": AZURE_API_BASE_ENV_VAR,
+            "config_key": API_BASE_CONFIG_KEY,
+        },
+        "API Version": {
+            "current_value": api_version,
+            "env_var": AZURE_API_VERSION_ENV_VAR,
+            "config_key": API_VERSION_CONFIG_KEY,
+        },
+        "Deployment Name": {
+            "current_value": deployment,
+            "env_var": None,
+            "config_key": DEPLOYMENT_CONFIG_KEY,
+        },
+    }
+
+    missing_settings = [
+        setting_name
+        for setting_name, setting_info in settings.items()
+        if setting_info["current_value"] is None
+    ]
+
+    if missing_settings:
+        event_info = f"Client settings not set: {', '.join(missing_settings)}. "
+
+        for missing_setting in missing_settings:
+            if settings[missing_setting]["current_value"] is not None:
+                continue
+            event_info += generate_event_info_for_missing_setting(
+                missing_setting,
+                settings[missing_setting]["env_var"],
+                settings[missing_setting]["config_key"],
+            )
+
+        structlogger.error(
+            "azure_openai_llm_client.not_configured",
+            event_info=event_info,
+            missing_settings=missing_settings,
+        )
+        raise ProviderClientValidationError(event_info)

rasa/shared/providers/llm/_base_litellm_client.py

@@ -7,7 +7,12 @@ from typing import Any, Dict, List, Union, cast
 import structlog
 from litellm import acompletion, completion, validate_environment
 
-from rasa.shared.constants import API_BASE_CONFIG_KEY, API_KEY, ROLE_USER
+from rasa.shared.constants import (
+    _VALIDATE_ENVIRONMENT_MISSING_KEYS_KEY,
+    API_BASE_CONFIG_KEY,
+    API_KEY,
+    ROLE_USER,
+)
 from rasa.shared.exceptions import (
     ProviderClientAPIException,
     ProviderClientValidationError,
@@ -21,8 +26,6 @@ from rasa.shared.utils.io import resolve_environment_variables, suppress_logs
 
 structlogger = structlog.get_logger()
 
-_VALIDATE_ENVIRONMENT_MISSING_KEYS_KEY = "missing_keys"
-
 # Suppress LiteLLM info and debug logs - Global level.
 logging.getLogger("LiteLLM").setLevel(logging.WARNING)
 

rasa/shared/providers/llm/azure_openai_llm_client.py

@@ -7,15 +7,12 @@ from typing import Any, Dict, Optional
 import structlog
 
 from rasa.shared.constants import (
-    API_BASE_CONFIG_KEY,
     API_KEY,
-    API_VERSION_CONFIG_KEY,
     AZURE_API_BASE_ENV_VAR,
     AZURE_API_KEY_ENV_VAR,
     AZURE_API_TYPE_ENV_VAR,
     AZURE_API_VERSION_ENV_VAR,
     AZURE_OPENAI_PROVIDER,
-    DEPLOYMENT_CONFIG_KEY,
     OPENAI_API_BASE_ENV_VAR,
     OPENAI_API_KEY_ENV_VAR,
     OPENAI_API_TYPE_ENV_VAR,
@@ -26,6 +23,7 @@ from rasa.shared.providers._configs.azure_openai_client_config import (
     AzureEntraIDOAuthConfig,
     AzureOpenAIClientConfig,
 )
+from rasa.shared.providers._utils import validate_azure_client_setup
 from rasa.shared.providers.constants import (
     DEFAULT_AZURE_API_KEY_NAME,
     LITE_LLM_API_BASE_FIELD,
@@ -348,68 +346,8 @@ class AzureOpenAILLMClient(_BaseLiteLLMClient):
     def validate_client_setup(self) -> None:
         """Validates that all required configuration parameters are set."""
 
-        def generate_event_info_for_missing_setting(
-            setting: str,
-            setting_env_var: Optional[str] = None,
-            setting_config_key: Optional[str] = None,
-        ) -> str:
-            """Generate a part of the message with instructions on what to set
-            for the missing client setting.
-            """
-            info = "Set {setting} with {options}. "
-            options = ""
-            if setting_env_var is not None:
-                options += f"environment variable '{setting_env_var}'"
-            if setting_config_key is not None and setting_env_var is not None:
-                options += " or "
-            if setting_config_key is not None:
-                options += f"config key '{setting_config_key}'"
-
-            return info.format(setting=setting, options=options)
-
-        env_var_field = "env_var"
-        config_key_field = "config_key"
-        current_value_field = "current_value"
-        # All required settings for Azure OpenAI client
-        settings: Dict[str, Dict[str, Any]] = {
-            "API Base": {
-                current_value_field: self.api_base,
-                env_var_field: AZURE_API_BASE_ENV_VAR,
-                config_key_field: API_BASE_CONFIG_KEY,
-            },
-            "API Version": {
-                current_value_field: self.api_version,
-                env_var_field: AZURE_API_VERSION_ENV_VAR,
-                config_key_field: API_VERSION_CONFIG_KEY,
-            },
-            "Deployment Name": {
-                current_value_field: self.deployment,
-                env_var_field: None,
-                config_key_field: DEPLOYMENT_CONFIG_KEY,
-            },
-        }
-
-        missing_settings = [
-            setting_name
-            for setting_name, setting_info in settings.items()
-            if setting_info[current_value_field] is None
-        ]
-
-        if missing_settings:
-            event_info = f"Client settings not set: " f"{', '.join(missing_settings)}. "
-
-            for missing_setting in missing_settings:
-                if settings[missing_setting][current_value_field] is not None:
-                    continue
-                event_info += generate_event_info_for_missing_setting(
-                    missing_setting,
-                    settings[missing_setting][env_var_field],
-                    settings[missing_setting][config_key_field],
-                )
-
-            structlogger.error(
-                "azure_openai_llm_client.not_configured",
-                event_info=event_info,
-                missing_settings=missing_settings,
-            )
-            raise ProviderClientValidationError(event_info)
+        return validate_azure_client_setup(
+            api_base=self.api_base,
+            api_version=self.api_version,
+            deployment=self.deployment,
+        )

rasa/shared/providers/router/_base_litellm_router_client.py

@@ -5,10 +5,16 @@ from copy import deepcopy
 from typing import Any, Dict, List
 
 import structlog
-from litellm import Router
+from litellm import Router, validate_environment
 
 from rasa.shared.constants import (
+    _VALIDATE_ENVIRONMENT_MISSING_KEYS_KEY,
+    API_BASE_CONFIG_KEY,
     API_KEY,
+    API_VERSION_CONFIG_KEY,
+    AZURE_API_BASE_ENV_VAR,
+    AZURE_API_VERSION_ENV_VAR,
+    AZURE_OPENAI_PROVIDER,
     LITELLM_PARAMS_KEY,
     MODEL_CONFIG_KEY,
     MODEL_GROUP_ID_CONFIG_KEY,
@@ -23,6 +29,7 @@ from rasa.shared.providers._configs.azure_entra_id_config import AzureEntraIDOAu
 from rasa.shared.providers._configs.litellm_router_client_config import (
     LiteLLMRouterClientConfig,
 )
+from rasa.shared.providers._utils import validate_azure_client_setup
 from rasa.shared.utils.io import resolve_environment_variables
 
 structlogger = structlog.get_logger()
@@ -183,6 +190,7 @@ class _BaseLiteLLMRouterClient:
 
     def _create_router_client(self) -> Router:
         resolved_model_configurations = self._resolve_env_vars_in_model_configurations()
+        self._validate_model_configurations(resolved_model_configurations)
         return Router(model_list=resolved_model_configurations, **self.router_settings)
 
     def _has_oauth(self) -> bool:
@@ -214,3 +222,47 @@ class _BaseLiteLLMRouterClient:
                 )
             model_configuration_with_resolved_keys.append(resolved_model_configuration)
         return model_configuration_with_resolved_keys
+
+    def _validate_model_configurations(
+        self, resolved_model_configurations: List[Dict[str, Any]]
+    ) -> None:
+        """Validates the model configurations.
+        Args:
+            resolved_model_configurations: (List[Dict[str, Any]]) The list of model
+                configurations with resolved environment variables.
+        Raises:
+            ProviderClientValidationError: If the model configurations are invalid.
+        """
+        for model_configuration in resolved_model_configurations:
+            litellm_params = model_configuration.get(LITELLM_PARAMS_KEY, {})
+
+            model = litellm_params.get(MODEL_CONFIG_KEY)
+            provider, deployment = model.split("/", 1)
+            api_base = litellm_params.get(API_BASE_CONFIG_KEY)
+
+            if provider.lower() == AZURE_OPENAI_PROVIDER:
+                validate_azure_client_setup(
+                    api_base=api_base or os.getenv(AZURE_API_BASE_ENV_VAR),
+                    api_version=litellm_params.get(API_VERSION_CONFIG_KEY)
+                    or os.getenv(AZURE_API_VERSION_ENV_VAR),
+                    deployment=deployment,
+                )
+            else:
+                validation_info = validate_environment(
+                    model=model,
+                    api_key=litellm_params.get(API_KEY),
+                    api_base=api_base,
+                )
+                if missing_environment_variables := validation_info.get(
+                    _VALIDATE_ENVIRONMENT_MISSING_KEYS_KEY
+                ):
+                    event_info = (
+                        f"Environment variables: {missing_environment_variables} "
+                        f"not set. Required for API calls."
+                    )
+                    structlogger.error(
+                        "base_litellm_router_client.validate_environment_variables",
+                        event_info=event_info,
+                        missing_environment_variables=missing_environment_variables,
+                    )
+                    raise ProviderClientValidationError(event_info)

rasa/shared/utils/constants.py

@@ -5,3 +5,6 @@ DEFAULT_READ_YAML_FILE_CACHE_MAXSIZE = 256
 RASA_PRO_BETA_PREDICATES_IN_RESPONSE_CONDITIONS_ENV_VAR_NAME = (
     "RASA_PRO_BETA_PREDICATES_IN_RESPONSE_CONDITIONS"
 )
+
+LOG_COMPONENT_SOURCE_METHOD_INIT = "init"
+LOG_COMPONENT_SOURCE_METHOD_FINGERPRINT_ADDON = "fingerprint_addon"