deeprails 1.8.0__tar.gz → 1.10.0__tar.gz

deeprails-1.10.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.10.0"
+}

{deeprails-1.8.0 → deeprails-1.10.0}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.10.0 (2025-10-29)
+
+Full Changelog: [v1.9.0...v1.10.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.9.0...v1.10.0)
+
+### Features
+
+* **api:** remove evaluate api ([a3ddec1](https://github.com/deeprails/deeprails-sdk-python/commit/a3ddec1696eaa1247eea2a3bffd61e63d6537d30))
+* **api:** remove evaluate references ([23519a3](https://github.com/deeprails/deeprails-sdk-python/commit/23519a3349a254fe2fe24a51aeb59545d0820b70))
+
+## 1.9.0 (2025-10-24)
+
+Full Changelog: [v1.8.0...v1.9.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.8.0...v1.9.0)
+
+### Features
+
+* **api:** remove apiresponse from monitor ([4971a99](https://github.com/deeprails/deeprails-sdk-python/commit/4971a99c7357bebbc5e86a2d76d2be55bb34f5ae))
+
 ## 1.8.0 (2025-10-22)
 
 Full Changelog: [v1.7.0...v1.8.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.7.0...v1.8.0)

{deeprails-1.8.0 → deeprails-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.8.0
+Version: 1.10.0
 Summary: The official Python library for the deeprails API
 Project-URL: Homepage, https://docs.deeprails.com/
 Project-URL: Repository, https://github.com/deeprails/deeprails-sdk-python

{deeprails-1.8.0 → deeprails-1.10.0}/api.md

@@ -19,25 +19,12 @@ Methods:
 Types:
 
 ```python
-from deeprails.types import APIResponse, MonitorRetrieveResponse, MonitorSubmitEventResponse
+from deeprails.types import MonitorDetailResponse, MonitorEventResponse, MonitorResponse
 ```
 
 Methods:
 
-- <code title="post /monitor">client.monitor.<a href="./src/deeprails/resources/monitor.py">create</a>(\*\*<a href="src/deeprails/types/monitor_create_params.py">params</a>) -> <a href="./src/deeprails/types/api_response.py">APIResponse</a></code>
-- <code title="get /monitor/{monitor_id}">client.monitor.<a href="./src/deeprails/resources/monitor.py">retrieve</a>(monitor_id, \*\*<a href="src/deeprails/types/monitor_retrieve_params.py">params</a>) -> <a href="./src/deeprails/types/monitor_retrieve_response.py">MonitorRetrieveResponse</a></code>
-- <code title="put /monitor/{monitor_id}">client.monitor.<a href="./src/deeprails/resources/monitor.py">update</a>(monitor_id, \*\*<a href="src/deeprails/types/monitor_update_params.py">params</a>) -> <a href="./src/deeprails/types/api_response.py">APIResponse</a></code>
-- <code title="post /monitor/{monitor_id}/events">client.monitor.<a href="./src/deeprails/resources/monitor.py">submit_event</a>(monitor_id, \*\*<a href="src/deeprails/types/monitor_submit_event_params.py">params</a>) -> <a href="./src/deeprails/types/monitor_submit_event_response.py">MonitorSubmitEventResponse</a></code>
-
-# Evaluate
-
-Types:
-
-```python
-from deeprails.types import Evaluation
-```
-
-Methods:
-
-- <code title="post /evaluate">client.evaluate.<a href="./src/deeprails/resources/evaluate.py">create</a>(\*\*<a href="src/deeprails/types/evaluate_create_params.py">params</a>) -> <a href="./src/deeprails/types/evaluation.py">Evaluation</a></code>
-- <code title="get /evaluate/{eval_id}">client.evaluate.<a href="./src/deeprails/resources/evaluate.py">retrieve</a>(eval_id) -> <a href="./src/deeprails/types/evaluation.py">Evaluation</a></code>
+- <code title="post /monitor">client.monitor.<a href="./src/deeprails/resources/monitor.py">create</a>(\*\*<a href="src/deeprails/types/monitor_create_params.py">params</a>) -> <a href="./src/deeprails/types/monitor_response.py">MonitorResponse</a></code>
+- <code title="get /monitor/{monitor_id}">client.monitor.<a href="./src/deeprails/resources/monitor.py">retrieve</a>(monitor_id, \*\*<a href="src/deeprails/types/monitor_retrieve_params.py">params</a>) -> <a href="./src/deeprails/types/monitor_detail_response.py">MonitorDetailResponse</a></code>
+- <code title="put /monitor/{monitor_id}">client.monitor.<a href="./src/deeprails/resources/monitor.py">update</a>(monitor_id, \*\*<a href="src/deeprails/types/monitor_update_params.py">params</a>) -> <a href="./src/deeprails/types/monitor_response.py">MonitorResponse</a></code>
+- <code title="post /monitor/{monitor_id}/events">client.monitor.<a href="./src/deeprails/resources/monitor.py">submit_event</a>(monitor_id, \*\*<a href="src/deeprails/types/monitor_submit_event_params.py">params</a>) -> <a href="./src/deeprails/types/monitor_event_response.py">MonitorEventResponse</a></code>

{deeprails-1.8.0 → deeprails-1.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "deeprails"
-version = "1.8.0"
+version = "1.10.0"
 description = "The official Python library for the deeprails API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/_client.py

@@ -21,7 +21,7 @@ from ._types import (
 )
 from ._utils import is_given, get_async_library
 from ._version import __version__
-from .resources import defend, monitor, evaluate
+from .resources import defend, monitor
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
 from ._exceptions import APIStatusError, DeeprailsError
 from ._base_client import (
@@ -45,7 +45,6 @@ __all__ = [
 class Deeprails(SyncAPIClient):
     defend: defend.DefendResource
     monitor: monitor.MonitorResource
-    evaluate: evaluate.EvaluateResource
     with_raw_response: DeeprailsWithRawResponse
     with_streaming_response: DeeprailsWithStreamedResponse
 
@@ -105,7 +104,6 @@ class Deeprails(SyncAPIClient):
 
         self.defend = defend.DefendResource(self)
         self.monitor = monitor.MonitorResource(self)
-        self.evaluate = evaluate.EvaluateResource(self)
         self.with_raw_response = DeeprailsWithRawResponse(self)
         self.with_streaming_response = DeeprailsWithStreamedResponse(self)
 
@@ -217,7 +215,6 @@ class Deeprails(SyncAPIClient):
 class AsyncDeeprails(AsyncAPIClient):
     defend: defend.AsyncDefendResource
     monitor: monitor.AsyncMonitorResource
-    evaluate: evaluate.AsyncEvaluateResource
     with_raw_response: AsyncDeeprailsWithRawResponse
     with_streaming_response: AsyncDeeprailsWithStreamedResponse
 
@@ -277,7 +274,6 @@ class AsyncDeeprails(AsyncAPIClient):
 
         self.defend = defend.AsyncDefendResource(self)
         self.monitor = monitor.AsyncMonitorResource(self)
-        self.evaluate = evaluate.AsyncEvaluateResource(self)
         self.with_raw_response = AsyncDeeprailsWithRawResponse(self)
         self.with_streaming_response = AsyncDeeprailsWithStreamedResponse(self)
 
@@ -390,28 +386,24 @@ class DeeprailsWithRawResponse:
     def __init__(self, client: Deeprails) -> None:
         self.defend = defend.DefendResourceWithRawResponse(client.defend)
         self.monitor = monitor.MonitorResourceWithRawResponse(client.monitor)
-        self.evaluate = evaluate.EvaluateResourceWithRawResponse(client.evaluate)
 
 
 class AsyncDeeprailsWithRawResponse:
     def __init__(self, client: AsyncDeeprails) -> None:
         self.defend = defend.AsyncDefendResourceWithRawResponse(client.defend)
         self.monitor = monitor.AsyncMonitorResourceWithRawResponse(client.monitor)
-        self.evaluate = evaluate.AsyncEvaluateResourceWithRawResponse(client.evaluate)
 
 
 class DeeprailsWithStreamedResponse:
     def __init__(self, client: Deeprails) -> None:
         self.defend = defend.DefendResourceWithStreamingResponse(client.defend)
         self.monitor = monitor.MonitorResourceWithStreamingResponse(client.monitor)
-        self.evaluate = evaluate.EvaluateResourceWithStreamingResponse(client.evaluate)
 
 
 class AsyncDeeprailsWithStreamedResponse:
     def __init__(self, client: AsyncDeeprails) -> None:
         self.defend = defend.AsyncDefendResourceWithStreamingResponse(client.defend)
         self.monitor = monitor.AsyncMonitorResourceWithStreamingResponse(client.monitor)
-        self.evaluate = evaluate.AsyncEvaluateResourceWithStreamingResponse(client.evaluate)
 
 
 Client = Deeprails

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "deeprails"
-__version__ = "1.8.0"  # x-release-please-version
+__version__ = "1.10.0"  # x-release-please-version

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/resources/__init__.py

@@ -16,14 +16,6 @@ from .monitor import (
     MonitorResourceWithStreamingResponse,
     AsyncMonitorResourceWithStreamingResponse,
 )
-from .evaluate import (
-    EvaluateResource,
-    AsyncEvaluateResource,
-    EvaluateResourceWithRawResponse,
-    AsyncEvaluateResourceWithRawResponse,
-    EvaluateResourceWithStreamingResponse,
-    AsyncEvaluateResourceWithStreamingResponse,
-)
 
 __all__ = [
     "DefendResource",
@@ -38,10 +30,4 @@ __all__ = [
     "AsyncMonitorResourceWithRawResponse",
     "MonitorResourceWithStreamingResponse",
     "AsyncMonitorResourceWithStreamingResponse",
-    "EvaluateResource",
-    "AsyncEvaluateResource",
-    "EvaluateResourceWithRawResponse",
-    "AsyncEvaluateResourceWithRawResponse",
-    "EvaluateResourceWithStreamingResponse",
-    "AsyncEvaluateResourceWithStreamingResponse",
 ]

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/resources/defend.py

@@ -54,7 +54,7 @@ class DefendResource(SyncAPIResource):
         automatic_hallucination_tolerance_levels: Dict[str, Literal["low", "medium", "high"]] | Omit = omit,
         custom_hallucination_threshold_values: Dict[str, float] | Omit = omit,
         description: str | Omit = omit,
-        max_improvement_attempt: int | Omit = omit,
+        max_improvement_attempts: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -92,7 +92,7 @@ class DefendResource(SyncAPIResource):
 
           description: Description for the workflow.
 
-          max_improvement_attempt: Max. number of improvement action retries until a given event passes the
+          max_improvement_attempts: Max. number of improvement action retries until a given event passes the
               guardrails. Defaults to 10.
 
           extra_headers: Send extra headers
@@ -113,7 +113,7 @@ class DefendResource(SyncAPIResource):
                     "automatic_hallucination_tolerance_levels": automatic_hallucination_tolerance_levels,
                     "custom_hallucination_threshold_values": custom_hallucination_threshold_values,
                     "description": description,
-                    "max_improvement_attempt": max_improvement_attempt,
+                    "max_improvement_attempts": max_improvement_attempts,
                 },
                 defend_create_workflow_params.DefendCreateWorkflowParams,
             ),
@@ -214,7 +214,7 @@ class DefendResource(SyncAPIResource):
 
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
-              contain at least `user_prompt` or `system_prompt` field. For the
+              contain at least a `user_prompt` field or a `system_prompt` field. For the
               ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
@@ -332,7 +332,7 @@ class AsyncDefendResource(AsyncAPIResource):
         automatic_hallucination_tolerance_levels: Dict[str, Literal["low", "medium", "high"]] | Omit = omit,
         custom_hallucination_threshold_values: Dict[str, float] | Omit = omit,
         description: str | Omit = omit,
-        max_improvement_attempt: int | Omit = omit,
+        max_improvement_attempts: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -370,7 +370,7 @@ class AsyncDefendResource(AsyncAPIResource):
 
           description: Description for the workflow.
 
-          max_improvement_attempt: Max. number of improvement action retries until a given event passes the
+          max_improvement_attempts: Max. number of improvement action retries until a given event passes the
               guardrails. Defaults to 10.
 
           extra_headers: Send extra headers
@@ -391,7 +391,7 @@ class AsyncDefendResource(AsyncAPIResource):
                     "automatic_hallucination_tolerance_levels": automatic_hallucination_tolerance_levels,
                     "custom_hallucination_threshold_values": custom_hallucination_threshold_values,
                     "description": description,
-                    "max_improvement_attempt": max_improvement_attempt,
+                    "max_improvement_attempts": max_improvement_attempts,
                 },
                 defend_create_workflow_params.DefendCreateWorkflowParams,
             ),
@@ -492,7 +492,7 @@ class AsyncDefendResource(AsyncAPIResource):
 
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
-              contain at least `user_prompt` or `system_prompt` field. For the
+              contain at least a `user_prompt` field or a `system_prompt` field. For the
               ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/resources/monitor.py

@@ -19,9 +19,9 @@ from .._response import (
     async_to_streamed_response_wrapper,
 )
 from .._base_client import make_request_options
-from ..types.api_response import APIResponse
-from ..types.monitor_retrieve_response import MonitorRetrieveResponse
-from ..types.monitor_submit_event_response import MonitorSubmitEventResponse
+from ..types.monitor_response import MonitorResponse
+from ..types.monitor_event_response import MonitorEventResponse
+from ..types.monitor_detail_response import MonitorDetailResponse
 
 __all__ = ["MonitorResource", "AsyncMonitorResource"]
 
@@ -57,7 +57,7 @@ class MonitorResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponse:
+    ) -> MonitorResponse:
         """
         Use this endpoint to create a new monitor to evaluate model inputs and outputs
         using guardrails
@@ -87,7 +87,7 @@ class MonitorResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponse,
+            cast_to=MonitorResponse,
         )
 
     def retrieve(
@@ -101,7 +101,7 @@ class MonitorResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> MonitorRetrieveResponse:
+    ) -> MonitorDetailResponse:
         """
         Use this endpoint to retrieve the details and evaluations associated with a
         specific monitor
@@ -128,7 +128,7 @@ class MonitorResource(SyncAPIResource):
                 timeout=timeout,
                 query=maybe_transform({"limit": limit}, monitor_retrieve_params.MonitorRetrieveParams),
             ),
-            cast_to=MonitorRetrieveResponse,
+            cast_to=MonitorDetailResponse,
         )
 
     def update(
@@ -144,7 +144,7 @@ class MonitorResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponse:
+    ) -> MonitorResponse:
         """
         Use this endpoint to update the name, description, or status of an existing
         monitor
@@ -180,7 +180,7 @@ class MonitorResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponse,
+            cast_to=MonitorResponse,
         )
 
     def submit_event(
@@ -208,7 +208,7 @@ class MonitorResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> MonitorSubmitEventResponse:
+    ) -> MonitorEventResponse:
         """
         Use this endpoint to submit a model input and output pair to a monitor for
         evaluation
@@ -220,7 +220,7 @@ class MonitorResource(SyncAPIResource):
               `ground_truth_adherence`, and/or `comprehensive_safety`.
 
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
-              contain at least a `user_prompt` or `system_prompt` field. For
+              contain at least a `user_prompt` field or a `system_prompt` field. For
               ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
@@ -260,7 +260,7 @@ class MonitorResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=MonitorSubmitEventResponse,
+            cast_to=MonitorEventResponse,
         )
 
 
@@ -295,7 +295,7 @@ class AsyncMonitorResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponse:
+    ) -> MonitorResponse:
         """
         Use this endpoint to create a new monitor to evaluate model inputs and outputs
         using guardrails
@@ -325,7 +325,7 @@ class AsyncMonitorResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponse,
+            cast_to=MonitorResponse,
         )
 
     async def retrieve(
@@ -339,7 +339,7 @@ class AsyncMonitorResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> MonitorRetrieveResponse:
+    ) -> MonitorDetailResponse:
         """
         Use this endpoint to retrieve the details and evaluations associated with a
         specific monitor
@@ -366,7 +366,7 @@ class AsyncMonitorResource(AsyncAPIResource):
                 timeout=timeout,
                 query=await async_maybe_transform({"limit": limit}, monitor_retrieve_params.MonitorRetrieveParams),
             ),
-            cast_to=MonitorRetrieveResponse,
+            cast_to=MonitorDetailResponse,
         )
 
     async def update(
@@ -382,7 +382,7 @@ class AsyncMonitorResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponse:
+    ) -> MonitorResponse:
         """
         Use this endpoint to update the name, description, or status of an existing
         monitor
@@ -418,7 +418,7 @@ class AsyncMonitorResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponse,
+            cast_to=MonitorResponse,
         )
 
     async def submit_event(
@@ -446,7 +446,7 @@ class AsyncMonitorResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> MonitorSubmitEventResponse:
+    ) -> MonitorEventResponse:
         """
         Use this endpoint to submit a model input and output pair to a monitor for
         evaluation
