rasa-pro 3.13.1a17__py3-none-any.whl → 3.13.1.dev1__py3-none-any.whl

rasa/shared/providers/llm/litellm_router_llm_client.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Dict, List, Union
+from typing import Any, Dict, List, Optional, Union
 
 import structlog
 
@@ -79,13 +79,14 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
 
     @suppress_logs(log_level=logging.WARNING)
     def _text_completion(self, prompt: Union[List[str], str]) -> LLMResponse:
-        """
-        Synchronously generate completions for given prompt.
+        """Synchronously generate completions for given prompt.
 
         Args:
             prompt: Prompt to generate the completion for.
+
         Returns:
             List of message completions.
+
         Raises:
             ProviderClientAPIException: If the API request fails.
         """
@@ -103,13 +104,14 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
 
     @suppress_logs(log_level=logging.WARNING)
     async def _atext_completion(self, prompt: Union[List[str], str]) -> LLMResponse:
-        """
-        Asynchronously generate completions for given prompt.
+        """Asynchronously generate completions for given prompt.
 
         Args:
             prompt: Prompt to generate the completion for.
+
         Returns:
             List of message completions.
+
         Raises:
             ProviderClientAPIException: If the API request fails.
         """
@@ -122,9 +124,12 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
             raise ProviderClientAPIException(e)
 
     @suppress_logs(log_level=logging.WARNING)
-    def completion(self, messages: Union[List[dict], List[str], str]) -> LLMResponse:
-        """
-        Synchronously generate completions for given list of messages.
+    def completion(
+        self,
+        messages: Union[List[dict], List[str], str],
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> LLMResponse:
+        """Synchronously generate completions for given list of messages.
 
         Method overrides the base class method to call the appropriate
         completion method based on the configuration. If the chat completions
@@ -140,8 +145,11 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
                 - a list of messages. Each message is a string and will be formatted
                     as a user message.
                 - a single message as a string which will be formatted as user message.
+            metadata: Optional metadata to be passed to the LLM call.
+
         Returns:
             List of message completions.
+
         Raises:
             ProviderClientAPIException: If the API request fails.
         """
@@ -158,10 +166,11 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
 
     @suppress_logs(log_level=logging.WARNING)
     async def acompletion(
-        self, messages: Union[List[dict], List[str], str]
+        self,
+        messages: Union[List[dict], List[str], str],
+        metadata: Optional[Dict[str, Any]] = None,
     ) -> LLMResponse:
-        """
-        Asynchronously generate completions for given list of messages.
+        """Asynchronously generate completions for given list of messages.
 
         Method overrides the base class method to call the appropriate
         completion method based on the configuration. If the chat completions
@@ -177,8 +186,11 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
                 - a list of messages. Each message is a string and will be formatted
                     as a user message.
                 - a single message as a string which will be formatted as user message.
+            metadata: Optional metadata to be passed to the LLM call.
+
         Returns:
             List of message completions.
+
         Raises:
             ProviderClientAPIException: If the API request fails.
         """
@@ -198,7 +210,6 @@ class LiteLLMRouterLLMClient(_BaseLiteLLMRouterClient, _BaseLiteLLMClient):
         """Returns the completion arguments for invoking a call through
         LiteLLM's completion functions.
         """
