datarobot-moderations 11.1.13__py3-none-any.whl → 11.1.15__py3-none-any.whl

datarobot_dome/async_http_client.py

@@ -230,7 +230,7 @@ class AsyncHTTPClient:
             response = await self.session.post(url, json=payload, headers=self.json_headers)
             if response.status != HTTPStatus.ACCEPTED:
                 raise Exception(
-                    f"Error uploading custom metrics: Status Code: {response.status_code}"
+                    f"Error uploading custom metrics: Status Code: {response.status}"
                     f"Message: {response.text}"
                 )
             self._logger.info("Successfully uploaded custom metrics")

datarobot_dome/constants.py

@@ -10,7 +10,6 @@
 #  https://www.datarobot.com/wp-content/uploads/2021/07/DataRobot-Tool-and-Utility-Agreement.pdf.
 #  ---------------------------------------------------------------------------------
 from enum import Enum
-from typing import Self
 
 __GUARD_ASSOCIATION_IDS_COLUMN_NAME__ = "datarobot_guard_association_id"
 
@@ -70,6 +69,8 @@ LLM_CONTEXT_COLUMN_NAME = "_LLM_CONTEXT"
 PROMPT_TOKEN_COUNT_COLUMN_NAME_FROM_USAGE = "prompt_token_count_from_usage"
 RESPONSE_TOKEN_COUNT_COLUMN_NAME_FROM_USAGE = "response_token_count_from_usage"
 
+SPAN_PREFIX = "datarobot.guard"
+
 
 class TargetType(str, Enum):
     """Target types that may be handed to moderations from DRUM -- casing must align."""
@@ -86,11 +87,11 @@ class TargetType(str, Enum):
     AGENTIC_WORKFLOW = "agenticworkflow"
 
     @staticmethod
-    def guards() -> list[Self]:
+    def guards():
         return [TargetType.TEXT_GENERATION, TargetType.AGENTIC_WORKFLOW]
 
     @staticmethod
-    def vdb() -> list[Self]:
+    def vdb():
         return [TargetType.VECTOR_DATABASE]
 
 

datarobot_dome/drum_integration.py

@@ -26,6 +26,7 @@ from openai.types.chat import ChatCompletionChunk
 from openai.types.chat.chat_completion import ChatCompletion
 from openai.types.chat.chat_completion import Choice
 from openai.types.chat.chat_completion_message import ChatCompletionMessage
+from opentelemetry import trace
 
 from datarobot_dome.chat_helper import add_citations_to_df
 from datarobot_dome.chat_helper import add_token_count_columns_to_df
@@ -57,6 +58,9 @@ from datarobot_dome.pipeline.vdb_pipeline import VDBPipeline
 from datarobot_dome.streaming import ModerationIterator
 from datarobot_dome.streaming import StreamingContextBuilder
 
+tracer = trace.get_tracer(__name__)
+
+
 _logger = logging.getLogger("drum_integration")
 
 
@@ -504,11 +508,11 @@ def build_predictions_df_from_completion(data, pipeline, chat_completion):
             predictions_df = add_token_count_columns_to_df(
                 pipeline, predictions_df, usage=chat_completion.usage
             )
-        if pipeline.agentic_metrics_configured():
-            pipeline_interactions = getattr(
-                chat_completion, AGENTIC_PIPELINE_INTERACTIONS_ATTR, None
-            )
+        pipeline_interactions = getattr(chat_completion, AGENTIC_PIPELINE_INTERACTIONS_ATTR, None)
+        if pipeline_interactions:
             predictions_df[AGENTIC_PIPELINE_INTERACTIONS_ATTR] = pipeline_interactions
+        else:
+            predictions_df[AGENTIC_PIPELINE_INTERACTIONS_ATTR] = [None] * len(predictions_df)
 
         source_object = chat_completion
     elif isinstance(chat_completion, Iterable):
@@ -549,10 +553,9 @@ def build_predictions_df_from_completion(data, pipeline, chat_completion):
             USAGE_ATTR,
         ]
     }
-    if pipeline.agentic_metrics_configured():
-        extra_attributes[AGENTIC_PIPELINE_INTERACTIONS_ATTR] = getattr(
-            source_object, AGENTIC_PIPELINE_INTERACTIONS_ATTR, None
-        )
+    extra_attributes[AGENTIC_PIPELINE_INTERACTIONS_ATTR] = getattr(
+        source_object, AGENTIC_PIPELINE_INTERACTIONS_ATTR, None
+    )
     return predictions_df, extra_attributes
 
 
