deeprails 1.7.0__tar.gz → 1.9.0__tar.gz

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

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

{deeprails-1.7.0 → deeprails-1.9.0}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** manual updates ([4b46121](https://github.com/deeprails/deeprails-sdk-python/commit/4b461213615578ca0382f044201c8343d4e9f167))
+
 ## 1.7.0 (2025-10-22)
 
 Full Changelog: [v1.6.1...v1.7.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.6.1...v1.7.0)

{deeprails-1.7.0 → deeprails-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.7.0
+Version: 1.9.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
@@ -69,6 +69,10 @@ defend_response = client.defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 print(defend_response.workflow_id)
 ```
@@ -97,6 +101,10 @@ async def main() -> None:
         improvement_action="fixit",
         name="Push Alert Workflow",
         type="custom",
+        custom_hallucination_threshold_values={
+            "completeness": 0.7,
+            "instruction_adherence": 0.75,
+        },
     )
     print(defend_response.workflow_id)
 
@@ -134,6 +142,10 @@ async def main() -> None:
             improvement_action="fixit",
             name="Push Alert Workflow",
             type="custom",
+            custom_hallucination_threshold_values={
+                "completeness": 0.7,
+                "instruction_adherence": 0.75,
+            },
         )
         print(defend_response.workflow_id)
 
@@ -189,6 +201,10 @@ try:
         improvement_action="fixit",
         name="Push Alert Workflow",
         type="custom",
+        custom_hallucination_threshold_values={
+            "completeness": 0.7,
+            "instruction_adherence": 0.75,
+        },
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -236,6 +252,10 @@ client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 ```
 
@@ -263,6 +283,10 @@ client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 ```
 
@@ -308,6 +332,10 @@ response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 print(response.headers.get('X-My-Header'))
 
@@ -330,6 +358,10 @@ with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{deeprails-1.7.0 → deeprails-1.9.0}/README.md

@@ -34,6 +34,10 @@ defend_response = client.defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 print(defend_response.workflow_id)
 ```
@@ -62,6 +66,10 @@ async def main() -> None:
         improvement_action="fixit",
         name="Push Alert Workflow",
         type="custom",
+        custom_hallucination_threshold_values={
+            "completeness": 0.7,
+            "instruction_adherence": 0.75,
+        },
     )
     print(defend_response.workflow_id)
 
@@ -99,6 +107,10 @@ async def main() -> None:
             improvement_action="fixit",
             name="Push Alert Workflow",
             type="custom",
+            custom_hallucination_threshold_values={
+                "completeness": 0.7,
+                "instruction_adherence": 0.75,
+            },
         )
         print(defend_response.workflow_id)
 
@@ -154,6 +166,10 @@ try:
         improvement_action="fixit",
         name="Push Alert Workflow",
         type="custom",
+        custom_hallucination_threshold_values={
+            "completeness": 0.7,
+            "instruction_adherence": 0.75,
+        },
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -201,6 +217,10 @@ client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 ```
 
@@ -228,6 +248,10 @@ client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 ```
 
@@ -273,6 +297,10 @@ response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 )
 print(response.headers.get('X-My-Header'))
 
@@ -295,6 +323,10 @@ with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
     type="custom",
+    custom_hallucination_threshold_values={
+        "completeness": 0.7,
+        "instruction_adherence": 0.75,
+    },
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{deeprails-1.7.0 → deeprails-1.9.0}/api.md

@@ -19,15 +19,15 @@ 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>
+- <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>
 
 # Evaluate
 

{deeprails-1.7.0 → deeprails-1.9.0}/pyproject.toml

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

{deeprails-1.7.0 → deeprails-1.9.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.7.0"  # x-release-please-version
+__version__ = "1.9.0"  # x-release-please-version

{deeprails-1.7.0 → deeprails-1.9.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,8 +214,8 @@ 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
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              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,8 +492,8 @@ 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
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              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.7.0 → deeprails-1.9.0}/src/deeprails/resources/evaluate.py

@@ -76,8 +76,8 @@ class EvaluateResource(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
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              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.
 
@@ -207,8 +207,8 @@ class AsyncEvaluateResource(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
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              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.
 

{deeprails-1.7.0 → deeprails-1.9.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,8 +220,8 @@ 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
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              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,8 +458,8 @@ 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
-              ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+              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.7.0 → deeprails-1.9.0}/src/deeprails/types/__init__.py

@@ -3,16 +3,16 @@
 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.7.0 → deeprails-1.9.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.7.0 → deeprails-1.9.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.7.0 → deeprails-1.9.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
-    ground_truth_aherence guadrail 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.7.0 → deeprails-1.9.0}/src/deeprails/types/evaluate_create_params.py

@@ -12,8 +12,9 @@ class EvaluateCreateParams(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
-    ground_truth_aherence guadrail 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]

{deeprails-1.7.0 → deeprails-1.9.0}/src/deeprails/types/evaluation.py

@@ -32,8 +32,9 @@ class Evaluation(BaseModel):
     api_model_input: ModelInput = 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_aherence guadrail 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")

deeprails-1.7.0/src/deeprails/types/monitor_retrieve_response.py → deeprails-1.9.0/src/deeprails/types/monitor_detail_response.py

@@ -7,10 +7,10 @@ from typing_extensions import Literal
 from .._models import BaseModel
 from .evaluation import Evaluation
 
-__all__ = ["MonitorRetrieveResponse", "Data", "DataStats"]
+__all__ = ["MonitorDetailResponse", "Stats"]
 
 
-class DataStats(BaseModel):
+class Stats(BaseModel):
     completed_evaluations: Optional[int] = None
     """Number of evaluations that completed successfully."""
 
@@ -27,7 +27,7 @@ class DataStats(BaseModel):
     """Total number of evaluations performed by this monitor."""
 
 
-class Data(BaseModel):
+class MonitorDetailResponse(BaseModel):
     monitor_id: str
     """A unique monitor ID."""
 
@@ -53,7 +53,7 @@ class Data(BaseModel):
     Each one corresponds to a separate monitor event.
     """
 
-    stats: Optional[DataStats] = None
+    stats: Optional[Stats] = None
     """
     Contains five fields used for stats of this monitor: total evaluations,
     completed evaluations, failed evaluations, queued evaluations, and in progress
@@ -65,16 +65,3 @@ class Data(BaseModel):
 
     user_id: Optional[str] = None
     """User ID of the user who created the monitor."""
-
-
-class MonitorRetrieveResponse(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.
-    """