deeprails 1.0.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

deeprails/resources/monitor.py

@@ -33,7 +33,7 @@ class MonitorResource(SyncAPIResource):
         This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
-        For more information, see https://www.github.com/deeprails/deeprails-python-sdk#accessing-raw-response-data-eg-headers
+        For more information, see https://www.github.com/deeprails/deeprails-sdk-python#accessing-raw-response-data-eg-headers
         """
         return MonitorResourceWithRawResponse(self)
 
@@ -42,7 +42,7 @@ class MonitorResource(SyncAPIResource):
         """
         An alternative to `.with_raw_response` that doesn't eagerly read the response body.
 
-        For more information, see https://www.github.com/deeprails/deeprails-python-sdk#with_streaming_response
+        For more information, see https://www.github.com/deeprails/deeprails-sdk-python#with_streaming_response
         """
         return MonitorResourceWithStreamingResponse(self)
 
@@ -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
@@ -267,7 +271,7 @@ class AsyncMonitorResource(AsyncAPIResource):
         This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
-        For more information, see https://www.github.com/deeprails/deeprails-python-sdk#accessing-raw-response-data-eg-headers
+        For more information, see https://www.github.com/deeprails/deeprails-sdk-python#accessing-raw-response-data-eg-headers
         """
         return AsyncMonitorResourceWithRawResponse(self)
 
@@ -276,7 +280,7 @@ class AsyncMonitorResource(AsyncAPIResource):
         """
         An alternative to `.with_raw_response` that doesn't eagerly read the response body.
 
-        For more information, see https://www.github.com/deeprails/deeprails-python-sdk#with_streaming_response
+        For more information, see https://www.github.com/deeprails/deeprails-sdk-python#with_streaming_response
         """
         return AsyncMonitorResourceWithStreamingResponse(self)
 
@@ -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/types/__init__.py

@@ -9,7 +9,9 @@ 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_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

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/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/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/types/{defend/event_submit_event_params.py → defend_submit_event_params.py}

@@ -5,10 +5,10 @@ from __future__ import annotations
 from typing import Dict, Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
-__all__ = ["EventSubmitEventParams", "ModelInput"]
+__all__ = ["DefendSubmitEventParams", "ModelInput"]
 
 
-class EventSubmitEventParams(TypedDict, total=False):
+class DefendSubmitEventParams(TypedDict, total=False):
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 

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/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/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/types/{defend/workflow_event_response.py → workflow_event_response.py}

@@ -2,7 +2,7 @@
 
 from typing import Optional
 
-from ..._models import BaseModel
+from .._models import BaseModel
 
 __all__ = ["WorkflowEventResponse"]
 

{deeprails-1.0.0.dist-info → deeprails-1.3.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.0.0
+Version: 1.3.0
 Summary: The official Python library for the deeprails API
-Project-URL: Homepage, https://github.com/deeprails/deeprails-python-sdk
-Project-URL: Repository, https://github.com/deeprails/deeprails-python-sdk
-Author-email: Deeprails <support@deeprails.ai>
+Project-URL: Homepage, https://docs.deeprails.com/
+Project-URL: Repository, https://github.com/deeprails/deeprails-sdk-python
+Author-email: DeepRails <support@deeprails.ai>
 License: Apache-2.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -42,11 +42,9 @@ The Deeprails Python library provides convenient access to the Deeprails REST AP
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
-It is generated with [Stainless](https://www.stainless.com/).
-
 ## Documentation
 
-The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-python-sdk/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
 
@@ -57,7 +55,7 @@ pip install deeprails
 
 ## Usage
 
-The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-python-sdk/tree/main/api.md).
+The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-sdk-python/tree/main/api.md).
 
 ```python
 import os
@@ -65,26 +63,16 @@ from deeprails import Deeprails
 
 client = Deeprails(
     api_key=os.environ.get("DEEPRAILS_API_KEY"),  # This is the default and can be omitted
-    # defaults to "production".
-    environment="environment_1",
 )
 
 defend_response = client.defend.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 print(defend_response.workflow_id)
 ```
@@ -105,28 +93,18 @@ from deeprails import AsyncDeeprails
 
 client = AsyncDeeprails(
     api_key=os.environ.get("DEEPRAILS_API_KEY"),  # This is the default and can be omitted
-    # defaults to "production".
-    environment="environment_1",
 )
 
 
 async def main() -> None:
     defend_response = await client.defend.create_workflow(
-        improvement_action="regenerate",
+        improvement_action="fixit",
         metrics={
-            "0": 0,
-            "1": 0,
-            "2": 0,
-            "3": 0,
-            "4": 0,
-            "5": 0,
-            "6": 0,
-            "7": 0,
-            "8": 0,
-            "9": 0,
+            "completeness": 0.8,
+            "instruction_adherence": 0.75,
         },
-        name="REPLACE_ME",
-        type="automatic",
+        name="Push Alert Workflow",
+        type="custom",
     )
     print(defend_response.workflow_id)
 