@@ -662,6 +665,37 @@ def _is_llm_requesting_user_tool_call(completion):
     return False, completion
 
 
+def __get_otel_values(guards_list, stage, result_df):
+    guard_values = {}
+    for guard in guards_list:
+        if not guard.has_average_score_custom_metric():
+            continue
+        guard_metric_column_name = guard.get_metric_column_name(stage)
+        if guard_metric_column_name not in result_df.columns:
+            _logger.warning(f"Missing column: {guard_metric_column_name} in result_df")
+            continue
+        guard_values[guard.get_span_column_name(stage)] = result_df[
+            guard_metric_column_name
+        ].tolist()[0]
+    return guard_values
+
+
+def report_otel_evaluation_set_metric(pipeline, result_df):
+    current_span = trace.get_current_span()
+    if not current_span:
+        _logger.warning("No currently active span found to report evaluation set metric")
+        return
+
+    prompt_values = __get_otel_values(pipeline.get_prescore_guards(), GuardStage.PROMPT, result_df)
+    response_values = __get_otel_values(
+        pipeline.get_postscore_guards(), GuardStage.RESPONSE, result_df
+    )
+
+    final_value = {"prompt_guards": prompt_values, "response_guards": response_values}
+
+    current_span.set_attribute("datarobot.moderation.evaluation", json.dumps(final_value))
+
+
 def guard_chat_wrapper(
     completion_create_params, model, pipeline, drum_chat_fn, association_id=None, **kwargs
 ):