-
         return {
             **self._litellm_extra_parameters,
             LITE_LLM_MODEL_FIELD: self.model_group_id,

rasa/shared/providers/llm/llm_client.py

@@ -1,21 +1,19 @@
 from __future__ import annotations
 
-from typing import Dict, List, Protocol, Union, runtime_checkable
+from typing import Any, Dict, List, Optional, Protocol, Union, runtime_checkable
 
 from rasa.shared.providers.llm.llm_response import LLMResponse
 
 
 @runtime_checkable
 class LLMClient(Protocol):
-    """
-    Protocol for an LLM client that specifies the interface for interacting
+    """Protocol for an LLM client that specifies the interface for interacting
     with the API.
     """
 
     @classmethod
     def from_config(cls, config: dict) -> LLMClient:
-        """
-        Initializes the llm client with the given configuration.
+        """Initializes the llm client with the given configuration.
 
         This class method should be implemented to parse the given
         configuration and create an instance of an llm client.
@@ -24,17 +22,19 @@ class LLMClient(Protocol):
 
     @property
     def config(self) -> Dict:
-        """
-        Returns the configuration for that the llm client is initialized with.
+        """Returns the configuration for that the llm client is initialized with.
 
         This property should be implemented to return a dictionary containing
         the configuration settings for the llm client.
         """
         ...
 
-    def completion(self, messages: Union[List[dict], List[str], str]) -> LLMResponse:
-        """
-        Synchronously generate completions for given list of messages.
+    def completion(
+        self,
+        messages: Union[List[dict], List[str], str],
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> LLMResponse:
+        """Synchronously generate completions for given list of messages.
 
         This method should be implemented to take a list of messages (as
         strings) and return a list of completions (as strings).
@@ -48,16 +48,19 @@ class LLMClient(Protocol):
                 - a list of messages. Each message is a string and will be formatted
                     as a user message.
                 - a single message as a string which will be formatted as user message.
+            metadata: Optional metadata to be passed to the LLM call.
+
         Returns:
             LLMResponse
         """
         ...
 
     async def acompletion(
-        self, messages: Union[List[dict], List[str], str]
+        self,
+        messages: Union[List[dict], List[str], str],
+        metadata: Optional[Dict[str, Any]] = None,
     ) -> LLMResponse:
-        """
-        Asynchronously generate completions for given list of messages.
+        """Asynchronously generate completions for given list of messages.
 
         This method should be implemented to take a list of messages (as
         strings) and return a list of completions (as strings).
@@ -71,14 +74,15 @@ class LLMClient(Protocol):
                 - a list of messages. Each message is a string and will be formatted
                     as a user message.
                 - a single message as a string which will be formatted as user message.
+            metadata: Optional metadata to be passed to the LLM call.
+
         Returns:
             LLMResponse
         """
         ...
 
     def validate_client_setup(self, *args, **kwargs) -> None:  # type: ignore
-        """
-        Perform client setup validation.
+        """Perform client setup validation.
 
         This method should be implemented to validate whether the client can be
         used with the parameters provided through configuration or environment

rasa/shared/providers/llm/self_hosted_llm_client.py

@@ -95,8 +95,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @property
     def provider(self) -> str:
-        """
-        Returns the provider name for the self hosted llm client.
+        """Returns the provider name for the self hosted llm client.
 
         Returns:
             String representing the provider name.
@@ -105,8 +104,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @property
     def model(self) -> str:
-        """
-        Returns the model name for the self hosted llm client.
+        """Returns the model name for the self hosted llm client.
 
         Returns:
             String representing the model name.
@@ -115,8 +113,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @property
     def api_base(self) -> str:
-        """
-        Returns the base URL for the API endpoint.
+        """Returns the base URL for the API endpoint.
 
         Returns:
             String representing the base URL.
@@ -125,8 +122,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @property
     def api_type(self) -> Optional[str]:
-        """
-        Returns the type of the API endpoint. Currently only OpenAI is supported.
+        """Returns the type of the API endpoint. Currently only OpenAI is supported.
 
         Returns:
             String representing the API type.
@@ -135,8 +131,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @property
     def api_version(self) -> Optional[str]:
-        """
-        Returns the version of the API endpoint.
+        """Returns the version of the API endpoint.
 
         Returns:
             String representing the API version.
@@ -145,8 +140,8 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @property
     def config(self) -> Dict:
-        """
-        Returns the configuration for the self hosted llm client.
+        """Returns the configuration for the self hosted llm client.
+
         Returns:
             Dictionary containing the configuration.
         """
@@ -195,13 +190,14 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @suppress_logs(log_level=logging.WARNING)
     def _text_completion(self, prompt: Union[List[str], str]) -> LLMResponse:
-        """
-        Synchronously generate completions for given prompt.
+        """Synchronously generate completions for given prompt.
 
         Args:
             prompt: Prompt to generate the completion for.
+
         Returns:
             List of message completions.
+
         Raises:
             ProviderClientAPIException: If the API request fails.
         """
@@ -213,8 +209,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
     @suppress_logs(log_level=logging.WARNING)
     async def _atext_completion(self, prompt: Union[List[str], str]) -> LLMResponse:
-        """
-        Asynchronously generate completions for given prompt.
+        """Asynchronously generate completions for given prompt.
 
         Args:
             messages: The message can be,
@@ -225,8 +220,10 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
                 - a list of messages. Each message is a string and will be formatted
                     as a user message.
                 - a single message as a string which will be formatted as user message.
+
         Returns:
             List of message completions.
+
         Raises:
             ProviderClientAPIException: If the API request fails.
         """
@@ -237,7 +234,9 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
             raise ProviderClientAPIException(e)
 
     async def acompletion(
-        self, messages: Union[List[dict], List[str], str]
+        self,
+        messages: Union[List[dict], List[str], str],
+        metadata: Optional[Dict[str, Any]] = None,
     ) -> LLMResponse:
         """Asynchronous completion of the model with the given messages.
 
@@ -255,6 +254,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
                 - a list of messages. Each message is a string and will be formatted
                     as a user message.
                 - a single message as a string which will be formatted as user message.
+            metadata: Optional metadata to be passed to the LLM call.
 
         Returns:
             The completion response.
@@ -263,7 +263,11 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
             return await super().acompletion(messages)
         return await self._atext_completion(messages)
 
-    def completion(self, messages: Union[List[dict], List[str], str]) -> LLMResponse:
+    def completion(
+        self,
+        messages: Union[List[dict], List[str], str],
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> LLMResponse:
         """Completion of the model with the given messages.
 
         Method overrides the base class method to call the appropriate
@@ -273,6 +277,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
         Args:
             messages: The messages to be used for completion.
+            metadata: Optional metadata to be passed to the LLM call.
 
         Returns:
             The completion response.

rasa/studio/upload.py

@@ -7,6 +7,7 @@ from typing import Any, Dict, Iterable, List, Optional, Set, Text, Tuple, Union
 import questionary
 import requests
 import structlog
+from pydantic import BaseModel, Field
 
 import rasa.cli.telemetry
 import rasa.cli.utils
@@ -23,13 +24,9 @@ from rasa.shared.constants import (
     DEFAULT_DOMAIN_PATHS,
 )
 from rasa.shared.core.domain import Domain
-from rasa.shared.core.flows.yaml_flows_io import YAMLFlowsReader
+from rasa.shared.core.flows.yaml_flows_io import YAMLFlowsReader, YamlFlowsWriter
 from rasa.shared.exceptions import RasaException
-from rasa.shared.importers.importer import TrainingDataImporter
-from rasa.shared.importers.utils import (
-    CALMUserData,
-    extract_calm_import_parts_from_importer,
-)
+from rasa.shared.importers.importer import FlowSyncImporter, TrainingDataImporter
 from rasa.shared.nlu.training_data.formats.rasa_yaml import (
     RasaYAMLReader,
     RasaYAMLWriter,
@@ -37,6 +34,7 @@ from rasa.shared.nlu.training_data.formats.rasa_yaml import (
 from rasa.shared.utils.llm import collect_custom_prompts
 from rasa.shared.utils.yaml import (
     dump_obj_as_yaml_to_string,
+    read_yaml,
     read_yaml_file,
 )
 from rasa.studio import results_logger
@@ -45,7 +43,6 @@ from rasa.studio.config import StudioConfig
 from rasa.studio.results_logger import StudioResult, with_studio_error_handler
 from rasa.studio.utils import validate_argument_paths
 from rasa.telemetry import track_upload_to_studio_failed
-from rasa.utils.json_utils import extract_values
 
 structlogger = structlog.get_logger()
 
@@ -71,6 +68,16 @@ DOMAIN_KEYS = [
 ]
 
 
+class CALMImportParts(BaseModel):
+    """All pieces that will be uploaded to Rasa Studio."""
+
+    flows: Dict[str, Any]
+    domain: Dict[str, Any]
+    config: Dict[str, Any]
+    endpoints: Dict[str, Any]
+    nlu: Dict[str, Any] = Field(default_factory=dict)
+
+
 def _get_selected_entities_and_intents(
     args: argparse.Namespace,
     intents_from_files: Set[Text],
@@ -187,6 +194,11 @@ config_keys = [
 ]
 
 
+def extract_values(data: Dict, keys: List[Text]) -> Dict:
+    """Extracts values for given keys from a dictionary."""
+    return {key: data.get(key) for key in keys if data.get(key)}
+
+
 def _get_assistant_name(config: Dict[Text, Any]) -> str:
     config_assistant_id = config.get("assistant_id", "")
     assistant_name = questionary.text(
@@ -225,7 +237,7 @@ def build_calm_import_parts(
     config_path: Text,
     endpoints_path: Optional[Text] = None,
     assistant_name: Optional[Text] = None,
-) -> Tuple[str, CALMUserData]:
+) -> Tuple[str, CALMImportParts]:
     """Builds the parts of the assistant to be uploaded to Studio.
 
     Args:
@@ -248,10 +260,33 @@ def build_calm_import_parts(
     endpoints = read_yaml_file(endpoints_path, expand_env_vars=False)
     assistant_name = assistant_name or _get_assistant_name(config)
 
-    parts = extract_calm_import_parts_from_importer(
-        importer=importer,
+    domain_from_files = importer.get_user_domain().as_dict()
+    domain = extract_values(domain_from_files, DOMAIN_KEYS)
+
+    flow_importer = FlowSyncImporter.load_from_dict(
+        training_data_paths=[str(data_path)], expand_env_vars=False
+    )
+
+    flows = list(flow_importer.get_user_flows())
+    flows_yaml = YamlFlowsWriter().dumps(flows)
+    flows = read_yaml(flows_yaml, expand_env_vars=False)
+
+    nlu_importer = TrainingDataImporter.load_from_dict(
+        training_data_paths=[str(data_path)], expand_env_vars=False
+    )
+    nlu_data = nlu_importer.get_nlu_data()
+    nlu_examples = nlu_data.filter_training_examples(
+        lambda ex: ex.get("intent") in nlu_data.intents
+    )
+    nlu_examples_yaml = RasaYAMLWriter().dumps(nlu_examples)
+    nlu = read_yaml(nlu_examples_yaml, expand_env_vars=False)
+
+    parts = CALMImportParts(
+        flows=flows,
+        domain=domain,
         config=config,
         endpoints=endpoints,
+        nlu=nlu,
     )
 
     return assistant_name, parts

rasa/telemetry.py

@@ -1426,7 +1426,6 @@ def track_shell_started(model_type: Text, assistant_id: Text) -> None:
 
     Args:
         model_type: Type of the model, core / nlu or rasa.
-        assistant_id: ID of the assistant being inspected.
     """
     _track(
         TELEMETRY_SHELL_STARTED_EVENT,
@@ -1998,7 +1997,7 @@ def _extract_stream_pii(event_broker: Optional["EventBroker"]) -> bool:
 def track_privacy_enabled(
     privacy_config: "PrivacyConfig", event_broker: Optional["EventBroker"]
 ) -> None:
-    """Track when PII management capability is enabled."""
+    """Track when PII management capability is enabled"""
     stream_pii = _extract_stream_pii(event_broker)
     privacy_properties = _extract_privacy_enabled_event_properties(
         privacy_config, stream_pii

rasa/tracing/instrumentation/attribute_extractors.py

@@ -383,6 +383,7 @@ def extract_llm_config(
 def extract_attrs_for_llm_based_command_generator(
     self: "LLMBasedCommandGenerator",
     prompt: str,
+    metadata: Optional[Dict[str, Any]] = None,
 ) -> Dict[str, Any]:
     from rasa.dialogue_understanding.generator.flow_retrieval import (
         DEFAULT_EMBEDDINGS_CONFIG,

rasa/utils/io.py

@@ -26,7 +26,6 @@ from typing_extensions import Protocol
 
 import rasa.shared.constants
 import rasa.shared.utils.io
-from rasa.shared.exceptions import RasaException
 
 if TYPE_CHECKING:
     from prompt_toolkit.validation import Validator
@@ -125,7 +124,9 @@ def create_path(file_path: Text) -> None:
 def file_type_validator(
     valid_file_types: List[Text], error_message: Text
 ) -> Type["Validator"]:
-    """Creates a file type validator class for the questionary package."""
+    """Creates a `Validator` class which can be used with `questionary` to validate
+    file paths.
+    """
 
     def is_valid(path: Text) -> bool:
         return path is not None and any(
@@ -136,7 +137,9 @@ def file_type_validator(
 
 
 def not_empty_validator(error_message: Text) -> Type["Validator"]:
-    """Creates a not empty validator class for the questionary package."""
+    """Creates a `Validator` class which can be used with `questionary` to validate
+    that the user entered something other than whitespace.
+    """
 
     def is_valid(input: Text) -> bool:
         return input is not None and input.strip() != ""
@@ -147,7 +150,9 @@ def not_empty_validator(error_message: Text) -> Type["Validator"]:
 def create_validator(
     function: Callable[[Text], bool], error_message: Text
 ) -> Type["Validator"]:
-    """Helper method to create a validator class from a callable function."""
+    """Helper method to create `Validator` classes from callable functions. Should be
+    removed when questionary supports `Validator` objects.
+    """
     from prompt_toolkit.document import Document
     from prompt_toolkit.validation import ValidationError, Validator
 
@@ -245,26 +250,3 @@ def write_yaml(
 
     with Path(target).open("w", encoding="utf-8") as outfile:
         dumper.dump(data, outfile, transform=transform)
-
-
-class InvalidPathException(RasaException):
-    """Raised if a path is invalid - e.g. path traversal is detected."""
-
-
-def subpath(parent: str, child: str) -> str:
-    """Return the path to the child directory of the parent directory.
-
-    Ensures, that child doesn't navigate to parent directories. Prevents
-    path traversal. Raises an InvalidPathException if the path is invalid.
-
-    Based on Snyk's directory traversal mitigation:
-    https://learn.snyk.io/lesson/directory-traversal/
-    """
-    safe_path = os.path.abspath(os.path.join(parent, child))
-    parent = os.path.abspath(parent)
-
-    common_base = os.path.commonpath([parent, safe_path])
-    if common_base != parent:
-        raise InvalidPathException(f"Invalid path: {safe_path}")
-
-    return safe_path

rasa/utils/json_utils.py

@@ -1,6 +1,6 @@
 import json
 from decimal import Decimal
-from typing import Any, Dict, List, Text
+from typing import Any, Text
 
 
 class DecimalEncoder(json.JSONEncoder):
@@ -58,8 +58,3 @@ def replace_decimals_with_floats(obj: Any) -> Any:
         Input `obj` with all `Decimal` types replaced by `float`s.
     """
     return json.loads(json.dumps(obj, cls=DecimalEncoder))
-
-
-def extract_values(data: Dict, keys: List[Text]) -> Dict:
-    """Extracts values for given keys from a dictionary."""
-    return {key: data.get(key) for key in keys if data.get(key)}

rasa/utils/log_utils.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import logging
 import os
 import sys
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 import structlog
 from structlog.dev import ConsoleRenderer
@@ -37,7 +37,6 @@ class HumanConsoleRenderer(ConsoleRenderer):
 def configure_structlog(
     log_level: Optional[int] = None,
     include_time: bool = False,
-    additional_processors: Optional[List[structlog.processors.Processor]] = None,
 ) -> None:
     """Configure logging of the server."""
     if log_level is None:  # Log level NOTSET is 0 so we use `is None` here
@@ -76,9 +75,6 @@ def configure_structlog(
     if include_time:
         shared_processors.append(structlog.processors.TimeStamper(fmt="iso"))
 
-    if additional_processors:
-        shared_processors.extend(additional_processors)
-
     if not FORCE_JSON_LOGGING and sys.stderr.isatty():
         # Pretty printing when we run in a terminal session.
         # Automatically prints pretty tracebacks when "rich" is installed

rasa/utils/plotting.py

@@ -99,7 +99,7 @@ def plot_confusion_matrix(
     zmax = confusion_matrix.max() if len(confusion_matrix) > 0 else 1
     plt.clf()
     if not color_map:
-        color_map = plt.cm.get_cmap("Blues")
+        color_map = plt.cm.Blues
     plt.imshow(
         confusion_matrix,
         interpolation="nearest",

rasa/validator.py

@@ -630,14 +630,11 @@ class Validator:
         flow_id: str,
     ) -> bool:
         """Validates that a collect step can have either an action or an utterance.
-
         Also logs an error if neither an action nor an utterance is defined.
 
         Args:
             collect: the name of the slot to collect
             all_good: boolean value indicating the validation status
-            domain_slots: the slots of the domain
-            flow_id: the id of the flow
 
         Returns:
             False, if validation failed, true, otherwise
@@ -686,10 +683,9 @@ class Validator:
                 has_action_defined=has_action_defined,
                 flow=flow_id,
                 event_info=(
-                    f"The collect step '{collect.collect}' has neither a response "
-                    f"nor an action defined, nor an initial value defined in the "
-                    f"domain. You can fix this by adding a response named "
-                    f"'{collect.utter}' used in the collect step."
+                    f"The collect step '{collect.collect}' has neither an utterance "
+                    f"nor an action defined, or an initial value defined in the domain."
+                    f"You need to define either an utterance or an action."
                 ),
             )
             all_good = False

rasa/version.py

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