beekeeper-monitors-watsonx 1.1.0.post1__py3-none-any.whl → 1.1.4.post1__py3-none-any.whl

beekeeper/monitors/watsonx/base.py

@@ -2,16 +2,17 @@ import json
 import logging
 import os
 import uuid
-from typing import Dict, List, Literal, Union
+import warnings
+from typing import Dict, List, Union
 
 import certifi
 from beekeeper.core.monitors import PromptMonitor
 from beekeeper.core.monitors.types import PayloadRecord
-from beekeeper.core.prompts.utils import extract_template_vars
+from beekeeper.core.prompts import PromptTemplate
 from beekeeper.monitors.watsonx.supporting_classes.credentials import (
     CloudPakforDataCredentials,
 )
-from beekeeper.monitors.watsonx.supporting_classes.enums import Region
+from beekeeper.monitors.watsonx.supporting_classes.enums import Region, TaskType
 from beekeeper.monitors.watsonx.utils.data_utils import validate_and_filter_dict
 from beekeeper.monitors.watsonx.utils.instrumentation import suppress_output
 from deprecated import deprecated
@@ -73,6 +74,8 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
     Example:
         ```python
+        from beekeeper.monitors.watsonx.supporting_classes.enums import Region
+
         from beekeeper.monitors.watsonx import (
             WatsonxExternalPromptMonitor,
             CloudPakforDataCredentials,
@@ -80,7 +83,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
         # watsonx.governance (IBM Cloud)
         wxgov_client = WatsonxExternalPromptMonitor(
-            api_key="API_KEY", space_id="SPACE_ID"
+            api_key="API_KEY", space_id="SPACE_ID", region=Region.US_SOUTH
         )
 
         # watsonx.governance (CP4D)
@@ -198,6 +201,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
 
@@ -235,6 +272,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",
@@ -244,13 +305,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         self,
         name: str,
         model_id: str,
-        task_id: Literal[
-            "extraction",
-            "generation",
-            "question_answering",
-            "retrieval_augmented_generation",
-            "summarization",
-        ],
+        task_id: Union[TaskType, str],
         detached_model_provider: str,
         description: str = "",
         model_parameters: Dict = None,
@@ -291,13 +346,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         self,
         name: str,
         model_id: str,
-        task_id: Literal[
-            "extraction",
-            "generation",
-            "question_answering",
-            "retrieval_augmented_generation",
-            "summarization",
-        ],
+        task_id: Union[TaskType, str],
         detached_model_provider: str,
         description: str = "",
         model_parameters: Dict = None,
@@ -333,13 +382,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         self,
         name: str,
         model_id: str,
-        task_id: Literal[
-            "extraction",
-            "generation",
-            "question_answering",
-            "retrieval_augmented_generation",
-            "summarization",
-        ],
+        task_id: Union[TaskType, str],
         detached_model_provider: str,
         description: str = "",
         model_parameters: Dict = None,
@@ -347,9 +390,10 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         detached_model_url: str = None,
         detached_prompt_url: str = None,
         detached_prompt_additional_info: Dict = None,
+        prompt_template: Union[PromptTemplate, str] = None,
         prompt_variables: List[str] = None,
         locale: str = "en",
-        input_text: str = None,
+        input_text: str = None,  # DEPRECATED
         context_fields: List[str] = None,
         question_field: str = None,
     ) -> Dict:
@@ -359,7 +403,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         Args:
             name (str): The name of the External Prompt Template Asset.
             model_id (str): The ID of the model associated with the prompt.
-            task_id (str): The task identifier.
+            task_id (TaskType): The task identifier.
             detached_model_provider (str): The external model provider.
             description (str, optional): A description of the External Prompt Template Asset.
             model_parameters (Dict, optional): Model parameters and their respective values.
@@ -367,9 +411,9 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
             detached_model_url (str, optional): The URL of the external model.
             detached_prompt_url (str, optional): The URL of the external prompt.
             detached_prompt_additional_info (Dict, optional): Additional information related to the external prompt.
+            prompt_template (PromptTemplate, optional): The prompt template.
             prompt_variables (List[str], optional): Values for the prompt variables.
             locale (str, optional): Locale code for the input/output language. eg. "en", "pt", "es".
-            input_text (str, optional): The input text for the prompt.
             context_fields (List[str], optional): A list of fields that will provide context to the prompt.
                 Applicable only for "retrieval_augmented_generation" task type.
             question_field (str, optional): The field containing the question to be answered.
@@ -377,20 +421,39 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
         Example:
             ```python
