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

beekeeper/monitors/watsonx/base.py

@@ -2,16 +2,18 @@ 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 import PromptTemplate
 from beekeeper.core.prompts.utils import extract_template_vars
 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 +75,8 @@ class WatsonxExternalPromptMonitor(PromptMonitor):
 
     Example:
         ```python
+        from beekeeper.monitors.watsonx.supporting_classes.enums import Region
+
         from beekeeper.monitors.watsonx import (
             WatsonxExternalPromptMonitor,
             CloudPakforDataCredentials,
@@ -80,7 +84,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)
@@ -244,13 +248,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 +289,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 +325,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 +333,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 +346,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 +354,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 +364,37 @@ 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
+        # 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 +403,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 +417,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,
@@ -671,8 +677,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.
@@ -808,13 +815,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(
@@ -974,13 +985,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 +1016,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 +1042,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 +1058,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 +1071,34 @@ 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
+        # 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 +1107,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 +1121,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(
@@ -1350,6 +1363,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.

beekeeper/monitors/watsonx/custom_metric.py

@@ -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(
@@ -484,7 +488,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},

beekeeper/monitors/watsonx/supporting_classes/enums.py

@@ -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,32 @@ class Region(str, Enum):
         raise TypeError(
             f"Invalid type for parameter 'region'. Expected str or Region, but received {type(value).__name__}."
         )
+
+
+class TaskType(Enum):
+    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__}."
+        )

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

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: beekeeper-monitors-watsonx
-Version: 1.1.0.post1
+Version: 1.1.1
 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: beekeeper-core<2.0.0,>=1.0.6
 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.1.0.post1.dist-info → beekeeper_monitors_watsonx-1.1.1.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=AVgYwk-LgjjZ1RTAkk-8f5_T9pJ-jQoeDm_NX1uaX5I,57089
+beekeeper/monitors/watsonx/custom_metric.py,sha256=XdJ26lb0y_P1nirJE_krpKONuqJjP3sWFApoG-DR6hk,23959
 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=R86yqE_KNHjrrFwqy1tCA2a6UAXwmIzCNxw1vnsH32w,2865
 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.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,,