@@ -161,21 +139,13 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         defend_response = await client.defend.create_workflow(
-            improvement_action="regenerate",
+            improvement_action="fixit",
             metrics={
-                "0": 0,
-                "1": 0,
-                "2": 0,
-                "3": 0,
-                "4": 0,
-                "5": 0,
-                "6": 0,
-                "7": 0,
-                "8": 0,
-                "9": 0,
+                "completeness": 0.8,
+                "instruction_adherence": 0.75,
             },
-            name="REPLACE_ME",
-            type="automatic",
+            name="Push Alert Workflow",
+            type="custom",
         )
         print(defend_response.workflow_id)
 
@@ -201,7 +171,7 @@ from deeprails import Deeprails
 
 client = Deeprails()
 
-workflow_event_response = client.defend.events.submit_event(
+workflow_event_response = client.defend.submit_event(
     workflow_id="workflow_id",
     model_input={"user_prompt": "user_prompt"},
     model_output="model_output",
@@ -229,21 +199,13 @@ client = Deeprails()
 
 try:
     client.defend.create_workflow(
-        improvement_action="regenerate",
+        improvement_action="fixit",
         metrics={
-            "0": 0,
-            "1": 0,
-            "2": 0,
-            "3": 0,
-            "4": 0,
-            "5": 0,
-            "6": 0,
-            "7": 0,
-            "8": 0,
-            "9": 0,
+            "completeness": 0.8,
+            "instruction_adherence": 0.75,
         },
-        name="REPLACE_ME",
-        type="automatic",
+        name="Push Alert Workflow",
+        type="custom",
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -288,21 +250,13 @@ client = Deeprails(
 
 # Or, configure per-request:
 client.with_options(max_retries=5).defend.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 ```
 
@@ -327,27 +281,19 @@ client = Deeprails(
 
 # Override per-request:
 client.with_options(timeout=5.0).defend.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 ```
 
 On timeout, an `APITimeoutError` is thrown.
 
-Note that requests that time out are [retried twice by default](https://github.com/deeprails/deeprails-python-sdk/tree/main/#retries).
+Note that requests that time out are [retried twice by default](https://github.com/deeprails/deeprails-sdk-python/tree/main/#retries).
 
 ## Advanced
 
@@ -384,21 +330,13 @@ from deeprails import Deeprails
 
 client = Deeprails()
 response = client.defend.with_raw_response.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -406,9 +344,9 @@ defend = response.parse()  # get the object that `defend.create_workflow()` woul
 print(defend.workflow_id)
 ```
 
-These methods return an [`APIResponse`](https://github.com/deeprails/deeprails-python-sdk/tree/main/src/deeprails/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/deeprails/deeprails-sdk-python/tree/main/src/deeprails/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/deeprails/deeprails-python-sdk/tree/main/src/deeprails/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/deeprails/deeprails-sdk-python/tree/main/src/deeprails/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -418,21 +356,13 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.defend.with_streaming_response.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -442,109 +372,6 @@ with client.defend.with_streaming_response.create_workflow(
 
 The context manager is required so that the response will reliably be closed.
 
-### Making custom/undocumented requests
-
-This library is typed for convenient access to the documented API.
-
-If you need to access undocumented endpoints, params, or response properties, the library can still be used.
-
-#### Undocumented endpoints
-
-To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
-http verbs. Options on the client will be respected (such as retries) when making this request.
-
-```py
-import httpx
-
-response = client.post(
-    "/foo",
-    cast_to=httpx.Response,
-    body={"my_param": True},
-)
-
-print(response.headers.get("x-foo"))
-```
-
-#### Undocumented request params
-
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
-options.
-
-#### Undocumented response properties
-
-To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
-can also get all the extra fields on the Pydantic model as a dict with
-[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
-
-### Configuring the HTTP client
-
-You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
-
-- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)
-- Custom [transports](https://www.python-httpx.org/advanced/transports/)
-- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
-
-```python
-import httpx
-from deeprails import Deeprails, DefaultHttpxClient
-
-client = Deeprails(
-    # Or use the `DEEPRAILS_BASE_URL` env var
-    base_url="http://my.test.server.example.com:8083",
-    http_client=DefaultHttpxClient(
-        proxy="http://my.test.proxy.example.com",
-        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
-    ),
-)
-```
-
-You can also customize the client on a per-request basis by using `with_options()`:
-
-```python
-client.with_options(http_client=DefaultHttpxClient(...))
-```
-
-### Managing HTTP resources
-
-By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
-
-```py
-from deeprails import Deeprails
-
-with Deeprails() as client:
-  # make requests here
-  ...
-
-# HTTP client is now closed
-```
-
-## Versioning
-
-This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
-
-1. Changes that only affect static types, without breaking runtime behavior.
-2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
-3. Changes that we do not expect to impact the vast majority of users in practice.
-
-We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
-
-We are keen for your feedback; please open an [issue](https://www.github.com/deeprails/deeprails-python-sdk/issues) with questions, bugs, or suggestions.
-
-### Determining the installed version
-
-If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
-
-You can determine the version that is being used at runtime with:
-
-```py
-import deeprails
-print(deeprails.__version__)
-```
-
 ## Requirements
 
 Python 3.8 or higher.
-
-## Contributing
-
-See [the contributing documentation](https://github.com/deeprails/deeprails-python-sdk/tree/main/./CONTRIBUTING.md).