+            from beekeeper.monitors.watsonx.supporting_classes.enums import TaskType
+
             wxgov_client.create_prompt_monitor(
                 name="Detached prompt (model AWS Anthropic)",
                 model_id="anthropic.claude-v2",
-                task_id="retrieval_augmented_generation",
+                task_id=TaskType.RETRIEVAL_AUGMENTED_GENERATION,
                 detached_model_provider="AWS Bedrock",
                 detached_model_name="Anthropic Claude 2.0",
                 detached_model_url="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-claude.html",
-                prompt_variables=["context1", "context2", "input_query"],
-                input_text="Prompt text to be given",
-                context_fields=["context1", "context2"],
+                prompt_template="You are a helpful AI assistant that provides clear and accurate answers. {context}. Question: {input_query}.",
+                prompt_variables=["context", "input_query"],
+                context_fields=["context"],
                 question_field="input_query",
             )
             ```
         """
+        task_id = TaskType.from_value(task_id).value
+        rollback_stack = []
+
+        # DEPRECATION NOTICE
+        if input_text is not None:
+            warnings.warn(
+                "DEPRECATION NOTICE: `input_text` is deprecated and will be removed in a future release. "
+                "Use `prompt_template` instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+            if prompt_template is None:
+                prompt_template = input_text
+        # END DEPRECATION NOTICE
+        prompt_template = PromptTemplate.from_value(prompt_template)
+
         if (not (self.project_id or self.space_id)) or (
             self.project_id and self.space_id
         ):
@@ -399,7 +462,7 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
                 "Both were provided: 'project_id' and 'space_id' cannot be set at the same time."
             )
 
-        if task_id == "retrieval_augmented_generation":
+        if task_id == TaskType.RETRIEVAL_AUGMENTED_GENERATION.value:
             if not context_fields or not question_field:
                 raise ValueError(
                     "For 'retrieval_augmented_generation' task, requires non-empty 'context_fields' and 'question_field'."
@@ -413,7 +476,9 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         prompt_metadata.pop("locale", None)
 
         # Update name of keys to aigov_facts api
-        prompt_metadata["input"] = prompt_metadata.pop("input_text", None)
+        prompt_metadata["input"] = getattr(
+            prompt_metadata.pop("prompt_template", None), "template", None
+        )
         prompt_metadata["model_provider"] = prompt_metadata.pop(
             "detached_model_provider",
             None,
@@ -487,11 +552,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": {
@@ -552,10 +620,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(
@@ -671,8 +747,9 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         """
         Stores records to the feedback logging system.
 
-        Note:
-            Feedback data for external prompt **must include** the model output named `generated_text`.
+        Info:
+            - Feedback data for external prompt **must include** the model output named `generated_text`.
+            - For prompt monitors created using Beekeeper, the label field is `reference_output`.
 
         Args:
             request_records (List[Dict]): A list of records to be logged, where each record is represented as a dictionary.
@@ -777,15 +854,17 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
         return {"status": "success"}
 
     def __call__(self, payload: PayloadRecord) -> None:
-        if self.prompt_template:
-            template_vars = extract_template_vars(
-                self.prompt_template.template, payload.input_text
-            )
-
-        if not template_vars:
-            self.store_payload_records([payload.model_dump()])
-        else:
-            self.store_payload_records([{**payload.model_dump(), **template_vars}])
+        self.store_payload_records(
+            [
+                {
+                    **payload.prompt_variable_values,
+                    **payload.model_dump(
+                        exclude_none=True,
+                        exclude={"system_prompt", "prompt_variable_values"},
+                    ),
+                }
+            ]
+        )
 
 
 class WatsonxPromptMonitor(PromptMonitor):
@@ -808,13 +887,17 @@ class WatsonxPromptMonitor(PromptMonitor):
 
     Example:
         ```python
