beekeeper-monitors-watsonx 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

beekeeper/monitors/watsonx/base.py

@@ -202,6 +202,40 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
         return created_detached_pta.to_dict()["asset_id"]
 
+    def _delete_detached_prompt(self, detached_pta_id: str) -> None:
+        from ibm_aigov_facts_client import (  # type: ignore
+            AIGovFactsClient,
+            CloudPakforDataConfig,
+        )
+
+        try:
+            if hasattr(self, "_fact_cpd_creds") and self._fact_cpd_creds:
+                cpd_creds = CloudPakforDataConfig(**self._fact_cpd_creds)
+
+                aigov_client = AIGovFactsClient(
+                    container_id=self._container_id,
+                    container_type=self._container_type,
+                    cloud_pak_for_data_configs=cpd_creds,
+                    disable_tracing=True,
+                )
+
+            else:
+                aigov_client = AIGovFactsClient(
+                    api_key=self._api_key,
+                    container_id=self._container_id,
+                    container_type=self._container_type,
+                    disable_tracing=True,
+                    region=self.region.factsheet,
+                )
+
+        except Exception as e:
+            logging.error(
+                f"Error connecting to IBM watsonx.governance (factsheets): {e}",
+            )
+            raise
+
+        suppress_output(aigov_client.assets.delete_prompt_asset, detached_pta_id)
+
     def _create_deployment_pta(self, asset_id: str, name: str, model_id: str) -> str:
         from ibm_watsonx_ai import APIClient, Credentials  # type: ignore
 
@@ -239,6 +273,30 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
         return wml_client.deployments.get_uid(created_deployment)
 