@@ -458,7 +458,7 @@ class AsyncMonitorResource(AsyncAPIResource):
               `ground_truth_adherence`, and/or `comprehensive_safety`.
 
           model_input: A dictionary of inputs sent to the LLM to generate output. The dictionary must
-              contain at least a `user_prompt` or `system_prompt` field. For
+              contain at least a `user_prompt` field or a `system_prompt` field. For
               ground_truth_adherence guardrail metric, `ground_truth` should be provided.
 
           model_output: Output generated by the LLM to be evaluated.
@@ -498,7 +498,7 @@ class AsyncMonitorResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=MonitorSubmitEventResponse,
+            cast_to=MonitorEventResponse,
         )
 
 

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/types/__init__.py

@@ -2,17 +2,15 @@
 
 from __future__ import annotations
 
-from .evaluation import Evaluation as Evaluation
-from .api_response import APIResponse as APIResponse
 from .defend_response import DefendResponse as DefendResponse
+from .monitor_response import MonitorResponse as MonitorResponse
 from .monitor_create_params import MonitorCreateParams as MonitorCreateParams
 from .monitor_update_params import MonitorUpdateParams as MonitorUpdateParams
-from .evaluate_create_params import EvaluateCreateParams as EvaluateCreateParams
+from .monitor_event_response import MonitorEventResponse as MonitorEventResponse
+from .monitor_detail_response import MonitorDetailResponse as MonitorDetailResponse
 from .monitor_retrieve_params import MonitorRetrieveParams as MonitorRetrieveParams
 from .workflow_event_response import WorkflowEventResponse as WorkflowEventResponse