@@ -724,6 +758,7 @@ def guard_chat_wrapper(
             completion = _set_moderation_attribute_to_completion(
                 pipeline, chat_completion, result_df, association_id=association_id
             )
+            report_otel_evaluation_set_metric(pipeline, result_df)
             return completion
 
     replaced_prompt_column_name = f"replaced_{prompt_column_name}"
@@ -803,6 +838,7 @@ def guard_chat_wrapper(
     ) / result_df.shape[0]
 
     response_message, finish_reason = get_response_message_and_finish_reason(pipeline, postscore_df)
+    report_otel_evaluation_set_metric(pipeline, result_df)
 
     final_completion = build_non_streaming_chat_completion(
         response_message, finish_reason, extra_attributes

datarobot_dome/guard.py

@@ -35,6 +35,7 @@ from datarobot_dome.constants import FAITHFULLNESS_COLUMN_NAME
 from datarobot_dome.constants import NEMO_GUARD_COLUMN_NAME
 from datarobot_dome.constants import NEMO_GUARDRAILS_DIR
 from datarobot_dome.constants import ROUGE_1_COLUMN_NAME
+from datarobot_dome.constants import SPAN_PREFIX
 from datarobot_dome.constants import TASK_ADHERENCE_SCORE_COLUMN_NAME
 from datarobot_dome.constants import TOKEN_COUNT_COLUMN_NAME
 from datarobot_dome.constants import AwsModel
@@ -366,6 +367,21 @@ class Guard(ABC):
     def get_comparand(self):
         return self.intervention.threshold
 
+    def get_enforced_span_attribute_name(self, stage):
+        intervention_action = self.get_intervention_action()
+        if intervention_action in [GuardAction.BLOCK, GuardAction.REPORT]:
+            return f"{SPAN_PREFIX}.{stage.lower()}.{intervention_action}ed"
+        elif intervention_action == GuardAction.REPLACE:
+            return f"{SPAN_PREFIX}.{stage.lower()}.replaced"
+        else:
+            raise NotImplementedError
+
+    def get_span_column_name(self, _):
+        raise NotImplementedError
+
+    def get_span_attribute_name(self, _):
+        raise NotImplementedError
+
 
 class GuardModelInfo:
     def __init__(self, model_config: dict):
@@ -434,6 +450,15 @@ class ModelGuard(Guard):
             raise NotImplementedError("Missing model_info for model guard")
         return self.get_stage_str(stage) + "_" + self._model_info.target_name
 
+    def get_span_column_name(self, _):
+        if self.model_info is None:
+            raise NotImplementedError("Missing model_info for model guard")
+        # Typically 0th index is the target name
+        return self._model_info.target_name.split("_")[0]
+
+    def get_span_attribute_name(self, stage):
+        return f"{SPAN_PREFIX}.{stage.lower()}.{self.get_span_column_name(stage)}"
+
     def has_average_score_custom_metric(self) -> bool:
         """A couple ModelGuard types do not have an average score metric"""
         return self.model_info.target_type not in [
@@ -566,6 +591,19 @@ class OOTBGuard(Guard):
         else:
             raise NotImplementedError(f"No metric column name defined for {self._ootb_type} guard")
 
+    def get_span_column_name(self, _):
+        if self._ootb_type == OOTBType.TOKEN_COUNT:
+            return TOKEN_COUNT_COLUMN_NAME
+        elif self._ootb_type == OOTBType.ROUGE_1:
+            return ROUGE_1_COLUMN_NAME
+        elif self._ootb_type == OOTBType.CUSTOM_METRIC:
+            return self.name
+        else:
+            raise NotImplementedError(f"No span attribute name defined for {self._ootb_type} guard")
+
+    def get_span_attribute_name(self, stage):
+        return f"{SPAN_PREFIX}.{stage.lower()}.{self.get_span_column_name(stage)}"
+
 
 class OOTBCostMetric(OOTBGuard):
     def __init__(self, config, stage):
@@ -603,6 +641,12 @@ class OOTBCostMetric(OOTBGuard):
             ),
         }
 
+    def get_span_column_name(self, _):
+        return f"{COST_COLUMN_NAME}.{self.currency.lower()}"
+
+    def get_span_attribute_name(self, _):
+        return f"{SPAN_PREFIX}.{self._stage.lower()}.{self.get_span_column_name(_)}"
+
 
 class FaithfulnessGuard(OOTBGuard, GuardLLMMixin):
     def __init__(self, config: dict, stage=None):
@@ -624,6 +668,12 @@ class FaithfulnessGuard(OOTBGuard, GuardLLMMixin):
     def faithfulness_evaluator(self):
         return self._evaluator
 
+    def get_span_column_name(self, _):
+        return FAITHFULLNESS_COLUMN_NAME
+
+    def get_span_attribute_name(self, _):
+        return f"{SPAN_PREFIX}.{self._stage.lower()}.{self.get_span_column_name(_)}"
+
 
 class AgentGoalAccuracyGuard(OOTBGuard, GuardLLMMixin):
     def __init__(self, config: dict, stage=None):
@@ -645,6 +695,12 @@ class AgentGoalAccuracyGuard(OOTBGuard, GuardLLMMixin):
     def accuracy_scorer(self):
         return self.scorer
 
+    def get_span_column_name(self, _):
+        return AGENT_GOAL_ACCURACY_COLUMN_NAME
+
+    def get_span_attribute_name(self, _):
+        return f"{SPAN_PREFIX}.{self._stage.lower()}.{self.get_span_column_name(_)}"
+
 
 class TaskAdherenceGuard(OOTBGuard, GuardLLMMixin):
     def __init__(self, config: dict, stage=None):
@@ -666,6 +722,12 @@ class TaskAdherenceGuard(OOTBGuard, GuardLLMMixin):
     def task_adherence_scorer(self):
         return self.scorer
 
+    def get_span_column_name(self, _):
+        return TASK_ADHERENCE_SCORE_COLUMN_NAME
+
+    def get_span_attribute_name(self, _):
+        return f"{SPAN_PREFIX}.{self._stage.lower()}.{self.get_span_column_name(_)}"
+
 
 class GuardFactory:
     @classmethod

datarobot_dome/guard_executor.py

@@ -19,6 +19,7 @@ import traceback
 import nest_asyncio
 import pandas as pd
 import requests.exceptions
+from opentelemetry import trace
 
 from datarobot_dome.constants import AGENTIC_PIPELINE_INTERACTIONS_ATTR
 from datarobot_dome.constants import LOGGER_NAME_PREFIX
@@ -33,7 +34,6 @@ from datarobot_dome.constants import ModerationEventTypes
 from datarobot_dome.constants import OOTBType
 from datarobot_dome.guard import AgentGoalAccuracyGuard
 from datarobot_dome.guard import FaithfulnessGuard
-from datarobot_dome.guard import Guard
 from datarobot_dome.guard import ModelGuard
 from datarobot_dome.guard import NeMoGuard
 from datarobot_dome.guard import OOTBCostMetric
@@ -49,6 +49,8 @@ from datarobot_dome.guard_helpers import get_token_count
 from datarobot_dome.guard_helpers import nemo_response_stage_input_formatter
 from datarobot_dome.guard_helpers import nemo_response_stage_output_formatter
 
+tracer = trace.get_tracer(__name__)
+
 
 def get_operator_comparator(comparator):  # noqa: PLR0911
     if comparator == GuardOperatorType.GREATER_THAN:
@@ -96,13 +98,39 @@ class AsyncGuardExecutor:
 
     async def run_guard(self, guard, copy_df, stage):
         start_time = time.time()
-        executor = getattr(self, self.guard_executor_map[guard.type])
-        df = await executor(guard, copy_df, stage)
-        end_time = time.time()
-
-        latency = end_time - start_time
-        if guard.has_latency_custom_metric():
-            self.pipeline.report_guard_latency(guard, latency)
+        with tracer.start_as_current_span(f"DataRobot Guard: {guard.name}") as span:
+            span.set_attribute("datarobot.moderation.guard.name", guard.name)
+            span.set_attribute("datarobot.moderation.guard.type", guard.type)
+            span.set_attribute("datarobot.moderation.guard.description", guard.description)
+            span.set_attribute("datarobot.moderation.guard.stage", stage)
+
+            executor = getattr(self, self.guard_executor_map[guard.type])
+            df = await executor(guard, copy_df, stage)
+            end_time = time.time()
+
+            latency = end_time - start_time
+            span.set_attribute("datarobot.moderation.guard.latency", latency)
+            if guard.has_latency_custom_metric():
+                self.pipeline.report_guard_latency(guard, latency)
+            if guard.has_average_score_custom_metric():
+                metric_column_name = guard.get_metric_column_name(stage)
+                if metric_column_name in df.columns:
+                    span.set_attribute(
+                        guard.get_span_attribute_name(stage),
+                        df[metric_column_name].tolist()[0],
+                    )
+            if guard.get_intervention_action():
+                (
+                    enforced_column_name,
+                    _,
+                    _,
+                ) = self._get_enforced_and_action_column_names(
+                    guard.get_intervention_action(), self.pipeline.get_input_column(stage)
+                )
+                span.set_attribute(
+                    guard.get_enforced_span_attribute_name(stage),
+                    df[enforced_column_name].tolist()[0],
+                )
 
         return df, latency
 
@@ -194,7 +222,7 @@ class AsyncGuardExecutor:
             # and "Response_toxicity_toxic_PREDICTION", if toxicity is configured for both
             # prompts and responses
             copy_df.rename(
-                columns={metric_column: Guard.get_stage_str(stage) + "_" + metric_column},
+                columns={metric_column: guard.get_metric_column_name(stage)},
                 inplace=True,
             )
         except Exception as ex:

datarobot_dome/guard_helpers.py

@@ -400,7 +400,7 @@ def calculate_agent_goal_accuracy(
     interactions: str,
     response: str,
 ):
-    if interactions is None:
+    if interactions is None or interactions == "":
         # If interactions are missing - we use prompt and response to gauge the
         # goal accuracy
         sample = MultiTurnSample(

{datarobot_moderations-11.1.13.dist-info → datarobot_moderations-11.1.15.dist-info}/METADATA

@@ -1,13 +1,15 @@
 Metadata-Version: 2.3
 Name: datarobot-moderations
-Version: 11.1.13
+Version: 11.1.15
 Summary: DataRobot Monitoring and Moderation framework
 License: DataRobot Tool and Utility Agreement
 Author: DataRobot
 Author-email: support@datarobot.com
-Requires-Python: >=3.11.5,<3.13
+Requires-Python: >=3.10,<3.13
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: aiohttp (>=3.9.5)
 Requires-Dist: asyncio (>=3.4.3)
@@ -28,6 +30,8 @@ Requires-Dist: nemoguardrails (>=0.9.0)
 Requires-Dist: nest-asyncio (>=1.6.0)
 Requires-Dist: numpy (>=1.25.0)
 Requires-Dist: openai (>=1.14.3)
+Requires-Dist: opentelemetry-api (>=1.16.0)
+Requires-Dist: opentelemetry-sdk (>=1.16.0)
 Requires-Dist: pandas (>=2.0.3)
 Requires-Dist: ragas (>=0.2.15)
 Requires-Dist: rouge-score (>=0.1.2)

{datarobot_moderations-11.1.13.dist-info → datarobot_moderations-11.1.15.dist-info}/RECORD

@@ -1,11 +1,11 @@
 datarobot_dome/__init__.py,sha256=B5Rx8_CNCNsOpxBbRj27XOXCfRZmvmrAR-NzlzIKnDw,583
-datarobot_dome/async_http_client.py,sha256=iJV6e0HZDyvIZjGkZmJEQx1NkbYRu-szNn-BixniXww,9654
+datarobot_dome/async_http_client.py,sha256=wkB4irwvnchNGzO1bk2C_HWM-GOSB3AUn5TXKl-X0ZI,9649
 datarobot_dome/chat_helper.py,sha256=BzvtUyZSZxzOqq-5a2wQKhHhr2kMlcP1MFrHaDAeD_o,9671
-datarobot_dome/constants.py,sha256=fYBgkAQBRnwXyJIO1BBfb0Fe12Sg74gtOQ4WpQQwBXc,9059
-datarobot_dome/drum_integration.py,sha256=LzcoRNWofLLCFktJ1tY7IZ3C0adMrlGM1WVqCOfuthM,40691
-datarobot_dome/guard.py,sha256=afcJSSo509aHHvM6nm-QTKzQjuWE7VzgpihenDaAf3w,29921
-datarobot_dome/guard_executor.py,sha256=CMa2IIP6Uhu2lN1DDvWhVky40BnE37AdKJkifE4vVNU,34063
-datarobot_dome/guard_helpers.py,sha256=VkNaoMAWAEggodpl7KmWZTM6H9H6e9Ny3Rl2HBXZnfM,16353
+datarobot_dome/constants.py,sha256=mnSa8rUAha4XlsS2lwPmFCkH2RzfSL_MMkErsWHqIbA,9040
+datarobot_dome/drum_integration.py,sha256=nULpLYVMiS5vihfNUyuq-nvZpgXrQibQbVu2UMAscu8,42102
+datarobot_dome/guard.py,sha256=7T0a1gsWqVmVvEf4SLkVBi8lIRYl8PeMB7TnQGszWtc,32371
+datarobot_dome/guard_executor.py,sha256=AOI8MZeZETHMoFgBePe0wa2vE9d2975MYQnEDHLZL7s,35462
+datarobot_dome/guard_helpers.py,sha256=YHhSUSuvxAgDdWPXiwYiHtrl-6ZlObE9n6CjYPQNSuA,16375
 datarobot_dome/guards/__init__.py,sha256=B5Rx8_CNCNsOpxBbRj27XOXCfRZmvmrAR-NzlzIKnDw,583
 datarobot_dome/guards/guard_llm_mixin.py,sha256=ON-zuVL3xhQmXv0rFkalWrW_Q67Wwya2IQerHO8WkKU,10694
 datarobot_dome/llm.py,sha256=L02OvTrflmD34-FrfXebfF-zzKTeuin7fpne1Cl5psg,5719
@@ -18,6 +18,6 @@ datarobot_dome/pipeline/llm_pipeline.py,sha256=fOp_OJnQMDUJH-LKv12kEqli-EqfHjAiS
 datarobot_dome/pipeline/pipeline.py,sha256=_pZ_4K2LMnfYCYj_ur9EwJzo3T-pbO6lFYz1O-_3uQ4,16491
 datarobot_dome/pipeline/vdb_pipeline.py,sha256=WTOGn1qe_ZvEcdlvHgeXxl2xTqp7GjfL13c6S-FmAfM,5146
 datarobot_dome/streaming.py,sha256=6nYvh6SoxPRLfO6GGdEoHsQuyLP9oX1lDMe8IeGo4lw,17801
-datarobot_moderations-11.1.13.dist-info/METADATA,sha256=LsXqaQbvi15TPh7WdO4QmDP0b3xzcCwG_ucnI3E5B50,4639
-datarobot_moderations-11.1.13.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-datarobot_moderations-11.1.13.dist-info/RECORD,,
+datarobot_moderations-11.1.15.dist-info/METADATA,sha256=zHt26VnmHpn-0cL-egKPqdcTvKPTittBNtVHLVylbHo,4827
+datarobot_moderations-11.1.15.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+datarobot_moderations-11.1.15.dist-info/RECORD,,