+        from beekeeper.monitors.watsonx.supporting_classes.enums import Region
+
         from beekeeper.monitors.watsonx import (
             WatsonxPromptMonitor,
             CloudPakforDataCredentials,
         )
 
         # watsonx.governance (IBM Cloud)
-        wxgov_client = WatsonxPromptMonitor(api_key="API_KEY", space_id="SPACE_ID")
+        wxgov_client = WatsonxPromptMonitor(
+            api_key="API_KEY", space_id="SPACE_ID", region=Region.US_SOUTH
+        )
 
         # watsonx.governance (CP4D)
         cpd_creds = CloudPakforDataCredentials(
@@ -927,6 +1010,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
 
@@ -965,6 +1082,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",
@@ -974,13 +1115,7 @@ class WatsonxPromptMonitor(PromptMonitor):
         self,
         name: str,
         model_id: str,
-        task_id: Literal[
-            "extraction",
-            "generation",
-            "question_answering",
-            "retrieval_augmented_generation",
-            "summarization",
-        ],
+        task_id: Union[TaskType, str],
         description: str = "",
         model_parameters: Dict = None,
         prompt_variables: List[str] = None,
@@ -1011,13 +1146,7 @@ class WatsonxPromptMonitor(PromptMonitor):
         self,
         name: str,
         model_id: str,
-        task_id: Literal[
-            "extraction",
-            "generation",
-            "question_answering",
-            "retrieval_augmented_generation",
-            "summarization",
-        ],
+        task_id: Union[TaskType, str],
         description: str = "",
         model_parameters: Dict = None,
         prompt_variables: List[str] = None,
@@ -1043,18 +1172,13 @@ class WatsonxPromptMonitor(PromptMonitor):
         self,
         name: str,
         model_id: str,
-        task_id: Literal[
-            "extraction",
-            "generation",
-            "question_answering",
-            "retrieval_augmented_generation",
-            "summarization",
-        ],
+        task_id: Union[TaskType, str],
         description: str = "",
         model_parameters: Dict = None,
+        prompt_template: Union[PromptTemplate, str] = None,
         prompt_variables: List[str] = None,
         locale: str = "en",
-        input_text: str = None,
+        input_text: str = None,  # DEPRECATED
         context_fields: List[str] = None,
         question_field: str = None,
     ) -> Dict:
@@ -1064,12 +1188,12 @@ class WatsonxPromptMonitor(PromptMonitor):
         Args:
             name (str): The name of the Prompt Template Asset.
             model_id (str): The ID of the model associated with the prompt.
-            task_id (str): The task identifier.
+            task_id (TaskType): The task identifier.
             description (str, optional): A description of the Prompt Template Asset.
             model_parameters (Dict, optional): A dictionary of model parameters and their respective values.
+            prompt_template (PromptTemplate, optional): The prompt template.
             prompt_variables (List[str], optional): A list of values for prompt input variables.
             locale (str, optional): Locale code for the input/output language. eg. "en", "pt", "es".
-            input_text (str, optional): The input text for the prompt.
             context_fields (List[str], optional): A list of fields that will provide context to the prompt.
                 Applicable only for the `retrieval_augmented_generation` task type.
             question_field (str, optional): The field containing the question to be answered.