-from .monitor_retrieve_response import MonitorRetrieveResponse as MonitorRetrieveResponse
 from .defend_submit_event_params import DefendSubmitEventParams as DefendSubmitEventParams
 from .monitor_submit_event_params import MonitorSubmitEventParams as MonitorSubmitEventParams
 from .defend_create_workflow_params import DefendCreateWorkflowParams as DefendCreateWorkflowParams
 from .defend_update_workflow_params import DefendUpdateWorkflowParams as DefendUpdateWorkflowParams
-from .monitor_submit_event_response import MonitorSubmitEventResponse as MonitorSubmitEventResponse

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/types/defend_create_workflow_params.py

@@ -48,7 +48,7 @@ class DefendCreateWorkflowParams(TypedDict, total=False):
     description: str
     """Description for the workflow."""
 
-    max_improvement_attempt: int
+    max_improvement_attempts: int
     """Max.
 
     number of improvement action retries until a given event passes the guardrails.

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/types/defend_response.py

@@ -31,7 +31,7 @@ class DefendResponse(BaseModel):
     Nothing does not attempt any improvement.
     """
 
-    max_improvement_attempt: Optional[int] = None
+    max_improvement_attempts: Optional[int] = None
     """Max.
 
     number of improvement action retries until a given event passes the guardrails.

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/types/defend_submit_event_params.py

@@ -11,8 +11,9 @@ class DefendSubmitEventParams(TypedDict, total=False):
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 
-    The dictionary must contain at least `user_prompt` or `system_prompt` field. For
-    the ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+    The dictionary must contain at least a `user_prompt` field or a `system_prompt`
+    field. For the ground_truth_adherence guardrail metric, `ground_truth` should be
+    provided.
     """
 
     model_output: Required[str]
