truthound-dashboard 1.4.4__py3-none-any.whl → 1.5.0__py3-none-any.whl

truthound_dashboard/schemas/drift_monitor.py

@@ -1,6 +1,12 @@
 """Drift monitoring schemas.
 
 This module defines schemas for automatic drift monitoring operations.
+
+API Design: Direct Response Style
+- Single resources return the resource directly
+- List endpoints return PaginatedResponse with data, total, offset, limit
+- Errors are handled via HTTPException
+- Success is indicated by HTTP status codes (200, 201, 204)
 """
 
 from __future__ import annotations
@@ -10,7 +16,7 @@ from typing import Literal
 
 from pydantic import Field
 
-from .base import BaseSchema, IDMixin, ListResponseWrapper, TimestampMixin
+from .base import BaseSchema, IDMixin, PaginatedResponse, TimestampMixin
 
 # Drift monitoring status
 DriftMonitorStatus = Literal["active", "paused", "error"]
@@ -106,6 +112,14 @@ class DriftMonitorUpdate(BaseSchema):
 class DriftMonitorResponse(DriftMonitorBase, IDMixin, TimestampMixin):
     """Schema for drift monitor response."""
 
+    baseline_source_name: str | None = Field(
+        default=None,
+        description="Baseline source name",
+    )
+    current_source_name: str | None = Field(
+        default=None,
+        description="Current source name",
+    )
     status: DriftMonitorStatus = Field(
         default="active",
         description="Monitor status",
@@ -132,10 +146,10 @@ class DriftMonitorResponse(DriftMonitorBase, IDMixin, TimestampMixin):
     )
 
 
-class DriftMonitorListResponse(ListResponseWrapper):
+class DriftMonitorListResponse(PaginatedResponse[DriftMonitorResponse]):
     """List response for drift monitors."""
 
-    data: list[DriftMonitorResponse]
+    pass
 
 
 # Drift Alert Schemas
@@ -197,10 +211,10 @@ class DriftAlertResponse(DriftAlertBase, IDMixin, TimestampMixin):
     )
 
 
-class DriftAlertListResponse(ListResponseWrapper):
+class DriftAlertListResponse(PaginatedResponse[DriftAlertResponse]):
     """List response for drift alerts."""
 
-    data: list[DriftAlertResponse]
+    pass
 
 
 class DriftAlertUpdate(BaseSchema):
@@ -476,13 +490,6 @@ class RootCauseAnalysis(BaseSchema):
     )
 
 
-class RootCauseAnalysisResponse(BaseSchema):
-    """Response wrapper for root cause analysis."""
-
-    success: bool = Field(default=True)
-    data: RootCauseAnalysis
-
-
 # Drift Preview Schemas
 
 
@@ -617,13 +624,6 @@ class DriftPreviewData(BaseSchema):
     )
 
 
-class DriftPreviewResponse(BaseSchema):
-    """Response for drift preview."""
-
-    success: bool = Field(default=True)
-    data: DriftPreviewData
-
-
 # Large-Scale Dataset Optimization Schemas
 
 
@@ -883,8 +883,52 @@ class SampledComparisonResult(BaseSchema):
     )
 
 
-class SampledComparisonResponse(BaseSchema):
-    """Response for sampled comparison."""
+class MonitorRunResult(BaseSchema):
+    """Result of running a drift monitor."""
+
+    comparison_id: str = Field(..., description="Comparison ID")
+    has_drift: bool = Field(..., description="Whether drift was detected")
+    drift_percentage: float = Field(..., description="Percentage of drifted columns")
+    drifted_columns: list[str] = Field(
+        default_factory=list, description="List of drifted column names"
+    )
+
+
+# Run History Schemas
+
+RunStatus = Literal["running", "completed", "failed"]
+
+
+class DriftMonitorRunResponse(BaseSchema, IDMixin):
+    """Response schema for drift monitor run."""
+
+    monitor_id: str = Field(..., description="Associated monitor ID")
+    status: RunStatus = Field(..., description="Run status")
+    has_drift: bool | None = Field(None, description="Whether drift was detected")
+    max_drift_score: float | None = Field(None, description="Maximum drift score")
+    total_columns: int | None = Field(None, description="Total columns compared")
+    drifted_columns: int | None = Field(None, description="Number of drifted columns")
+    column_results: dict | None = Field(None, description="Per-column results")
+    root_cause_analysis: dict | None = Field(None, description="Root cause analysis")
+    duration_ms: int | None = Field(None, description="Run duration in milliseconds")
+    error_message: str | None = Field(None, description="Error message if failed")
+    created_at: datetime = Field(..., description="When run started")
+    completed_at: datetime | None = Field(None, description="When run completed")
+
+
+class DriftMonitorRunListResponse(PaginatedResponse[DriftMonitorRunResponse]):
+    """List response for drift monitor runs."""
+
+    pass
+
+
+class DriftMonitorRunStatistics(BaseSchema):
+    """Statistics for drift monitor runs."""
 
-    success: bool = Field(default=True)
-    data: SampledComparisonResult
+    total_runs: int = Field(..., description="Total number of runs")
+    completed_runs: int = Field(..., description="Number of completed runs")
+    failed_runs: int = Field(..., description="Number of failed runs")
+    runs_with_drift: int = Field(..., description="Number of runs with drift detected")
+    success_rate: float = Field(..., description="Percentage of successful runs")
+    drift_rate: float = Field(..., description="Percentage of runs with drift")
+    avg_duration_ms: int = Field(..., description="Average run duration in milliseconds")