rasa-pro 3.10.7.dev5__py3-none-any.whl → 3.10.8__py3-none-any.whl

rasa/shared/providers/llm/self_hosted_llm_client.py

@@ -4,9 +4,13 @@ from litellm import (
     atext_completion,
 )
 import logging
+import os
 import structlog
 
-from rasa.shared.constants import OPENAI_PROVIDER
+from rasa.shared.constants import (
+    SELF_HOSTED_VLLM_PREFIX,
+    SELF_HOSTED_VLLM_API_KEY_ENV_VAR,
+)
 from rasa.shared.providers._configs.self_hosted_llm_client_config import (
     SelfHostedLLMClientConfig,
 )
@@ -57,6 +61,7 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
         self._api_version = api_version
         self._use_chat_completions_endpoint = use_chat_completions_endpoint
         self._extra_parameters = kwargs or {}
+        self._apply_dummy_api_key_if_missing()
 
     @classmethod
     def from_config(cls, config: Dict[str, Any]) -> "SelfHostedLLMClient":
@@ -157,8 +162,8 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
 
         <openai>/<model or deployment name>
         """
-        if self.model and f"{OPENAI_PROVIDER}/" not in self.model:
-            return f"{OPENAI_PROVIDER}/{self.model}"
+        if self.model and f"{SELF_HOSTED_VLLM_PREFIX}/" not in self.model:
+            return f"{SELF_HOSTED_VLLM_PREFIX}/{self.model}"
         return self.model
 
     @property
@@ -279,3 +284,10 @@ class SelfHostedLLMClient(_BaseLiteLLMClient):
             formatted_response=formatted_response.to_dict(),
         )
         return formatted_response
+
+    @staticmethod
+    def _apply_dummy_api_key_if_missing() -> None:
+        if not os.getenv(SELF_HOSTED_VLLM_API_KEY_ENV_VAR):
+            os.environ[SELF_HOSTED_VLLM_API_KEY_ENV_VAR] = (
+                "dummy_self_hosted_llm_api_key"
+            )

rasa/shared/utils/common.py

@@ -86,11 +86,31 @@ def sort_list_of_dicts_by_first_key(dicts: List[Dict]) -> List[Dict]:
     return sorted(dicts, key=lambda d: next(iter(d.keys())))
 
 
+def lazy_property(function: Callable) -> Any:
+    """Allows to avoid recomputing a property over and over.
+
+    The result gets stored in a local var. Computation of the property
+    will happen once, on the first call of the property. All
+    succeeding calls will use the value stored in the private property.
+    """
+    attr_name = "_lazy_" + function.__name__
+
+    def _lazyprop(self: Any) -> Any:
+        if not hasattr(self, attr_name):
+            setattr(self, attr_name, function(self))
+        return getattr(self, attr_name)
+
+    return property(_lazyprop)
+
+
 def cached_method(f: Callable[..., Any]) -> Callable[..., Any]:
     """Caches method calls based on the call's `args` and `kwargs`.
+
     Works for `async` and `sync` methods. Don't apply this to functions.
+
     Args:
         f: The decorated method whose return value should be cached.
+
     Returns:
         The return value which the method gives for the first call with the given
         arguments.
@@ -156,9 +176,8 @@ def transform_collection_to_sentence(collection: Collection[Text]) -> Text:
 def minimal_kwargs(
     kwargs: Dict[Text, Any], func: Callable, excluded_keys: Optional[List] = None
 ) -> Dict[Text, Any]:
-    """Returns only the kwargs which are required by a function.
-
-    Keys, contained in the exception list, are not included.
+    """Returns only the kwargs which are required by a function. Keys, contained in
+    the exception list, are not included.
 
     Args:
         kwargs: All available kwargs.

rasa/shared/utils/llm.py

@@ -12,6 +12,7 @@ from typing import (
     cast,
 )
 import json
+
 import structlog
 
 import rasa.shared.utils.io
@@ -410,10 +411,10 @@ def try_instantiate_llm_client(
     default_llm_config: Optional[Dict],
     log_source_function: str,
     log_source_component: str,
-) -> LLMClient:
+) -> None:
     """Validate llm configuration."""
     try:
-        return llm_factory(custom_llm_config, default_llm_config)
+        llm_factory(custom_llm_config, default_llm_config)
     except (ProviderClientValidationError, ValueError) as e:
         structlogger.error(
             f"{log_source_function}.llm_instantiation_failed",
@@ -422,32 +423,7 @@ def try_instantiate_llm_client(
         )
         print_error_and_exit(
             f"Unable to create the LLM client for component - {log_source_component}. "
-            f"Please make sure you specified the required environment variables. "
-            f"Error: {e}"
-        )
-
-
-def llm_api_health_check(
-    llm_client: LLMClient, log_source_function: str, log_source_component: str
-) -> None:
-    """Perform a health check on the LLM API."""
-    structlogger.info(
-        f"{log_source_function}.llm_api_call",
-        event_info=(
-            f"Performing a health check on the LLM API for the component - "
-            f"{log_source_component}."
-        ),
-        config=llm_client.config,
-    )
-    try:
-        llm_client.completion("hello")
-    except Exception as e:
-        structlogger.error(
-            f"{log_source_function}.llm_api_call_failed",
-            event_info="call to the LLM API failed.",
-            error=e,
-        )
-        print_error_and_exit(
-            f"Call to the LLM API failed for component - {log_source_component}. "
+            f"Please make sure you specified the required environment variables "
+            f"and configuration keys. "
             f"Error: {e}"
         )

rasa/shared/utils/schemas/model_config.yml

@@ -34,3 +34,13 @@ mapping:
           name:
             type: str
             required: True
+  spaces:
+    type: "seq"
+    required: False
+    sequence:
+      - type: "map"
+        allowempty: True
+        mapping:
+          name:
+            type: str
+            required: True

rasa/studio/auth.py

@@ -21,15 +21,19 @@ from rasa.studio.results_logger import with_studio_error_handler, StudioResult
 
 
 class StudioAuth:
+    """Handles the authentication with the Rasa Studio authentication server."""
+
     def __init__(
         self,
         studio_config: StudioConfig,
+        verify: bool = True,
     ) -> None:
         self.config = studio_config
         self.keycloak_openid = KeycloakOpenID(
             server_url=studio_config.authentication_server_url,
             client_id=studio_config.client_id,
             realm_name=studio_config.realm_name,
+            verify=verify,
         )
 
     def health_check(self) -> bool:

rasa/tracing/instrumentation/attribute_extractors.py

@@ -664,7 +664,7 @@ def extract_attrs_for_custom_action_executor_run(
 
     attrs: Dict[str, Any] = {
         "class_name": self.__class__.__name__,
-        "action_name": self.action_name if hasattr(self, "action_name") else "None",
+        "action_name": self.action_name,
         "sender_id": tracker.sender_id,
         "url": str(url),
         "actions_module": str(actions_module),

rasa/validator.py

@@ -1,10 +1,10 @@
 import logging
-import structlog
 import re
 import string
 from collections import defaultdict
 from typing import Set, Text, Optional, Dict, Any, List, Tuple
 
+import structlog
 from jinja2 import Template
 from pypred import Predicate
 from pypred.ast import Literal, CompareOperator, NegateOperator
@@ -596,6 +596,7 @@ class Validator:
         collect: CollectInformationFlowStep,
         all_good: bool,
         domain_slots: Dict[Text, Slot],
+        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.
@@ -625,6 +626,7 @@ class Validator:
                 collect=collect.collect,
                 has_utterance_defined=has_utterance_defined,
                 has_action_defined=has_action_defined,
+                flow=flow_id,
                 event_info=(
                     f"The collect step '{collect.collect}' has an utterance "
                     f"'{collect.utter}' as well as an action "
@@ -648,6 +650,7 @@ class Validator:
                 collect=collect.collect,
                 has_utterance_defined=has_utterance_defined,
                 has_action_defined=has_action_defined,
+                flow=flow_id,
                 event_info=(
                     f"The collect step '{collect.collect}' has neither an utterance "
                     f"nor an action defined, or an initial value defined in the domain."
@@ -716,7 +719,7 @@ class Validator:
                 if isinstance(step, CollectInformationFlowStep):
                     all_good = (
                         self._log_error_if_either_action_or_utterance_are_not_defined(
-                            step, all_good, domain_slots
+                            step, all_good, domain_slots, flow.id
                         )
                     )
 

rasa/version.py

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

{rasa_pro-3.10.7.dev5.dist-info → rasa_pro-3.10.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rasa-pro
-Version: 3.10.7.dev5
+Version: 3.10.8
 Summary: State-of-the-art open-core Conversational AI framework for Enterprises that natively leverages generative AI for effortless assistant development.
 Home-page: https://rasa.com
 Keywords: nlp,machine-learning,machine-learning-library,bot,bots,botkit,rasa conversational-agents,conversational-ai,chatbot,chatbot-framework,bot-framework
@@ -32,7 +32,7 @@ Requires-Dist: aiohttp (>=3.9.4,<3.10)
 Requires-Dist: apscheduler (>=3.10,<3.11)
 Requires-Dist: attrs (>=23.1,<23.2)
 Requires-Dist: azure-storage-blob (>=12.16.0,<12.17.0)
-Requires-Dist: boto3 (>=1.35.15,<1.36.0)
+Requires-Dist: boto3 (>=1.35.5,<1.36.0)
 Requires-Dist: certifi (>=2024.07.04)
 Requires-Dist: cloudpickle (>=2.2.1,<3.1)
 Requires-Dist: colorama (>=0.4.6,<0.5.0) ; sys_platform == "win32"
@@ -53,8 +53,8 @@ Requires-Dist: gitpython (>=3.1.41,<3.2.0) ; extra == "full"
 Requires-Dist: google-auth (>=2.23.4,<3)
 Requires-Dist: google-cloud-storage (>=2.14.0,<3.0.0)
 Requires-Dist: hvac (>=1.2.1,<2.0.0)
-Requires-Dist: importlib-metadata (>=6.8.0,<7.0.0)
-Requires-Dist: importlib-resources (>=6.1.1,<7.0.0)
+Requires-Dist: importlib-metadata (>=8.5.0,<8.6.0)
+Requires-Dist: importlib-resources (==6.1.3)
 Requires-Dist: jieba (>=0.42.1,<0.43) ; extra == "jieba" or extra == "full"
 Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
 Requires-Dist: joblib (>=1.2.0,<1.3.0)
@@ -64,13 +64,13 @@ Requires-Dist: jsonschema (>=4.22)
 Requires-Dist: keras (==2.14.0)
 Requires-Dist: langchain (>=0.2.0,<0.3.0)
 Requires-Dist: langchain-community (>=0.2.0,<0.3.0)
-Requires-Dist: litellm (>=1.45.0,<1.46.0)
+Requires-Dist: litellm (>=1.50.0,<1.51.0)
 Requires-Dist: matplotlib (>=3.7,<3.8)
 Requires-Dist: mattermostwrapper (>=2.2,<2.3)
 Requires-Dist: mlflow (>=2.15.1,<3.0.0) ; extra == "mlflow"
 Requires-Dist: networkx (>=3.1,<3.2)
 Requires-Dist: numpy (>=1.23.5,<1.25.0) ; python_version >= "3.9" and python_version < "3.11"
-Requires-Dist: openai (>=1.47.0,<1.48.0)
+Requires-Dist: openai (>=1.52.0,<1.53.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)
@@ -390,6 +390,39 @@ To check the types execute
 make types
 ```
 
+### Backporting
+
+In order to port changes to `main` and across release branches, we use the `backport` workflow located at
+the `.github/workflows/backport.yml` path.
+This workflow is triggered by the `backport-to-<release-branch>` label applied to a PR, for example `backport-to-3.8.x`.
+Current available target branches are `main` and maintained release branches.
+
+When a PR gets labelled `backport-to-<release-branch>`, a PR is opened by the `backport-github-action` as soon as the
+source PR gets closed (by merging). If you want to close the PR without merging changes, make sure to remove the `backport-to-<release-branch>` label.
+
+The PR author which the action assigns to the backporting PR has to resolve any conflicts before approving and merging.
+Release PRs should also be labelled with `backport-to-main` to backport the `CHANGELOG.md` updates to `main`.
+Backporting version updates should be accepted to the `main` branch from the latest release branch only.
+
+Here are some guidelines to follow when backporting changes and resolving conflicts:
+
+a) for conflicts in `version.py`: accept only the version from the latest release branch. Do not merge version changes
+from earlier release branches into `main` because this could cause issues when trying to make the next minor release.
+
+b) for conflicts in `pyproject.toml`: if related to the `rasa-pro` version, accept only the latest release branch; 
+if related to other dependencies, accept `main` or whichever is the higher upgrade (main usually has the updated 
+dependencies because we only do housekeeping on `main`, apart from vulnerability updates). Be mindful of dependencies that
+are removed from `main` but still exist in former release branches (for example `langchain`).
+
+c) for conflicts in `poetry.lock`: accept changes which were already present on the target branch, then run
+`poetry lock --no-update` so that the lock file contains your changes from `pyproject.toml` too.
+
+d) for conflicts in `CHANGELOG.md`: Manually place the changelog in their allocated section (e.g. 3.8.10 will go under the 
+3.8 section with the other releases, rather than go at the top of the file)
+
+If the backporting workflow fails, you are encouraged to cherry-pick the commits manually and create a PR to
+the target branch. Alternatively, you can install the backporting CLI tool as described [here](https://github.com/sorenlouv/backport?tab=readme-ov-file#install).
+
 ## Releases
 Rasa has implemented robust policies governing version naming, as well as release pace for major, minor, and patch releases.
 
@@ -472,9 +505,12 @@ Releasing a new version is quite simple, as the packages are build and distribut
 9. If however an error occurs in the build, then we should see a failure message automatically posted in the company's Slack (`dev-tribe` channel) like this [one](https://rasa-hq.slack.com/archives/C01M5TAHDHA/p1701444735622919)
    (In this case do the following checks):
     - Check the workflows in [Github Actions](https://github.com/RasaHQ/rasa-private/actions) and make sure that the merged PR of the current release is completed successfully. To easily find your PR you can use the filters `event: push` and `branch: <version number>` (example on release 2.4 you can see [here](https://github.com/RasaHQ/rasa/actions/runs/643344876))
-    - If the workflow is not completed, then try to re run the workflow in case that solves the problem
+    - If the workflow is not completed, then try to re-run the workflow in case that solves the problem
     - If the problem persists, check also the log files and try to find the root cause of the issue
     - If you still cannot resolve the error, contact the infrastructure team by providing any helpful information from your investigation
+10. If the release is successful, add the newly created release branch to the backporting configuration in the `.backportrc.json` file to
+the `targetBranchesChoices` list. This is necessary for the backporting workflow to work correctly with new release branches.
+
 
 ### Cutting a Patch release