@@ -36,7 +37,7 @@ class DefendSubmitEventParams(TypedDict, total=False):
 
 class ModelInput(TypedDict, total=False):
     ground_truth: str
-    """The ground truth for evaluating Ground Truth Adherence guardrail."""
+    """The ground truth for evaluating the Ground Truth Adherence guardrail."""
 
     system_prompt: str
     """The system prompt used to generate the output."""

deeprails-1.8.0/src/deeprails/types/evaluation.py → deeprails-1.10.0/src/deeprails/types/monitor_detail_response.py

@@ -8,10 +8,10 @@ from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
 
-__all__ = ["Evaluation", "ModelInput"]
+__all__ = ["MonitorDetailResponse", "Evaluation", "EvaluationModelInput", "Stats"]
 
 
-class ModelInput(BaseModel):
+class EvaluationModelInput(BaseModel):
     ground_truth: Optional[str] = None
     """The ground truth for evaluating Ground Truth Adherence guardrail."""
 
@@ -29,11 +29,12 @@ class Evaluation(BaseModel):
     evaluation_status: Literal["in_progress", "completed", "canceled", "queued", "failed"]
     """Status of the evaluation."""
 
-    api_model_input: ModelInput = FieldInfo(alias="model_input")
+    api_model_input: EvaluationModelInput = FieldInfo(alias="model_input")
     """A dictionary of inputs sent to the LLM to generate output.
 
-    The dictionary must contain at least `user_prompt` or `system_prompt` field. For
-    ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+    The dictionary must contain at least a `user_prompt` field or a `system_prompt`
+    field. For ground_truth_adherence guardrail metric, `ground_truth` should be
+    provided.
     """
 
     api_model_output: str = FieldInfo(alias="model_output")