+    def _delete_deployment_pta(self, deployment_id: str):
+        from ibm_watsonx_ai import APIClient, Credentials  # type: ignore
+
+        try:
+            if hasattr(self, "_wml_cpd_creds") and self._wml_cpd_creds:
+                creds = Credentials(**self._wml_cpd_creds)
+
+                wml_client = APIClient(creds)
+                wml_client.set.default_space(self.space_id)
+
+            else:
+                creds = Credentials(
+                    url=self.region.watsonxai,
+                    api_key=self._api_key,
+                )
+                wml_client = APIClient(creds)
+                wml_client.set.default_space(self.space_id)
+
+        except Exception as e:
+            logging.error(f"Error connecting to IBM watsonx.ai Runtime: {e}")
+            raise
+
+        suppress_output(wml_client.deployments.delete, deployment_id)
+
     @deprecated(
         reason="'add_prompt_observer()' is deprecated and will be removed in a future version. Use 'create_prompt_monitor()' instead.",
         version="1.0.5",
@@ -381,6 +439,8 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
             ```
         """
         task_id = TaskType.from_value(task_id).value
+        rollback_stack = []
+
         # DEPRECATION NOTICE
         if input_text is not None:
             warnings.warn(
@@ -493,11 +553,14 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
             prompt_details,
             detached_asset_details,
         )
+        rollback_stack.append(lambda: self._delete_detached_prompt(detached_pta_id))
+
         deployment_id = None
         if self._container_type == "space":
             deployment_id = suppress_output(
                 self._create_deployment_pta, detached_pta_id, name, model_id
             )
+            rollback_stack.append(lambda: self._delete_deployment_pta(deployment_id))
 
         monitors = {
             "generative_ai_quality": {
@@ -558,10 +621,18 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
         generative_ai_monitor_details = generative_ai_monitor_details.result._to_dict()
 
+        wos_status = generative_ai_monitor_details.get("status", {})
+        if wos_status.get("state") == "ERROR":
+            for rollback_step in reversed(rollback_stack):
+                rollback_step()
+            raise Exception(wos_status.get("failure"))
+
         return {
             "detached_prompt_template_asset_id": detached_pta_id,
             "deployment_id": deployment_id,
-            "subscription_id": generative_ai_monitor_details["subscription_id"],
+            "subscription_id": generative_ai_monitor_details.get(
+                "subscription_id", None
+            ),
         }
 
     def store_payload_records(
@@ -938,6 +1009,40 @@ class WatsonxPromptMonitor(PromptMonitor):
 
         return created_pta.to_dict()["asset_id"]
 
+    def _delete_prompt(self, pta_id: str) -> None:
+        from ibm_aigov_facts_client import (  # type: ignore
+            AIGovFactsClient,
+            CloudPakforDataConfig,
+        )
+
+        try:
+            if hasattr(self, "_fact_cpd_creds") and self._fact_cpd_creds:
+                cpd_creds = CloudPakforDataConfig(**self._fact_cpd_creds)
+
+                aigov_client = AIGovFactsClient(
+                    container_id=self._container_id,
+                    container_type=self._container_type,
+                    cloud_pak_for_data_configs=cpd_creds,
+                    disable_tracing=True,
+                )
+
+            else:
+                aigov_client = AIGovFactsClient(
+                    api_key=self._api_key,
+                    container_id=self._container_id,
+                    container_type=self._container_type,
+                    disable_tracing=True,
+                    region=self.region.factsheet,
+                )
+
+        except Exception as e:
+            logging.error(
+                f"Error connecting to IBM watsonx.governance (factsheets): {e}",
+            )
+            raise
+
+        suppress_output(aigov_client.assets.delete_prompt_asset, pta_id)
+
     def _create_deployment_pta(self, asset_id: str, name: str, model_id: str) -> str:
         from ibm_watsonx_ai import APIClient, Credentials  # type: ignore
 
@@ -976,6 +1081,30 @@ class WatsonxPromptMonitor(PromptMonitor):
 
         return wml_client.deployments.get_uid(created_deployment)
 
+    def _delete_deployment_pta(self, deployment_id: str):
+        from ibm_watsonx_ai import APIClient, Credentials  # type: ignore
+
+        try:
+            if hasattr(self, "_wml_cpd_creds") and self._wml_cpd_creds:
+                creds = Credentials(**self._wml_cpd_creds)
+
+                wml_client = APIClient(creds)
+                wml_client.set.default_space(self.space_id)
+
+            else:
+                creds = Credentials(
+                    url=self.region.watsonxai,
+                    api_key=self._api_key,
+                )
+                wml_client = APIClient(creds)
+                wml_client.set.default_space(self.space_id)
+
+        except Exception as e:
+            logging.error(f"Error connecting to IBM watsonx.ai Runtime: {e}")
+            raise
+
+        suppress_output(wml_client.deployments.delete, deployment_id)
+
     @deprecated(
         reason="'add_prompt_observer()' is deprecated and will be removed in a future version. Use 'create_prompt_monitor()' instead.",
         version="1.0.5",
@@ -1085,6 +1214,8 @@ class WatsonxPromptMonitor(PromptMonitor):
             ```
         """
         task_id = TaskType.from_value(task_id).value
+        rollback_stack = []
+
         # DEPRECATION NOTICE
         if input_text is not None:
             warnings.warn(
@@ -1178,11 +1309,14 @@ class WatsonxPromptMonitor(PromptMonitor):
         pta_id = suppress_output(
             self._create_prompt_template, prompt_details, asset_details
         )
+        rollback_stack.append(lambda: self._delete_detached_prompt(pta_id))
+
         deployment_id = None
         if self._container_type == "space":
             deployment_id = suppress_output(
                 self._create_deployment_pta, pta_id, name, model_id
             )
+            rollback_stack.append(lambda: self._delete_deployment_pta(deployment_id))
 
         monitors = {
             "generative_ai_quality": {
@@ -1243,10 +1377,18 @@ class WatsonxPromptMonitor(PromptMonitor):
 
         generative_ai_monitor_details = generative_ai_monitor_details._to_dict()
 
+        wos_status = generative_ai_monitor_details.get("status", {})
+        if wos_status.get("state") == "ERROR":
+            for rollback_step in reversed(rollback_stack):
+                rollback_step()
+            raise Exception(wos_status.get("failure"))
+
         return {
             "prompt_template_asset_id": pta_id,
             "deployment_id": deployment_id,
-            "subscription_id": generative_ai_monitor_details["subscription_id"],
+            "subscription_id": generative_ai_monitor_details.get(
+                "subscription_id", None
+            ),
         }
 
     def store_payload_records(

beekeeper/monitors/watsonx/custom_metric.py

@@ -7,7 +7,7 @@ from beekeeper.monitors.watsonx.supporting_classes.credentials import (
     CloudPakforDataCredentials,
     IntegratedSystemCredentials,
 )
-from beekeeper.monitors.watsonx.supporting_classes.enums import Region
+from beekeeper.monitors.watsonx.supporting_classes.enums import DataSetType, Region
 from beekeeper.monitors.watsonx.supporting_classes.metric import (
     WatsonxLocalMetric,
     WatsonxMetric,
@@ -531,6 +531,49 @@ class WatsonxCustomMetricsManager:
             json_patch_operation=patch_payload,
         ).result
 
+    def store_record_metric_data(
+        self,
+        custom_data_set_id: str,
+        computed_on: Union[DataSetType, str],
+        run_id: str,
+        request_records: List[Dict],
+    ):
+        """
+        Stores computed metrics data to the specified transaction record.
+
+        Args:
+            custom_data_set_id (str): The ID of the custom metric data set.
+            computed_on (DataSetType): The dataset on which the metric was calculated (e.g., payload or feedback).
+            run_id (str): The ID of the monitor run that generated the metrics.
+            request_records (List[Dict]): A list of dictionaries containing the records to be stored.
+
+        Example:
+            ```python
+            wxgov_client.store_record_metric_data(
+                reference_record_id="0196ad39-1b75-7e77-bddb-cc5393d575c2",
+                run_id="RUN_ID",
+                request_records=[
+                    {
+                        "reference_record_id": "304a9270-44a1-4c4d-bfd4-f756541011f8",
+                        "record_timestamp": "2025-12-09T00:00:00Z",
+                        "context_quality": 0.786,
+                        "pii": 0.05,
+                    }
+                ],
+            )
+            ```
+        """
+        computed_on = DataSetType.from_value(computed_on).value
+
+        for record in request_records:
+            record["run_id"] = run_id
+            record["computed_on"] = computed_on
+
+        return self._wos_client.data_sets.store_records(
+            data_set_id=custom_data_set_id,
+            request_body=request_records,
+        ).result
+
     # ===== Local Custom Metrics =====
     @deprecated(
         reason="'add_local_metric_definition()' is deprecated and will be removed in a future version. Use 'create_local_metric_definition()' from 'beekeeper-monitors-watsonx' instead.",
@@ -549,33 +592,17 @@ class WatsonxCustomMetricsManager:
             subscription_id=subscription_id,
         )
 
+    @deprecated(
+        reason="'create_local_metric_definition()' is deprecated and will be removed in a future version. Use OOB record level metrics instead.",
+        version="1.1.3",
+        action="always",
+    )
     def create_local_metric_definition(
         self,
         name: str,
         metrics: List[WatsonxLocalMetric],
         subscription_id: str,
     ) -> str:
-        """
-        Creates a custom metric definition to compute metrics at the local (transaction) level for IBM watsonx.governance.
-
-        Args:
-            name (str): The name of the custom transaction metric group.
-            metrics (List[WatsonxLocalMetric]): A list of metrics to be monitored at the local (transaction) level.
-            subscription_id (str): The IBM watsonx.governance subscription ID associated with the metric definition.
-
-        Example:
-            ```python
-            from beekeeper.monitors.watsonx import WatsonxLocalMetric
-
-            wxgov_client.create_local_metric_definition(
-                name="Custom LLM Local Metric",
-                subscription_id="019674ca-0c38-745f-8e9b-58546e95174e",
-                metrics=[
-                    WatsonxLocalMetric(name="context_quality", data_type="double")
-                ],
-            )
-            ```
-        """
         from ibm_watson_openscale.base_classes.watson_open_scale_v2 import (
             LocationTableName,
             SparkStruct,
@@ -636,55 +663,30 @@ class WatsonxCustomMetricsManager:
             request_records=request_records,
         )
 
+    @deprecated(
+        reason="'store_local_metric_data()' is deprecated and will be removed in a future version. Use OOB record level metrics instead.",
+        version="1.1.3",
+        action="always",
+    )
     def store_local_metric_data(
         self,
         metric_instance_id: str,
         request_records: List[Dict],
     ):
-        """
-        Stores computed metrics data to the specified transaction record.
-
-        Args:
-            metric_instance_id (str): The unique ID of the custom transaction metric.
-            request_records (List[Dict]): A list of dictionaries containing the records to be stored.
-
-        Example:
-            ```python
-            wxgov_client.store_local_metric_data(
-                metric_instance_id="0196ad39-1b75-7e77-bddb-cc5393d575c2",
-                request_records=[
-                    {
-                        "scoring_id": "304a9270-44a1-4c4d-bfd4-f756541011f8",
-                        "run_id": "RUN_ID",
-                        "computed_on": "payload",
-                        "context_quality": 0.786,
-                    }
-                ],
-            )
-            ```
-        """
         return self._wos_client.data_sets.store_records(
             data_set_id=metric_instance_id,
             request_body=request_records,
         ).result
 
+    @deprecated(
+        reason="'list_local_metrics()' is deprecated and will be removed in a future version. Use OOB record level metrics instead.",
+        version="1.1.3",
+        action="always",
+    )
     def list_local_metrics(
         self,
         metric_instance_id: str,
     ):
-        """
-        Lists records from a custom local metric definition.
-
-        Args:
-            metric_instance_id (str): The unique ID of the custom transaction metric.
-
-        Example:
-            ```python
-            wxgov_client.list_local_metrics(
-                metric_instance_id="0196ad47-c505-73c0-9d7b-91c082b697e3"
-            )
-            ```
-        """
         return self._get_dataset_data(metric_instance_id)
 
 

beekeeper/monitors/watsonx/supporting_classes/enums.py

@@ -72,6 +72,19 @@ class Region(str, Enum):
 
 
 class TaskType(Enum):
+    """
+    Supported IBM watsonx.governance tasks.
+
+    Attributes:
+        QUESTION_ANSWERING (str): "question_answering"
+        SUMMARIZATION (str): "summarization"
+        RETRIEVAL_AUGMENTED_GENERATION (str): "retrieval_augmented_generation"
+        CLASSIFICATION (str): "classification"
+        GENERATION (str): "generation"
+        CODE (str): "code"
+        EXTRACTION (str): "extraction"
+    """
+
     QUESTION_ANSWERING = "question_answering"
     SUMMARIZATION = "summarization"
     RETRIEVAL_AUGMENTED_GENERATION = "retrieval_augmented_generation"
@@ -98,3 +111,35 @@ class TaskType(Enum):
         raise TypeError(
             f"Invalid type for parameter 'task_id'. Expected str or TaskType, but received {type(value).__name__}."
         )
+
+
+class DataSetType(Enum):
+    """
+    Supported IBM watsonx.governance tasks.
+
+    Attributes:
+        PAYLOAD (str): "payload"
+        FEEDBACK (str): "feedback"
+    """
+
+    PAYLOAD = "payload"
+    FEEDBACK = "feedback"
+
+    @classmethod
+    def from_value(cls, value: str) -> "DataSetType":
+        if isinstance(value, cls):
+            return value
+
+        if isinstance(value, str):
+            try:
+                return cls(value.lower())
+            except ValueError:
+                raise ValueError(
+                    "Invalid value. Received: '{}'. Valid values are: {}.".format(
+                        value, [item.value for item in DataSetType]
+                    )
+                )
+
+        raise TypeError(
+            f"Invalid type. Expected str or DataSetType, but received {type(value).__name__}."
+        )

{beekeeper_monitors_watsonx-1.1.1.dist-info → beekeeper_monitors_watsonx-1.1.3.dist-info}/METADATA

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

{beekeeper_monitors_watsonx-1.1.1.dist-info → beekeeper_monitors_watsonx-1.1.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 beekeeper/monitors/watsonx/__init__.py,sha256=iJv6D68IT00ZC40TNSVYtqyFTen9sWoDqUtxvVVJjOE,789
-beekeeper/monitors/watsonx/base.py,sha256=AVgYwk-LgjjZ1RTAkk-8f5_T9pJ-jQoeDm_NX1uaX5I,57089
-beekeeper/monitors/watsonx/custom_metric.py,sha256=XdJ26lb0y_P1nirJE_krpKONuqJjP3sWFApoG-DR6hk,23959
+beekeeper/monitors/watsonx/base.py,sha256=HbMPlPDHr6Z4gaolExleDHSR8YqisNzIC3aR2vC2aH8,62233
+beekeeper/monitors/watsonx/custom_metric.py,sha256=7HSn_jMLRK0y4qFx84sra38cdJk9ps-LEGN7QJceG5k,24105
 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=R86yqE_KNHjrrFwqy1tCA2a6UAXwmIzCNxw1vnsH32w,2865
+beekeeper/monitors/watsonx/supporting_classes/enums.py,sha256=KrVgBjhnUIUglWmx0OgY3sWoeKMHE-4pZ_ozxzB8IQE,4111
 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.1.1.dist-info/METADATA,sha256=5F1R9-ocW3kbbJQfjzFNEuVMiUYiH2B47EeMCEW7yes,716
-beekeeper_monitors_watsonx-1.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-beekeeper_monitors_watsonx-1.1.1.dist-info/RECORD,,
+beekeeper_monitors_watsonx-1.1.3.dist-info/METADATA,sha256=xo8UL2_D8Ecft2N0nC7uZwVs67shn6cC1JHpkHO2HVo,716
+beekeeper_monitors_watsonx-1.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beekeeper_monitors_watsonx-1.1.3.dist-info/RECORD,,