deeprails 1.2.0__tar.gz → 1.3.0__tar.gz

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

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

{deeprails-1.2.0 → deeprails-1.3.0}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.3.0 (2025-10-08)
+
+Full Changelog: [v1.2.0...v1.3.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.2.0...v1.3.0)
+
+### Features
+
+* **api:** adding code samples ([c7f7565](https://github.com/deeprails/deeprails-sdk-python/commit/c7f7565abd00233d22d9c11a5b2c977414e03439))
+* **api:** manual updates ([145946a](https://github.com/deeprails/deeprails-sdk-python/commit/145946a049fb29bff01df6763248330f4d0030ad))
+
 ## 1.2.0 (2025-10-07)
 
 Full Changelog: [v1.1.0...v1.2.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.1.0...v1.2.0)

{deeprails-1.2.0 → deeprails-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.2.0
+Version: 1.3.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
@@ -44,7 +44,7 @@ and offers both synchronous and asynchronous clients powered by [httpx](https://
 
 ## Documentation
 
-The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-sdk-python/tree/main/api.md).
+The REST API documentation can be found on [docs.deeprails.com](https://docs.deeprails.com). The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-sdk-python/tree/main/api.md).
 
 ## Installation
 
@@ -68,7 +68,7 @@ client = Deeprails(
 defend_response = client.defend.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -100,7 +100,7 @@ async def main() -> None:
     defend_response = await client.defend.create_workflow(
         improvement_action="fixit",
         metrics={
-            "completeness": 0.85,
+            "completeness": 0.8,
             "instruction_adherence": 0.75,
         },
         name="Push Alert Workflow",
@@ -141,7 +141,7 @@ async def main() -> None:
         defend_response = await client.defend.create_workflow(
             improvement_action="fixit",
             metrics={
-                "completeness": 0.85,
+                "completeness": 0.8,
                 "instruction_adherence": 0.75,
             },
             name="Push Alert Workflow",
@@ -201,7 +201,7 @@ try:
     client.defend.create_workflow(
         improvement_action="fixit",
         metrics={
-            "completeness": 0.85,
+            "completeness": 0.8,
             "instruction_adherence": 0.75,
         },
         name="Push Alert Workflow",
@@ -252,7 +252,7 @@ client = Deeprails(
 client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -283,7 +283,7 @@ client = Deeprails(
 client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -332,7 +332,7 @@ client = Deeprails()
 response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -358,7 +358,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",

{deeprails-1.2.0 → deeprails-1.3.0}/README.md

@@ -9,7 +9,7 @@ and offers both synchronous and asynchronous clients powered by [httpx](https://
 
 ## Documentation
 
-The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [docs.deeprails.com](https://docs.deeprails.com). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -33,7 +33,7 @@ client = Deeprails(
 defend_response = client.defend.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -65,7 +65,7 @@ async def main() -> None:
     defend_response = await client.defend.create_workflow(
         improvement_action="fixit",
         metrics={
-            "completeness": 0.85,
+            "completeness": 0.8,
             "instruction_adherence": 0.75,
         },
         name="Push Alert Workflow",
@@ -106,7 +106,7 @@ async def main() -> None:
         defend_response = await client.defend.create_workflow(
             improvement_action="fixit",
             metrics={
-                "completeness": 0.85,
+                "completeness": 0.8,
                 "instruction_adherence": 0.75,
             },
             name="Push Alert Workflow",
@@ -166,7 +166,7 @@ try:
     client.defend.create_workflow(
         improvement_action="fixit",
         metrics={
-            "completeness": 0.85,
+            "completeness": 0.8,
             "instruction_adherence": 0.75,
         },
         name="Push Alert Workflow",
@@ -217,7 +217,7 @@ client = Deeprails(
 client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -248,7 +248,7 @@ client = Deeprails(
 client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -297,7 +297,7 @@ client = Deeprails()
 response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",
@@ -323,7 +323,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     metrics={
-        "completeness": 0.85,
+        "completeness": 0.8,
         "instruction_adherence": 0.75,
     },
     name="Push Alert Workflow",

{deeprails-1.2.0 → deeprails-1.3.0}/pyproject.toml

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

{deeprails-1.2.0 → deeprails-1.3.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.2.0"  # x-release-please-version
+__version__ = "1.3.0"  # x-release-please-version

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/resources/defend.py

@@ -63,13 +63,13 @@ class DefendResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DefendResponse:
         """
-        Create a new guardrail workflow with optional guardrail thresholds and
-        improvement actions.
+        Use this endpoint to create a new guardrail workflow with optional guardrail
+        thresholds and improvement actions
 
         Args:
           improvement_action: The action used to improve outputs that fail one or guardrail metrics for the
               workflow events. May be `regenerate`, `fixit`, or null which represents “do
-              nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+              nothing”. Regenerate runs the user's input prompt with minor induced variance.
               Fixit attempts to directly address the shortcomings of the output using the
               guardrail failure rationale. Do nothing does not attempt any improvement.
 
@@ -136,7 +136,7 @@ class DefendResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WorkflowEventResponse:
         """
-        Retrieve a specific event of a guardrail workflow.
+        Use this endpoint to retrieve a specific event of a guardrail workflow
 
         Args:
           extra_headers: Send extra headers
@@ -171,7 +171,7 @@ class DefendResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DefendResponse:
         """
-        Retrieve the details for a specific guardrail workflow.
+        Use this endpoint to retrieve the details for a specific defend workflow
 
         Args:
           extra_headers: Send extra headers
@@ -209,7 +209,8 @@ class DefendResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WorkflowEventResponse:
         """
-        Submit a model input and output pair to a workflow for evaluation.
+        Use this endpoint to submit a model input and output pair to a workflow for
+        evaluation
 
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
@@ -261,7 +262,6 @@ class DefendResource(SyncAPIResource):
         *,
         description: str | Omit = omit,
         name: str | Omit = omit,
-        type: Literal["automatic", "custom"] | 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,
@@ -270,15 +270,13 @@ class DefendResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DefendResponse:
         """
-        Update an existing guardrail workflow.
+        Use this endpoint to update an existing guardrail workflow
 
         Args:
           description: Description for the workflow.
 
           name: Name of the workflow.
 
-          type: Type of thresholds to use for the workflow, either `automatic` or `custom`.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -295,7 +293,6 @@ class DefendResource(SyncAPIResource):
                 {
                     "description": description,
                     "name": name,
-                    "type": type,
                 },
                 defend_update_workflow_params.DefendUpdateWorkflowParams,
             ),
@@ -344,13 +341,13 @@ class AsyncDefendResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DefendResponse:
         """
-        Create a new guardrail workflow with optional guardrail thresholds and
-        improvement actions.
+        Use this endpoint to create a new guardrail workflow with optional guardrail
+        thresholds and improvement actions
 
         Args:
           improvement_action: The action used to improve outputs that fail one or guardrail metrics for the
               workflow events. May be `regenerate`, `fixit`, or null which represents “do
-              nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+              nothing”. Regenerate runs the user's input prompt with minor induced variance.
               Fixit attempts to directly address the shortcomings of the output using the
               guardrail failure rationale. Do nothing does not attempt any improvement.
 
@@ -417,7 +414,7 @@ class AsyncDefendResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WorkflowEventResponse:
         """
-        Retrieve a specific event of a guardrail workflow.
+        Use this endpoint to retrieve a specific event of a guardrail workflow
 
         Args:
           extra_headers: Send extra headers
@@ -452,7 +449,7 @@ class AsyncDefendResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DefendResponse:
         """
-        Retrieve the details for a specific guardrail workflow.
+        Use this endpoint to retrieve the details for a specific defend workflow
 
         Args:
           extra_headers: Send extra headers
@@ -490,7 +487,8 @@ class AsyncDefendResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WorkflowEventResponse:
         """
-        Submit a model input and output pair to a workflow for evaluation.
+        Use this endpoint to submit a model input and output pair to a workflow for
+        evaluation
 
         Args:
           model_input: A dictionary of inputs sent to the LLM to generate output. This must contain a
@@ -542,7 +540,6 @@ class AsyncDefendResource(AsyncAPIResource):
         *,
         description: str | Omit = omit,
         name: str | Omit = omit,
-        type: Literal["automatic", "custom"] | 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,
@@ -551,15 +548,13 @@ class AsyncDefendResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DefendResponse:
         """
-        Update an existing guardrail workflow.
+        Use this endpoint to update an existing guardrail workflow
 
         Args:
           description: Description for the workflow.
 
           name: Name of the workflow.
 
-          type: Type of thresholds to use for the workflow, either `automatic` or `custom`.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -576,7 +571,6 @@ class AsyncDefendResource(AsyncAPIResource):
                 {
                     "description": description,
                     "name": name,
-                    "type": type,
                 },
                 defend_update_workflow_params.DefendUpdateWorkflowParams,
             ),

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/resources/evaluate.py

@@ -133,7 +133,7 @@ class EvaluateResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Evaluation:
         """
-        Retrieve the evaluation record for a given evaluation ID.
+        Use this endpoint to retrieve the evaluation record for a given evaluation ID
 
         Args:
           extra_headers: Send extra headers
@@ -264,7 +264,7 @@ class AsyncEvaluateResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Evaluation:
         """
-        Retrieve the evaluation record for a given evaluation ID.
+        Use this endpoint to retrieve the evaluation record for a given evaluation ID
 
         Args:
           extra_headers: Send extra headers

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/resources/monitor.py

@@ -59,7 +59,8 @@ class MonitorResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> APIResponse:
         """
-        Create a new monitor to evaluate model inputs and outputs using guardrails.
+        Use this endpoint to create a new monitor to evaluate model inputs and outputs
+        using guardrails
 
         Args:
           name: Name of the new monitor.
@@ -102,7 +103,8 @@ class MonitorResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MonitorRetrieveResponse:
         """
-        Retrieve the details and evaluations associated with a specific monitor.
+        Use this endpoint to retrieve the details and evaluations associated with a
+        specific monitor
 
         Args:
           limit: Limit the returned events associated with this monitor. Defaults to 10.
@@ -144,7 +146,8 @@ class MonitorResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> APIResponse:
         """
-        Update the name, description, or status of an existing monitor.
+        Use this endpoint to update the name, description, or status of an existing
+        monitor
 
         Args:
           description: Description of the monitor.
@@ -207,7 +210,8 @@ class MonitorResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MonitorSubmitEventResponse:
         """
-        Submit a model input and output pair to a monitor for evaluation.
+        Use this endpoint to submit a model input and output pair to a monitor for
+        evaluation
 
         Args:
           guardrail_metrics: An array of guardrail metrics that the model input and output pair will be
@@ -293,7 +297,8 @@ class AsyncMonitorResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> APIResponse:
         """
-        Create a new monitor to evaluate model inputs and outputs using guardrails.
+        Use this endpoint to create a new monitor to evaluate model inputs and outputs
+        using guardrails
 
         Args:
           name: Name of the new monitor.
@@ -336,7 +341,8 @@ class AsyncMonitorResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MonitorRetrieveResponse:
         """
-        Retrieve the details and evaluations associated with a specific monitor.
+        Use this endpoint to retrieve the details and evaluations associated with a
+        specific monitor
 
         Args:
           limit: Limit the returned events associated with this monitor. Defaults to 10.
@@ -378,7 +384,8 @@ class AsyncMonitorResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> APIResponse:
         """
-        Update the name, description, or status of an existing monitor.
+        Use this endpoint to update the name, description, or status of an existing
+        monitor
 
         Args:
           description: Description of the monitor.
@@ -441,7 +448,8 @@ class AsyncMonitorResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MonitorSubmitEventResponse:
         """
-        Submit a model input and output pair to a monitor for evaluation.
+        Use this endpoint to submit a model input and output pair to a monitor for
+        evaluation
 
         Args:
           guardrail_metrics: An array of guardrail metrics that the model input and output pair will be

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/types/api_response.py

@@ -41,7 +41,6 @@ class APIResponse(BaseModel):
     """Represents whether the request was completed successfully."""
 
     data: Optional[Data] = None
-    """Response payload for creating or updating a monitor."""
 
     message: Optional[str] = None
     """The accompanying message for the request.

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/types/defend_create_workflow_params.py

@@ -13,7 +13,7 @@ class DefendCreateWorkflowParams(TypedDict, total=False):
     """
     The action used to improve outputs that fail one or guardrail metrics for the
     workflow events. May be `regenerate`, `fixit`, or null which represents “do
-    nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+    nothing”. Regenerate runs the user's input prompt with minor induced variance.
     Fixit attempts to directly address the shortcomings of the output using the
     guardrail failure rationale. Do nothing does not attempt any improvement.
     """

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/types/defend_response.py

@@ -26,7 +26,7 @@ class DefendResponse(BaseModel):
     """
     The action used to improve outputs that fail one or more guardrail metrics for
     the workflow events. May be `regenerate`, `fixit`, or null which represents “do
-    nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+    nothing”. Regenerate runs the user's input prompt with minor induced variance.
     Fixit attempts to directly address the shortcomings of the output using the
     guardrail failure rationale. Do nothing does not attempt any improvement.
     """

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/types/defend_update_workflow_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, TypedDict
+from typing_extensions import TypedDict
 
 __all__ = ["DefendUpdateWorkflowParams"]
 
@@ -13,6 +13,3 @@ class DefendUpdateWorkflowParams(TypedDict, total=False):
 
     name: str
     """Name of the workflow."""
-
-    type: Literal["automatic", "custom"]
-    """Type of thresholds to use for the workflow, either `automatic` or `custom`."""

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/types/monitor_retrieve_response.py

@@ -72,7 +72,6 @@ class MonitorRetrieveResponse(BaseModel):
     """Represents whether the request was completed successfully."""
 
     data: Optional[Data] = None
-    """Detailed response payload for retrieving a monitor and its evaluations."""
 
     message: Optional[str] = None
     """The accompanying message for the request.

{deeprails-1.2.0 → deeprails-1.3.0}/src/deeprails/types/monitor_submit_event_response.py

@@ -27,7 +27,6 @@ class MonitorSubmitEventResponse(BaseModel):
     """Represents whether the request was completed successfully."""
 
     data: Optional[Data] = None
-    """Response payload for monitor event operations."""
 
     message: Optional[str] = None
     """The accompanying message for the request.

{deeprails-1.2.0 → deeprails-1.3.0}/tests/api_resources/test_defend.py

@@ -264,7 +264,6 @@ class TestDefend:
             workflow_id="workflow_id",
             description="description",
             name="name",
-            type="automatic",
         )
         assert_matches_type(DefendResponse, defend, path=["response"])
 
@@ -552,7 +551,6 @@ class TestAsyncDefend:
             workflow_id="workflow_id",
             description="description",
             name="name",
-            type="automatic",
         )
         assert_matches_type(DefendResponse, defend, path=["response"])
 

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

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