@@ -102,3 +103,60 @@ class Evaluation(BaseModel):
 
     start_timestamp: Optional[datetime] = None
     """The time the evaluation started in UTC."""
+
+
+class Stats(BaseModel):
+    completed_evaluations: Optional[int] = None
+    """Number of evaluations that completed successfully."""
+
+    failed_evaluations: Optional[int] = None
+    """Number of evaluations that failed."""
+
+    in_progress_evaluations: Optional[int] = None
+    """Number of evaluations currently in progress."""
+
+    queued_evaluations: Optional[int] = None
+    """Number of evaluations currently queued."""
+
+    total_evaluations: Optional[int] = None
+    """Total number of evaluations performed by this monitor."""
+
+
+class MonitorDetailResponse(BaseModel):
+    monitor_id: str
+    """A unique monitor ID."""
+
+    monitor_status: Literal["active", "inactive"]
+    """Status of the monitor.
+
+    Can be `active` or `inactive`. Inactive monitors no longer record and evaluate
+    events.
+    """
+
+    name: str
+    """Name of this monitor."""
+
+    created_at: Optional[datetime] = None
+    """The time the monitor was created in UTC."""
+
+    description: Optional[str] = None
+    """Description of this monitor."""
+
+    evaluations: Optional[List[Evaluation]] = None
+    """An array of all evaluations performed by this monitor.
+
+    Each one corresponds to a separate monitor event.
+    """
+
+    stats: Optional[Stats] = None
+    """
+    Contains five fields used for stats of this monitor: total evaluations,
+    completed evaluations, failed evaluations, queued evaluations, and in progress
+    evaluations.
+    """
+
+    updated_at: Optional[datetime] = None
+    """The most recent time the monitor was modified in UTC."""
+
+    user_id: Optional[str] = None
+    """User ID of the user who created the monitor."""