@@ -1077,17 +1201,36 @@ class WatsonxPromptMonitor(PromptMonitor):
 
         Example:
             ```python
+            from beekeeper.monitors.watsonx.supporting_classes.enums import TaskType
+
             wxgov_client.create_prompt_monitor(
                 name="IBM prompt template",
                 model_id="ibm/granite-3-2b-instruct",
-                task_id="retrieval_augmented_generation",
-                prompt_variables=["context1", "context2", "input_query"],
-                input_text="Prompt text to be given",
-                context_fields=["context1", "context2"],
+                task_id=TaskType.RETRIEVAL_AUGMENTED_GENERATION,
+                prompt_template="You are a helpful AI assistant that provides clear and accurate answers. {context}. Question: {input_query}.",
+                prompt_variables=["context", "input_query"],
+                context_fields=["context"],
                 question_field="input_query",
             )
             ```
         """
+        task_id = TaskType.from_value(task_id).value
+        rollback_stack = []
+
+        # DEPRECATION NOTICE
+        if input_text is not None:
+            warnings.warn(
+                "DEPRECATION NOTICE: `input_text` is deprecated and will be removed in a future release. "
+                "Use `prompt_template` instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+            if prompt_template is None:
+                prompt_template = input_text
+        # END DEPRECATION NOTICE
+        prompt_template = PromptTemplate.from_value(prompt_template)
+
         if (not (self.project_id or self.space_id)) or (
             self.project_id and self.space_id
         ):
@@ -1096,7 +1239,7 @@ class WatsonxPromptMonitor(PromptMonitor):
                 "Both were provided: 'project_id' and 'space_id' cannot be set at the same time."
             )
 
-        if task_id == "retrieval_augmented_generation":
+        if task_id == TaskType.RETRIEVAL_AUGMENTED_GENERATION.value:
             if not context_fields or not question_field:
                 raise ValueError(
                     "For 'retrieval_augmented_generation' task, requires non-empty 'context_fields' and 'question_field'."
@@ -1110,7 +1253,9 @@ class WatsonxPromptMonitor(PromptMonitor):
         prompt_metadata.pop("locale", None)
 
         # Update name of keys to aigov_facts api
-        prompt_metadata["input"] = prompt_metadata.pop("input_text", None)
+        prompt_metadata["input"] = getattr(
+            prompt_metadata.pop("prompt_template", None), "template", None
+        )
 
         # Update list of vars to dict
         prompt_metadata["prompt_variables"] = Dict.fromkeys(
@@ -1165,11 +1310,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": {
@@ -1230,10 +1378,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(
@@ -1350,6 +1506,9 @@ class WatsonxPromptMonitor(PromptMonitor):
         """
         Stores records to the feedback logging system.
 
+        Info:
+            - For prompt monitors created using Beekeeper, the label field is `reference_output`.
+
         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.
@@ -1453,12 +1612,14 @@ class WatsonxPromptMonitor(PromptMonitor):
         return {"status": "success"}
 
     def __call__(self, payload: PayloadRecord) -> None:
-        if self.prompt_template:
-            template_vars = extract_template_vars(
-                self.prompt_template.template, payload.input_text
-            )
-
-        if not template_vars:
-            self.store_payload_records([payload.model_dump()])
-        else:
-            self.store_payload_records([{**payload.model_dump(), **template_vars}])
+        self.store_payload_records(
+            [
+                {
+                    **payload.prompt_variable_values,
+                    **payload.model_dump(
+                        exclude_none=True,
+                        exclude={"system_prompt", "prompt_variable_values"},
+                    ),
+                }
+            ]
+        )

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,
@@ -29,13 +29,17 @@ class WatsonxCustomMetricsManager:
 
     Example:
         ```python
+        from beekeeper.monitors.watsonx.supporting_classes.enums import Region
+
         from beekeeper.monitors.watsonx import (
             WatsonxCustomMetricsManager,
             CloudPakforDataCredentials,
         )
 
         # watsonx.governance (IBM Cloud)
-        wxgov_client = WatsonxCustomMetricsManager(api_key="API_KEY")
+        wxgov_client = WatsonxCustomMetricsManager(
+            api_key="API_KEY", region=Region.US_SOUTH
+        )
 
         # watsonx.governance (CP4D)
         cpd_creds = CloudPakforDataCredentials(
@@ -449,6 +453,12 @@ class WatsonxCustomMetricsManager:
                 existing_instance_id,
             )
 
+        self._wos_client.custom_monitor.create_custom_dataset(
+            data_mart_id=data_mart_id,
+            subscription_id=subscription_id,
+            custom_monitor_id=monitor_definition_id,
+        )
+
         return monitor_instance_details
 
     @deprecated(
@@ -484,7 +494,7 @@ class WatsonxCustomMetricsManager:
 
         Example:
             ```python
