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

beekeeper/monitors/watsonx/base.py

@@ -576,7 +576,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
                 request_records=[
                     {
                         "context1": "value_context1",
-                        "context2": "value_context1",
+                        "context2": "value_context2",
                         "input_query": "What's Beekeeper Framework?",
                         "generated_text": "Beekeeper is a data framework to make AI easier to work with.",
                         "input_token_count": 25,
@@ -663,6 +663,119 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
         return [data["scoring_id"] + "-1" for data in payload_data]
 
+    def store_feedback_records(
+        self,
+        request_records: List[Dict],
+        subscription_id: str = None,
+    ) -> Dict:
+        """
+        Stores records to the feedback logging system.
+
+        Note:
+            Feedback data for external prompt **must include** the model output named `generated_text`.
+
+        Args:
+            request_records (List[Dict]): A list of records to be logged, where each record is represented as a dictionary.
+            subscription_id (str, optional): The subscription ID associated with the records being logged.
+
+        Example:
+            ```python
+            wxgov_client.store_feedback_records(
+                request_records=[
+                    {
+                        "context1": "value_context1",
+                        "context2": "value_context2",
+                        "input_query": "What's Beekeeper Framework?",
+                        "reference_output": "Beekeeper is a data framework to make AI easier to work with."
+                        "generated_text": "Beekeeper is a data framework to make AI easier to work with.",
+                    }
+                ],
+                subscription_id="5d62977c-a53d-4b6d-bda1-7b79b3b9d1a0",
+            )
+            ```
+        """
+        from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
+        from ibm_watson_openscale import APIClient as WosAPIClient
+        from ibm_watson_openscale.supporting_classes.enums import (
+            DataSetTypes,
+            TargetTypes,
+        )
+
+        # Expected behavior: Prefer using fn `subscription_id`.
+        # Fallback to `self.subscription_id` if `subscription_id` None or empty.
+        _subscription_id = subscription_id or self.subscription_id
+
+        if _subscription_id is None or _subscription_id == "":
+            raise ValueError(
+                "Unexpected value for 'subscription_id': Cannot be None or empty string."
+            )
+
+        if not self._wos_client:
+            try:
+                if hasattr(self, "_wos_cpd_creds") and self._wos_cpd_creds:
+                    from ibm_cloud_sdk_core.authenticators import (
+                        CloudPakForDataAuthenticator,  # type: ignore
+                    )
+
+                    authenticator = CloudPakForDataAuthenticator(**self._wos_cpd_creds)
+                    self._wos_client = WosAPIClient(
+                        authenticator=authenticator,
+                        service_url=self._wos_cpd_creds["url"],
+                    )
+
+                else:
+                    from ibm_cloud_sdk_core.authenticators import (
+                        IAMAuthenticator,  # type: ignore
+                    )
+
+                    authenticator = IAMAuthenticator(apikey=self._api_key)
+                    self._wos_client = WosAPIClient(
+                        authenticator=authenticator,
+                        service_url=self.region.openscale,
+                    )
+
+            except Exception as e:
+                logging.error(
+                    f"Error connecting to IBM watsonx.governance (openscale): {e}",
+                )
+                raise
+
+        subscription_details = self._wos_client.subscriptions.get(
+            _subscription_id,
+        ).result
+        subscription_details = json.loads(str(subscription_details))
+
+        feature_fields = subscription_details["entity"]["asset_properties"][
+            "feature_fields"
+        ]
+
+        # Rename generated_text to _original_prediction (expected by WOS feedback dataset)
+        # Validate required fields for detached/external monitor
+        for i, d in enumerate(request_records):
+            d["_original_prediction"] = d.pop("generated_text", None)
+            request_records[i] = validate_and_filter_dict(
+                d, feature_fields, ["_original_prediction"]
+            )
+
+        feedback_data_set_id = (
+            self._wos_client.data_sets.list(
+                type=DataSetTypes.FEEDBACK,
+                target_target_id=_subscription_id,
+                target_target_type=TargetTypes.SUBSCRIPTION,
+            )
+            .result.data_sets[0]
+            .metadata.id
+        )
+
+        suppress_output(
+            self._wos_client.data_sets.store_records,
+            data_set_id=feedback_data_set_id,
+            request_body=request_records,
+            background_mode=False,
+        )
+
+        return {"status": "success"}
+
     def __call__(self, payload: PayloadRecord) -> None:
         if self.prompt_template:
             template_vars = extract_template_vars(
@@ -1141,7 +1254,7 @@ class WatsonxPromptMonitor(PromptMonitor):
                 request_records=[
                     {
                         "context1": "value_context1",
-                        "context2": "value_context1",
+                        "context2": "value_context2",
                         "input_query": "What's Beekeeper Framework?",
                         "generated_text": "Beekeeper is a data framework to make AI easier to work with.",
                         "input_token_count": 25,
@@ -1229,6 +1342,116 @@ class WatsonxPromptMonitor(PromptMonitor):
 
         return [data["scoring_id"] + "-1" for data in payload_data]
 
+    def store_feedback_records(
+        self,
+        request_records: List[Dict],
+        subscription_id: str = None,
+    ) -> Dict:
+        """
+        Stores records to the feedback logging system.
+
+        Args:
+            request_records (List[Dict]): A list of records to be logged, where each record is represented as a dictionary.
+            subscription_id (str, optional): The subscription ID associated with the records being logged.
+
+        Example:
+            ```python
+            wxgov_client.store_feedback_records(
+                request_records=[
+                    {
+                        "context1": "value_context1",
+                        "context2": "value_context2",
+                        "input_query": "What's Beekeeper Framework?",
+                        "reference_output": "Beekeeper is a data framework to make AI easier to work with."
+                        "generated_text": "Beekeeper is a data framework to make AI easier to work with.",
+                    }
+                ],
+                subscription_id="5d62977c-a53d-4b6d-bda1-7b79b3b9d1a0",
+            )
+            ```
+        """
+        from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
+        from ibm_watson_openscale import APIClient as WosAPIClient
+        from ibm_watson_openscale.supporting_classes.enums import (
+            DataSetTypes,
+            TargetTypes,
+        )
+
+        # Expected behavior: Prefer using fn `subscription_id`.
+        # Fallback to `self.subscription_id` if `subscription_id` None or empty.
+        _subscription_id = subscription_id or self.subscription_id
+
+        if _subscription_id is None or _subscription_id == "":
+            raise ValueError(
+                "Unexpected value for 'subscription_id': Cannot be None or empty string."
+            )
+
+        if not self._wos_client:
+            try:
+                if hasattr(self, "_wos_cpd_creds") and self._wos_cpd_creds:
+                    from ibm_cloud_sdk_core.authenticators import (
+                        CloudPakForDataAuthenticator,  # type: ignore
+                    )
+
+                    authenticator = CloudPakForDataAuthenticator(**self._wos_cpd_creds)
+                    self._wos_client = WosAPIClient(
+                        authenticator=authenticator,
+                        service_url=self._wos_cpd_creds["url"],
+                    )
+
+                else:
+                    from ibm_cloud_sdk_core.authenticators import (
+                        IAMAuthenticator,  # type: ignore
+                    )
+
+                    authenticator = IAMAuthenticator(apikey=self._api_key)
+                    self._wos_client = WosAPIClient(
+                        authenticator=authenticator,
+                        service_url=self.region.openscale,
+                    )
+
+            except Exception as e:
+                logging.error(
+                    f"Error connecting to IBM watsonx.governance (openscale): {e}",
+                )
+                raise
+
+        subscription_details = self._wos_client.subscriptions.get(
+            _subscription_id,
+        ).result
+        subscription_details = json.loads(str(subscription_details))
+
+        feature_fields = subscription_details["entity"]["asset_properties"][
+            "feature_fields"
+        ]
+
+        # Rename generated_text to _original_prediction (expected by WOS feedback dataset)
+        # Validate required fields for detached/external monitor
+        for i, d in enumerate(request_records):
+            d["_original_prediction"] = d.pop("generated_text", None)
+            request_records[i] = validate_and_filter_dict(
+                d, [*feature_fields, "_original_prediction"]
+            )
+
+        feedback_data_set_id = (
+            self._wos_client.data_sets.list(
+                type=DataSetTypes.FEEDBACK,
+                target_target_id=_subscription_id,
+                target_target_type=TargetTypes.SUBSCRIPTION,
+            )
+            .result.data_sets[0]
+            .metadata.id
+        )
+
+        suppress_output(
+            self._wos_client.data_sets.store_records,
+            data_set_id=feedback_data_set_id,
+            request_body=request_records,
+            background_mode=False,
+        )
+
+        return {"status": "success"}
+
     def __call__(self, payload: PayloadRecord) -> None:
         if self.prompt_template:
             template_vars = extract_template_vars(

beekeeper/monitors/watsonx/custom_metric.py

@@ -338,7 +338,7 @@ class WatsonxCustomMetricsManager:
         }
 
     @deprecated(
-        reason="'add_observer_instance()' is deprecated and will be removed in a future version. Use 'attach_monitor_instance()' from 'beekeeper-monitors-watsonx' instead.",
+        reason="'add_observer_instance()' is deprecated and will be removed in a future version. Use 'associate_monitor_instance()' from 'beekeeper-monitors-watsonx' instead.",
         version="1.0.5",
         action="always",
     )
@@ -348,14 +348,14 @@ class WatsonxCustomMetricsManager:
         monitor_definition_id: str,
         subscription_id: str,
     ):
-        return self.attach_monitor_instance(
+        return self.associate_monitor_instance(
             integrated_system_id=integrated_system_id,
             monitor_definition_id=monitor_definition_id,
             subscription_id=subscription_id,
         )
 
     @deprecated(
-        reason="'add_monitor_instance()' is deprecated and will be removed in a future version. Use 'attach_monitor_instance()' from 'beekeeper-monitors-watsonx' instead.",
+        reason="'add_monitor_instance()' is deprecated and will be removed in a future version. Use 'associate_monitor_instance()' from 'beekeeper-monitors-watsonx' instead.",
         version="1.0.6",
         action="always",
     )
@@ -365,20 +365,37 @@ class WatsonxCustomMetricsManager:
         monitor_definition_id: str,
         subscription_id: str,
     ):
-        return self.attach_monitor_instance(
+        return self.associate_monitor_instance(
             integrated_system_id=integrated_system_id,
             monitor_definition_id=monitor_definition_id,
             subscription_id=subscription_id,
         )
 
+    @deprecated(
+        reason="'attach_monitor_instance()' is deprecated and will be removed in a future version. Use 'associate_monitor_instance()' from 'beekeeper-monitors-watsonx' instead.",
+        version="1.1.0",
+        action="always",
+    )
     def attach_monitor_instance(
         self,
         integrated_system_id: str,
         monitor_definition_id: str,
         subscription_id: str,
+    ):
+        return self.associate_monitor_instance(
+            integrated_system_id=integrated_system_id,
+            monitor_definition_id=monitor_definition_id,
+            subscription_id=subscription_id,
+        )
+
+    def associate_monitor_instance(
+        self,
+        integrated_system_id: str,
+        monitor_definition_id: str,
+        subscription_id: str,
     ):
         """
-        Attaches the specified monitor definition to the specified subscription.
+        Associate the specified monitor definition to the specified subscription.
 
         Args:
             integrated_system_id (str): The ID of the integrated system.
@@ -387,7 +404,7 @@ class WatsonxCustomMetricsManager:
 
         Example:
             ```python
-            wxgov_client.attach_monitor_instance(
+            wxgov_client.associate_monitor_instance(
                 integrated_system_id="019667ca-5687-7838-8d29-4ff70c2b36b0",
                 monitor_definition_id="custom_llm_quality",
                 subscription_id="0195e95d-03a4-7000-b954-b607db10fe9e",
@@ -434,14 +451,31 @@ class WatsonxCustomMetricsManager:
 
         return monitor_instance_details
 
+    @deprecated(
+        reason="'publish_metrics()' is deprecated and will be removed in a future version. Use 'store_metric_data()'",
+        version="1.1.0",
+        action="always",
+    )
     def publish_metrics(
         self,
         monitor_instance_id: str,
         run_id: str,
         request_records: Dict[str, Union[float, int]],
+    ):
+        return self.store_metric_data(
+            monitor_instance_id=monitor_instance_id,
+            run_id=run_id,
+            request_records=request_records,
+        )
+
+    def store_metric_data(
+        self,
+        monitor_instance_id: str,
+        run_id: str,
+        request_records: Dict[str, Union[float, int]],
     ):
         """
-        Publishes computed metrics to the specified global monitor instance.
+        Stores computed metrics data to the specified monitor instance.
 
         Args:
             monitor_instance_id (str): The unique ID of the monitor instance.
@@ -450,7 +484,7 @@ class WatsonxCustomMetricsManager:
 
         Example:
             ```python
-            wxgov_client.publish_metrics(
+            wxgov_client.put_metrics(
                 monitor_instance_id="01966801-f9ee-7248-a706-41de00a8a998",
                 run_id="RUN_ID",
                 request_records={"context_quality": 0.914, "sensitivity": 0.85},
@@ -583,13 +617,28 @@ class WatsonxCustomMetricsManager:
             background_mode=False,
         ).result.metadata.id
 
+    @deprecated(
+        reason="'publish_local_metrics()' is deprecated and will be removed in a future version. Use 'store_local_metric_data()'",
+        version="1.1.0",
+        action="always",
+    )
     def publish_local_metrics(
         self,
         metric_instance_id: str,
         request_records: List[Dict],
+    ):
+        return self.store_local_metric_data(
+            metric_instance_id=metric_instance_id,
+            request_records=request_records,
+        )
+
+    def store_local_metric_data(
+        self,
+        metric_instance_id: str,
+        request_records: List[Dict],
     ):
         """
-        Publishes computed metrics to the specified transaction record.
+        Stores computed metrics data to the specified transaction record.
 
         Args:
             metric_instance_id (str): The unique ID of the custom transaction metric.
@@ -597,7 +646,7 @@ class WatsonxCustomMetricsManager:
 
         Example:
             ```python
-            wxgov_client.publish_local_metrics(
+            wxgov_client.store_local_metric_data(
                 metric_instance_id="0196ad39-1b75-7e77-bddb-cc5393d575c2",
                 request_records=[
                     {

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

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: beekeeper-monitors-watsonx
-Version: 1.0.7
+Version: 1.1.0.post1
 Summary: beekeeper monitors watsonx extension
 Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>
 License: Apache-2.0
 Requires-Python: <4.0,>=3.10
-Requires-Dist: beekeeper-core<2.0.0,>=1.0.4
+Requires-Dist: beekeeper-core<2.0.0,>=1.0.5
 Requires-Dist: certifi<2026.0.0,>=2025.4.26
 Requires-Dist: ibm-aigov-facts-client<1.0.97,>=1.0.96
 Requires-Dist: ibm-watson-openscale<3.1.0,>=3.0.49

{beekeeper_monitors_watsonx-1.0.7.dist-info → beekeeper_monitors_watsonx-1.1.0.post1.dist-info}/RECORD

@@ -1,12 +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/base.py,sha256=jtgUGIWKWGQDsdEbeHm4iRmXp2-aErj97IKH0P3_Ayw,55775
+beekeeper/monitors/watsonx/custom_metric.py,sha256=QCkNDNLK_IehZIdXyczDM7RuDdyvCJN2IaTc-xsm-Lk,23827
 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.1.0.post1.dist-info/METADATA,sha256=CeEXAqhnYUi0qbbhx6EfkB3-tlkAbFNLMde-t0Bp6L4,722
+beekeeper_monitors_watsonx-1.1.0.post1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beekeeper_monitors_watsonx-1.1.0.post1.dist-info/RECORD,,