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

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"

rasa/shared/utils/llm.py

@@ -1,5 +1,6 @@
 import importlib.resources
 import json
+import logging
 from copy import deepcopy
 from functools import wraps
 from typing import (
@@ -7,6 +8,7 @@ from typing import (
     Any,
     Callable,
     Dict,
+    Literal,
     Optional,
     Text,
     Type,
@@ -59,6 +61,7 @@ from rasa.shared.providers.mappings import (
     get_embedding_client_from_provider,
     get_llm_client_from_provider,
 )
+from rasa.shared.utils.constants import LOG_COMPONENT_SOURCE_METHOD_INIT
 
 if TYPE_CHECKING:
     from rasa.shared.core.trackers import DialogueStateTracker
@@ -654,35 +657,59 @@ def embedder_client_factory(
 
 
 def get_prompt_template(
-    jinja_file_path: Optional[Text], default_prompt_template: Text
+    jinja_file_path: Optional[Text],
+    default_prompt_template: Text,
+    *,
+    log_source_component: Optional[Text] = None,
+    log_source_method: Optional[Literal["init", "fingerprint_addon"]] = None,
 ) -> Text:
     """Returns the jinja template.
 
     Args:
-        jinja_file_path: the path to the jinja file
-        default_prompt_template: the default prompt template
+        jinja_file_path: The path to the jinja template file. If not provided, the
+            default template will be used.
+        default_prompt_template: The fallback prompt template to use if no file is
+            found or specified.
+        log_source_component: The name of the component emitting the log, used to
+            identify the source in structured logging.
+        log_source_method: The name of the method or function emitting the log for
+            better traceability.
 
     Returns:
         The prompt template.
     """
+
     try:
         if jinja_file_path is not None:
             prompt_template = rasa.shared.utils.io.read_file(jinja_file_path)
-            structlogger.info(
-                "utils.llm.get_prompt_template.custom_prompt_template_read_successfull",
+
+            log_level = (
+                logging.INFO
+                if log_source_method == LOG_COMPONENT_SOURCE_METHOD_INIT
+                else logging.DEBUG
+            )
+
+            structlogger.log(
+                log_level,
+                "utils.llm.get_prompt_template"
+                ".custom_prompt_template_read_successfully",
                 event_info=(
                     f"Custom prompt template read successfully from "
                     f"`{jinja_file_path}`."
                 ),
                 prompt_file_path=jinja_file_path,
+                log_source_component=log_source_component,
+                log_source_method=log_source_method,
             )
             return prompt_template
     except (FileIOException, FileNotFoundException):
         structlogger.warning(
-            "utils.llm.get_prompt_template.failed_to_read_custom_prompt_template",
+            "utils.llm.get_prompt_template" ".failed_to_read_custom_prompt_template",
             event_info=(
                 "Failed to read custom prompt template. Using default template instead."
             ),
+            log_source_component=log_source_component,
+            log_source_method=log_source_method,
         )
     return default_prompt_template
 
@@ -692,50 +719,66 @@ def get_default_prompt_template_based_on_model(
     model_prompt_mapping: Dict[str, Any],
     default_prompt_path: str,
     fallback_prompt_path: str,
+    *,
+    log_source_component: Optional[Text] = None,
+    log_source_method: Optional[Literal["init", "fingerprint_addon"]] = None,
 ) -> Text:
     """Returns the default prompt template based on the model name.
 
     Args:
         llm_config: The model config.
-        model_prompt_mapping: The mapping of model name to prompt template.
-        default_prompt_path: The default prompt path of the component.
-        fallback_prompt_path: The fallback prompt path for all other models
-            that do not have a mapping in the model_prompt_mapping.
+        model_prompt_mapping: The model name -> prompt template mapping.
+        default_prompt_path: The path to the default prompt template for the component.
+        fallback_prompt_path: The fallback prompt path for all other models that do not
+            have a mapping in the model_prompt_mapping.
+        log_source_component: The name of the component emitting the log, used to
+            identify the source in structured logging.
+        log_source_method: The name of the method or function emitting the log for
+            better traceability.
 
     Returns:
         The default prompt template.
     """
+    # Extract the provider and model name information from the configuration
     _llm_config = deepcopy(llm_config)
     if MODELS_CONFIG_KEY in _llm_config:
         _llm_config = _llm_config[MODELS_CONFIG_KEY][0]
     provider = _llm_config.get(PROVIDER_CONFIG_KEY)
     model = _llm_config.get(MODEL_CONFIG_KEY)
+
+    # If the model is not defined, we default to the default prompt template.
     if not model:
-        # If the model is not defined, we default to the default prompt template.
-        structlogger.info(
-            "utils.llm.get_default_prompt_template_based_on_model.using_default_prompt_template",
+        structlogger.debug(
+            "utils.llm.get_default_prompt_template_based_on_model"
+            ".using_default_prompt_template",
             event_info=(
                 f"Model not defined in the config. Default prompt template read from"
                 f" - `{default_prompt_path}`."
             ),
             default_prompt_path=default_prompt_path,
+            log_source_component=log_source_component,
+            log_source_method=log_source_method,
         )
         return importlib.resources.read_text(
             DEFAULT_PROMPT_PACKAGE_NAME, default_prompt_path
         )
 
-    model_name = model if provider and provider in model else f"{provider}/{model}"
-    if prompt_file_path := model_prompt_mapping.get(model_name):
-        # If the model is found in the mapping, we use the model-specific prompt
-        # template.
-        structlogger.info(
-            "utils.llm.get_default_prompt_template_based_on_model.using_model_specific_prompt_template",
+    full_model_name = model if provider and provider in model else f"{provider}/{model}"
+
+    # If the model is found in the mapping, we use the model-specific prompt
+    # template.
+    if prompt_file_path := model_prompt_mapping.get(full_model_name):
+        structlogger.debug(
+            "utils.llm.get_default_prompt_template_based_on_model"
+            ".using_model_specific_prompt_template",
             event_info=(
                 f"Using model-specific default prompt template. Default prompt "
                 f"template read from - `{prompt_file_path}`."
             ),
             default_prompt_path=prompt_file_path,
-            model_name=model_name,
+            model_name=full_model_name,
+            log_source_component=log_source_component,
+            log_source_method=log_source_method,
         )
         return importlib.resources.read_text(
             DEFAULT_PROMPT_PACKAGE_NAME, prompt_file_path
@@ -743,14 +786,17 @@ def get_default_prompt_template_based_on_model(
 
     # If the model is not found in the mapping, we default to the fallback prompt
     # template.
-    structlogger.info(
-        "utils.llm.get_default_prompt_template_based_on_model.using_fallback_prompt_template",
+    structlogger.debug(
+        "utils.llm.get_default_prompt_template_based_on_model"
+        ".using_fallback_prompt_template",
         event_info=(
             f"Model not found in the model prompt mapping. Fallback prompt template "
             f"read from - `{fallback_prompt_path}`."
         ),
         fallback_prompt_path=fallback_prompt_path,
-        model_name=model_name,
+        model_name=full_model_name,
+        log_source_component=log_source_component,
+        log_source_method=log_source_method,
     )
     return importlib.resources.read_text(
         DEFAULT_PROMPT_PACKAGE_NAME, fallback_prompt_path

rasa/validator.py

@@ -531,7 +531,7 @@ class Validator:
                         condition_active_loop
                         and condition_active_loop not in self.domain.form_names
                     ):
-                        structlogger.warn(
+                        structlogger.error(
                             "validator.verify_slot_mappings.not_in_domain",
                             slot=slot.name,
                             form=condition_active_loop,
@@ -566,7 +566,6 @@ class Validator:
                                 f"The slot needs to be added to this key."
                             ),
                         )
-                        everything_is_alright = False
 
         return everything_is_alright
 

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.7.dev2"
+__version__ = "3.12.9"

{rasa_pro-3.12.7.dev2.dist-info → rasa_pro-3.12.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rasa-pro
-Version: 3.12.7.dev2
+Version: 3.12.9
 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
@@ -63,12 +63,12 @@ Requires-Dist: keras (==2.14.0)
 Requires-Dist: langchain (>=0.2.17,<0.3.0)
 Requires-Dist: langchain-community (>=0.2.19,<0.3.0)
 Requires-Dist: langcodes (>=3.5.0,<4.0.0)
-Requires-Dist: litellm (>=1.52.6,<1.53.0)
+Requires-Dist: litellm (>=1.68.0,<1.69.0)
 Requires-Dist: matplotlib (>=3.7,<3.8)
 Requires-Dist: mattermostwrapper (>=2.2,<2.3)
 Requires-Dist: networkx (>=3.1,<3.2)
 Requires-Dist: numpy (>=1.26.4,<1.27.0)
-Requires-Dist: openai (>=1.55.3,<1.56.0)
+Requires-Dist: openai (>=1.68.2,<1.69.0)
 Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
 Requires-Dist: opentelemetry-api (>=1.16.0,<1.17.0)
 Requires-Dist: opentelemetry-exporter-jaeger (>=1.16.0,<1.17.0)