deeprails-1.8.0/src/deeprails/types/monitor_submit_event_response.py → deeprails-1.10.0/src/deeprails/types/monitor_event_response.py

@@ -5,10 +5,10 @@ from datetime import datetime
 
 from .._models import BaseModel
 
-__all__ = ["MonitorSubmitEventResponse", "Data"]
+__all__ = ["MonitorEventResponse"]
 
 
-class Data(BaseModel):
+class MonitorEventResponse(BaseModel):
     evaluation_id: str
     """A unique evaluation ID associated with this event."""
 
@@ -20,16 +20,3 @@ class Data(BaseModel):
 
     created_at: Optional[datetime] = None
     """The time the monitor event was created in UTC."""
-
-
-class MonitorSubmitEventResponse(BaseModel):
-    success: bool
-    """Represents whether the request was completed successfully."""
-
-    data: Optional[Data] = None
-
-    message: Optional[str] = None
-    """The accompanying message for the request.
-
-    Includes error details when applicable.
-    """

deeprails-1.8.0/src/deeprails/types/api_response.py → deeprails-1.10.0/src/deeprails/types/monitor_response.py

@@ -6,10 +6,10 @@ from typing_extensions import Literal
 
 from .._models import BaseModel
 
-__all__ = ["APIResponse", "Data"]
+__all__ = ["MonitorResponse"]
 
 
-class Data(BaseModel):
+class MonitorResponse(BaseModel):
     monitor_id: str
     """A unique monitor ID."""
 
@@ -34,16 +34,3 @@ class Data(BaseModel):
 
     user_id: Optional[str] = None
     """User ID of the user who created the monitor."""
-
-
-class APIResponse(BaseModel):
-    success: bool
-    """Represents whether the request was completed successfully."""
-
-    data: Optional[Data] = None
-
-    message: Optional[str] = None
-    """The accompanying message for the request.
-
-    Includes error details when applicable.
-    """

{deeprails-1.8.0 → deeprails-1.10.0}/src/deeprails/types/monitor_submit_event_params.py

@@ -31,8 +31,9 @@ class MonitorSubmitEventParams(TypedDict, total=False):
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 
-    The dictionary must contain at least a `user_prompt` or `system_prompt` field.
-    For ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+    The dictionary must contain at least a `user_prompt` field or a `system_prompt`
+    field. For ground_truth_adherence guardrail metric, `ground_truth` should be
+    provided.
     """
 
     model_output: Required[str]