-            wxgov_client.put_metrics(
+            wxgov_client.store_metric_data(
                 monitor_instance_id="01966801-f9ee-7248-a706-41de00a8a998",
                 run_id="RUN_ID",
                 request_records={"context_quality": 0.914, "sensitivity": 0.85},
@@ -527,6 +537,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.",
@@ -545,33 +598,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,
@@ -632,55 +669,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

@@ -4,7 +4,7 @@ _REGION_DATA = {
     "us-south": {
         "watsonxai": "https://us-south.ml.cloud.ibm.com",
         "openscale": "https://api.aiopenscale.cloud.ibm.com",
-        "factsheet": None,
+        "factsheet": "us-south",
     },
     "eu-de": {
         "watsonxai": "https://eu-de.ml.cloud.ibm.com",
@@ -49,7 +49,7 @@ class Region(str, Enum):
         return _REGION_DATA[self.value]["factsheet"]
 
     @classmethod
-    def from_value(cls, value):
+    def from_value(cls, value: str) -> "Region":
         if value is None:
             return cls.US_SOUTH
 
@@ -58,7 +58,7 @@ class Region(str, Enum):
 
         if isinstance(value, str):
             try:
-                return cls(value)
+                return cls(value.lower())
             except ValueError:
                 raise ValueError(
                     "Invalid value for parameter 'region'. Received: '{}'. Valid values are: {}.".format(
@@ -69,3 +69,77 @@ class Region(str, Enum):
         raise TypeError(
             f"Invalid type for parameter 'region'. Expected str or Region, but received {type(value).__name__}."
         )
+
+
+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"
+    CLASSIFICATION = "classification"
+    GENERATION = "generation"
+    CODE = "code"
+    EXTRACTION = "extraction"
+
+    @classmethod
+    def from_value(cls, value: str) -> "TaskType":
+        if isinstance(value, cls):
+            return value
+
+        if isinstance(value, str):
+            try:
+                return cls(value.lower())
+            except ValueError:
+                raise ValueError(
+                    "Invalid value for parameter 'task_id'. Received: '{}'. Valid values are: {}.".format(
+                        value, [item.value for item in TaskType]
+                    )
+                )
+
+        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.4.post1.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: beekeeper-monitors-watsonx
+Version: 1.1.4.post1
+Summary: beekeeper monitors watsonx extension
+Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>
+License: Apache-2.0
+Requires-Python: <3.14,>=3.11
+Requires-Dist: beekeeper-core<2.0.0,>=1.0.12
+Requires-Dist: certifi<2026.0.0,>=2025.11.12
+Requires-Dist: ibm-aigov-facts-client<1.0.200,>=1.0.104
+Requires-Dist: ibm-watson-openscale<3.2.0,>=3.1.3
+Requires-Dist: ibm-watsonx-ai<2.0.0,>=1.4.11
+Requires-Dist: ipython==9.8.0
+Provides-Extra: dev
+Requires-Dist: ruff>=0.14.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Beekeeper monitors extension - watsonx
+
+## Installation 
+
+```bash
+pip install beekeeper-monitors-watsonx
+```

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

@@ -1,12 +1,12 @@
 beekeeper/monitors/watsonx/__init__.py,sha256=iJv6D68IT00ZC40TNSVYtqyFTen9sWoDqUtxvVVJjOE,789
-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/base.py,sha256=04vIs4Da7R8DxERXWEg56ojYqq6qJ3XMrh8KHXSQZ0o,62156
+beekeeper/monitors/watsonx/custom_metric.py,sha256=OVeTxDzk09bqagSQybgce76eAb_jcQovKIZHSBjHE1Y,24316
 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/enums.py,sha256=6Xx0maNAVnotxYdALxFaeiagDzxbhKSluxsJHiWMPEg,4117
 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.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,,
+beekeeper_monitors_watsonx-1.1.4.post1.dist-info/METADATA,sha256=_nyLiWQU16XDCNJmWV_MQ-SfNTaXrgy6224LbfFJ37c,724
+beekeeper_monitors_watsonx-1.1.4.post1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beekeeper_monitors_watsonx-1.1.4.post1.dist-info/RECORD,,

beekeeper_monitors_watsonx-1.1.0.post1.dist-info/METADATA

@@ -1,24 +0,0 @@
-Metadata-Version: 2.4
-Name: beekeeper-monitors-watsonx
-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.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
-Requires-Dist: ibm-watsonx-ai<2.0.0,>=1.3.26
-Requires-Dist: ipython==8.37.0
-Provides-Extra: dev
-Requires-Dist: ruff>=0.11.13; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# Beekeeper monitors extension - watsonx
-
-## Installation 
-
-```bash
-pip install beekeeper-monitors-watsonx
-```