beekeeper-monitors-watsonx 1.0.5.post1__py3-none-any.whl → 1.0.7__py3-none-any.whl

beekeeper/monitors/watsonx/supporting_classes/credentials.py

@@ -0,0 +1,137 @@
+from typing import Any, Dict, Literal, Optional, Union
+
+from pydantic.v1 import BaseModel
+
+
+class CloudPakforDataCredentials(BaseModel):
+    """
+    Encapsulates the credentials required for IBM Cloud Pak for Data.
+
+    Attributes:
+        url (str): The host URL of the Cloud Pak for Data environment.
+        api_key (str, optional): The API key for the environment, if IAM is enabled.
+        username (str, optional): The username for the environment.
+        password (str, optional): The password for the environment.
+        bedrock_url (str, optional): The Bedrock URL. Required only when IAM integration is enabled on CP4D 4.0.x clusters.
+        instance_id (str, optional): The instance ID.
+        version (str, optional): The version of Cloud Pak for Data.
+        disable_ssl_verification (bool, optional): Indicates whether to disable SSL certificate verification.
+            Defaults to `True`.
+    """
+
+    url: str
+    api_key: Optional[str] = None
+    username: Optional[str] = None
+    password: Optional[str] = None
+    bedrock_url: Optional[str] = None
+    instance_id: Optional[Literal["icp", "openshift"]] = None
+    version: Optional[str] = None
+    disable_ssl_verification: bool = True
+
+    def __init__(
+        self,
+        url: str,
+        api_key: Optional[str] = None,
+        username: Optional[str] = None,
+        password: Optional[str] = None,
+        bedrock_url: Optional[str] = None,
+        instance_id: Optional[Literal["icp", "openshift"]] = None,
+        version: Optional[str] = None,
+        disable_ssl_verification: bool = True,
+    ) -> None:
+        super().__init__(
+            url=url,
+            api_key=api_key,
+            username=username,
+            password=password,
+            bedrock_url=bedrock_url,
+            instance_id=instance_id,
+            version=version,
+            disable_ssl_verification=disable_ssl_verification,
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        cpd_creds = dict([(k, v) for k, v in self.__dict__.items()])  # noqa: C404
+
+        if "instance_id" in cpd_creds and self.instance_id.lower() not in [
+            "icp",
+            "openshift",
+        ]:
+            cpd_creds.pop("instance_id")
+
+        return cpd_creds
+
+
+class IntegratedSystemCredentials(BaseModel):
+    """
+    Encapsulates the credentials for an Integrated System based on the authentication type.
+
+    Depending on the `auth_type`, only a subset of the properties is required.
+
+    Attributes:
+        auth_type (str): The type of authentication. Currently supports "basic" and "bearer".
+        username (str, optional): The username for Basic Authentication.
+        password (str, optional): The password for Basic Authentication.
+        token_url (str, optional): The URL of the authentication endpoint used to request a Bearer token.
+        token_method (str, optional): The HTTP method (e.g., "POST", "GET") used to request the Bearer token.
+            Defaults to "POST".
+        token_headers (Dict, optional): Optional headers to include when requesting the Bearer token.
+            Defaults to `None`.
+        token_payload (str | dict, optional): The body or payload to send when requesting the Bearer token.
+            Can be a string (e.g., raw JSON). Defaults to `None`.
+    """
+
+    auth_type: Literal["basic", "bearer"]
+    username: Optional[str]  # basic
+    password: Optional[str]  # basic
+    token_url: Optional[str]  # bearer
+    token_method: Optional[str] = "POST"  # bearer
+    token_headers: Optional[Dict] = {}  # bearer
+    token_payload: Optional[Union[str, Dict]] = None  # bearer
+
+    def __init__(
+        self,
+        auth_type: Literal["basic", "bearer"],
+        username: str = None,
+        password: str = None,
+        token_url: str = None,
+        token_method: str = "POST",
+        token_headers: Dict = {},
+        token_payload: Union[str, Dict] = None,
+    ) -> None:
+        if auth_type == "basic":
+            if not username or not password:
+                raise ValueError(
+                    "`username` and `password` are required for auth_type = 'basic'.",
+                )
+        elif auth_type == "bearer":
+            if not token_url:
+                raise ValueError(
+                    "`token_url` are required for auth_type = 'bearer'.",
+                )
+
+        super().__init__(
+            auth_type=auth_type,
+            username=username,
+            password=password,
+            token_url=token_url,
+            token_method=token_method,
+            token_headers=token_headers,
+            token_payload=token_payload,
+        )
+
+    def to_dict(self) -> Dict:
+        integrated_system_creds = {"auth_type": self.auth_type}
+
+        if self.auth_type == "basic":
+            integrated_system_creds["username"] = self.username
+            integrated_system_creds["password"] = self.password
+        elif self.auth_type == "bearer":
+            integrated_system_creds["token_info"] = {
+                "url": self.token_url,
+                "method": self.token_method,
+                "headers": self.token_headers,
+                "payload": self.token_payload,
+            }
+
+        return integrated_system_creds

beekeeper/monitors/watsonx/supporting_classes/enums.py

@@ -0,0 +1,71 @@
+from enum import Enum
+
+_REGION_DATA = {
+    "us-south": {
+        "watsonxai": "https://us-south.ml.cloud.ibm.com",
+        "openscale": "https://api.aiopenscale.cloud.ibm.com",
+        "factsheet": None,
+    },
+    "eu-de": {
+        "watsonxai": "https://eu-de.ml.cloud.ibm.com",
+        "openscale": "https://eu-de.api.aiopenscale.cloud.ibm.com",
+        "factsheet": "frankfurt",
+    },
+    "au-syd": {
+        "watsonxai": "https://au-syd.ml.cloud.ibm.com",
+        "openscale": "https://au-syd.api.aiopenscale.cloud.ibm.com",
+        "factsheet": "sydney",
+    },
+}
+
+
+class Region(str, Enum):
+    """
+    Supported IBM watsonx.governance regions.
+
+    Defines the available regions where watsonx.governance SaaS
+    services are deployed.
+
+    Attributes:
+        US_SOUTH (str): "us-south".
+        EU_DE (str): "eu-de".
+        AU_SYD (str): "au-syd".
+    """
+
+    US_SOUTH = "us-south"
+    EU_DE = "eu-de"
+    AU_SYD = "au-syd"
+
+    @property
+    def watsonxai(self):
+        return _REGION_DATA[self.value]["watsonxai"]
+
+    @property
+    def openscale(self):
+        return _REGION_DATA[self.value]["openscale"]
+
+    @property
+    def factsheet(self):
+        return _REGION_DATA[self.value]["factsheet"]
+
+    @classmethod
+    def from_value(cls, value):
+        if value is None:
+            return cls.US_SOUTH
+
+        if isinstance(value, cls):
+            return value
+
+        if isinstance(value, str):
+            try:
+                return cls(value)
+            except ValueError:
+                raise ValueError(
+                    "Invalid value for parameter 'region'. Received: '{}'. Valid values are: {}.".format(
+                        value, [item.value for item in Region]
+                    )
+                )
+
+        raise TypeError(
+            f"Invalid type for parameter 'region'. Expected str or Region, but received {type(value).__name__}."
+        )

beekeeper/monitors/watsonx/supporting_classes/metric.py

@@ -0,0 +1,109 @@
+from typing import Dict, List, Literal, Optional
+
+from pydantic.v1 import BaseModel
+
+
+class WatsonxLocalMetric(BaseModel):
+    """
+    Provides the IBM watsonx.governance local monitor metric definition.
+
+    Attributes:
+        name (str): The name of the metric.
+        data_type (str): The data type of the metric. Currently supports "string", "integer", "double", and "timestamp".
+        nullable (bool, optional): Indicates whether the metric can be null. Defaults to `False`.
+
+    Example:
+        ```python
+        from beekeeper.monitors.watsonx import WatsonxLocalMetric
+
+        WatsonxLocalMetric(name="context_quality", data_type="double")
+        ```
+    """
+
+    name: str
+    data_type: Literal["string", "integer", "double", "timestamp"]
+    nullable: bool = True
+
+    def to_dict(self) -> Dict:
+        return {"name": self.name, "type": self.data_type, "nullable": self.nullable}
+
+
+class WatsonxMetricThreshold(BaseModel):
+    """
+    Defines the metric threshold for IBM watsonx.governance.
+
+    Attributes:
+        threshold_type (str): The threshold type. Can be either `lower_limit` or `upper_limit`.
+        default_value (float): The metric threshold value.
+
+    Example:
+        ```python
+        from beekeeper.monitors.watsonx import WatsonxMetricThreshold
+
+        WatsonxMetricThreshold(threshold_type="lower_limit", default_value=0.8)
+        ```
+    """
+
+    threshold_type: Literal["lower_limit", "upper_limit"]
+    default_value: float = None
+
+    def to_dict(self) -> Dict:
+        return {"type": self.threshold_type, "default": self.default_value}
+
+
+class WatsonxMetric(BaseModel):
+    """
+    Defines the IBM watsonx.governance global monitor metric.
+
+    Attributes:
+        name (str): The name of the metric.
+        applies_to (List[str]): A list of task types that the metric applies to. Currently supports:
+            "summarization", "generation", "question_answering", "extraction", and "retrieval_augmented_generation".
+        thresholds (List[WatsonxMetricThreshold]): A list of metric thresholds associated with the metric.
+
+    Example:
+        ```python
+        from beekeeper.monitors.watsonx import (
+            WatsonxMetric,
+            WatsonxMetricThreshold,
+        )
+
+        WatsonxMetric(
+            name="context_quality",
+            applies_to=["retrieval_augmented_generation", "summarization"],
+            thresholds=[
+                WatsonxMetricThreshold(threshold_type="lower_limit", default_value=0.75)
+            ],
+        )
+        ```
+    """
+
+    name: str
+    applies_to: List[
+        Literal[
+            "summarization",
+            "generation",
+            "question_answering",
+            "extraction",
+            "retrieval_augmented_generation",
+        ]
+    ]
+    thresholds: Optional[List[WatsonxMetricThreshold]] = None
+
+    def to_dict(self) -> Dict:
+        from ibm_watson_openscale.base_classes.watson_open_scale_v2 import (
+            ApplicabilitySelection,
+            MetricThreshold,
+        )
+
+        monitor_metric = {
+            "name": self.name,
+            "applies_to": ApplicabilitySelection(problem_type=self.applies_to),
+        }
+
+        if self.thresholds is not None:
+            monitor_metric["thresholds"] = [
+                MetricThreshold(**threshold.to_dict()) for threshold in self.thresholds
+            ]
+
+        return monitor_metric

beekeeper/monitors/watsonx/utils/data_utils.py

@@ -0,0 +1,31 @@
+from typing import Dict, List
+
+
+def validate_and_filter_dict(
+    original_dict: Dict, optional_keys: List, required_keys: List = []
+):
+    """
+    Validates that all required keys are present in a dictionary and returns a filtered dictionary
+    containing only the required and specified optional keys with non-None values.
+
+    Args:
+        original_dict (Dict): The original dictionary.
+        optional_keys (list): A list of keys to retain.
+        required_keys (list, optional): A list of keys that must be present in the dictionary. Defaults to None.
+    """
+    # Ensure all required keys are in the source dict
+    missing_keys = [key for key in required_keys if key not in original_dict]
+    if missing_keys:
+        raise KeyError(
+            f"Validation failed: the following required key(s) are missing from the dictionary: {missing_keys}. "
+            "Please provide these keys before proceeding."
+        )
+
+    all_keys_to_keep = set(required_keys + optional_keys)
+
+    # Create a new dictionary with only the key-value pairs where the key is in 'keys' and value is not None
+    return {
+        key: original_dict[key]
+        for key in all_keys_to_keep
+        if key in original_dict and original_dict[key] is not None
+    }

{beekeeper_monitors_watsonx-1.0.5.post1.dist-info → beekeeper_monitors_watsonx-1.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beekeeper-monitors-watsonx
-Version: 1.0.5.post1
+Version: 1.0.7
 Summary: beekeeper monitors watsonx extension
 Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>
 License: Apache-2.0

beekeeper_monitors_watsonx-1.0.7.dist-info/RECORD

@@ -0,0 +1,12 @@
+beekeeper/monitors/watsonx/__init__.py,sha256=iJv6D68IT00ZC40TNSVYtqyFTen9sWoDqUtxvVVJjOE,789
+beekeeper/monitors/watsonx/base.py,sha256=_nCOD09F46O64T9964gvCyhmX8hFupb0T9DDZlRftBs,47075
+beekeeper/monitors/watsonx/custom_metric.py,sha256=eoosf2WKdru28ShhLEdlj5ldjyYGl3Feop6TA1U3gZY,22185
+beekeeper/monitors/watsonx/supporting_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+beekeeper/monitors/watsonx/supporting_classes/credentials.py,sha256=x4rYoOFvx0pWDhFZfuy6fM0rj7JCivaSYn_jYFXlV8U,5190
+beekeeper/monitors/watsonx/supporting_classes/enums.py,sha256=7HkSrjU7D8pFPCRdYk_1oE27r_sZ_nIL6cuShIdtmR8,1895
+beekeeper/monitors/watsonx/supporting_classes/metric.py,sha256=iERXRi0iBFHITFaLtonoV97nNUCPXbieD7Z1wX6bvX8,3370
+beekeeper/monitors/watsonx/utils/data_utils.py,sha256=qBLYtHGY0MJ0JJ8BpFDT2YIjA3QOYJQNemLvpA3DMz0,1252
+beekeeper/monitors/watsonx/utils/instrumentation.py,sha256=ztgR1kZ9h-JvASzRA47AYHdc-Isv33EQum9XBLg-dQk,525
+beekeeper_monitors_watsonx-1.0.7.dist-info/METADATA,sha256=NHZe3EfiayFDVoY4TK7Qoo9U0mqPyyqxEXxncEgnefM,716
+beekeeper_monitors_watsonx-1.0.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beekeeper_monitors_watsonx-1.0.7.dist-info/RECORD,,

beekeeper_monitors_watsonx-1.0.5.post1.dist-info/RECORD

@@ -1,6 +0,0 @@
-beekeeper/monitors/watsonx/__init__.py,sha256=erL0eO3J4wf1_i8kwK242uyXkMPElY3uftW6-ThqGow,521
-beekeeper/monitors/watsonx/base.py,sha256=3mrzGrKFx4lggdPbwAmFWq5LbhqQQJJBYr0g5Xd_KpY,73222
-beekeeper/monitors/watsonx/instrumentation.py,sha256=ztgR1kZ9h-JvASzRA47AYHdc-Isv33EQum9XBLg-dQk,525
-beekeeper_monitors_watsonx-1.0.5.post1.dist-info/METADATA,sha256=EirQIiLXaz2J4TpuS8DHMxT5mYqwBUUMN0XckdQh_io,722
-beekeeper_monitors_watsonx-1.0.5.post1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-beekeeper_monitors_watsonx-1.0.5.post1.dist-info/RECORD,,