deeprails 1.12.0__tar.gz → 1.14.0__tar.gz

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

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

{deeprails-1.12.0 → deeprails-1.14.0}/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 1.14.0 (2025-11-11)
+
+Full Changelog: [v1.13.0...v1.14.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.13.0...v1.14.0)
+
+### Features
+
+* **api:** add retrieve monitor event and examples ([b295221](https://github.com/deeprails/deeprails-sdk-python/commit/b2952212f394e8947c900735a5841b78bf8ec729))
+
+## 1.13.0 (2025-11-10)
+
+Full Changelog: [v1.12.0...v1.13.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.12.0...v1.13.0)
+
+### Features
+
+* **api:** Mass restructuring of API, including response bodies and naming schemes ([c72cf32](https://github.com/deeprails/deeprails-sdk-python/commit/c72cf32b37a41673c895a172dd09dcbe90b6ce40))
+
+
+### Chores
+
+* **internal:** grammar fix (it's -> its) ([11449b2](https://github.com/deeprails/deeprails-sdk-python/commit/11449b27a513a1c5b5b35ba88778c636582feb0b))
+
 ## 1.12.0 (2025-11-02)
 
 Full Changelog: [v1.11.0...v1.12.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.11.0...v1.12.0)

{deeprails-1.12.0 → deeprails-1.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.12.0
+Version: 1.14.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
@@ -65,16 +65,17 @@ client = Deeprails(
     api_key=os.environ.get("DEEPRAILS_API_KEY"),  # This is the default and can be omitted
 )
 
-defend_response = client.defend.create_workflow(
+defend_create_response = client.defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
-print(defend_response.workflow_id)
+print(defend_create_response.workflow_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -97,16 +98,17 @@ client = AsyncDeeprails(
 
 
 async def main() -> None:
-    defend_response = await client.defend.create_workflow(
+    defend_create_response = await client.defend.create_workflow(
         improvement_action="fixit",
         name="Push Alert Workflow",
-        type="custom",
+        threshold_type="custom",
         custom_hallucination_threshold_values={
             "completeness": 0.7,
             "instruction_adherence": 0.75,
         },
+        web_search=True,
     )
-    print(defend_response.workflow_id)
+    print(defend_create_response.workflow_id)
 
 
 asyncio.run(main())
@@ -138,16 +140,17 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        defend_response = await client.defend.create_workflow(
+        defend_create_response = await client.defend.create_workflow(
             improvement_action="fixit",
             name="Push Alert Workflow",
-            type="custom",
+            threshold_type="custom",
             custom_hallucination_threshold_values={
                 "completeness": 0.7,
                 "instruction_adherence": 0.75,
             },
+            web_search=True,
         )
-        print(defend_response.workflow_id)
+        print(defend_create_response.workflow_id)
 
 
 asyncio.run(main())
@@ -181,23 +184,6 @@ workflow_event_response = client.defend.submit_event(
 print(workflow_event_response.model_input)
 ```
 
-## File uploads
-
-Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
-
-```python
-from pathlib import Path
-from deeprails import Deeprails
-
-client = Deeprails()
-
-client.files.upload(
-    file=Path("/path/to/file"),
-)
-```
-
-The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
-
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `deeprails.APIConnectionError` is raised.
@@ -217,11 +203,12 @@ try:
     client.defend.create_workflow(
         improvement_action="fixit",
         name="Push Alert Workflow",
-        type="custom",
+        threshold_type="custom",
         custom_hallucination_threshold_values={
             "completeness": 0.7,
             "instruction_adherence": 0.75,
         },
+        web_search=True,
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -268,11 +255,12 @@ client = Deeprails(
 client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
 ```
 
@@ -299,11 +287,12 @@ client = Deeprails(
 client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
 ```
 
@@ -348,11 +337,12 @@ client = Deeprails()
 response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
 print(response.headers.get('X-My-Header'))
 
@@ -374,11 +364,12 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{deeprails-1.12.0 → deeprails-1.14.0}/README.md

@@ -30,16 +30,17 @@ client = Deeprails(
     api_key=os.environ.get("DEEPRAILS_API_KEY"),  # This is the default and can be omitted
 )
 
-defend_response = client.defend.create_workflow(
+defend_create_response = client.defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
-print(defend_response.workflow_id)
+print(defend_create_response.workflow_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -62,16 +63,17 @@ client = AsyncDeeprails(
 
 
 async def main() -> None:
-    defend_response = await client.defend.create_workflow(
+    defend_create_response = await client.defend.create_workflow(
         improvement_action="fixit",
         name="Push Alert Workflow",
-        type="custom",
+        threshold_type="custom",
         custom_hallucination_threshold_values={
             "completeness": 0.7,
             "instruction_adherence": 0.75,
         },
+        web_search=True,
     )
-    print(defend_response.workflow_id)
+    print(defend_create_response.workflow_id)
 
 
 asyncio.run(main())
@@ -103,16 +105,17 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        defend_response = await client.defend.create_workflow(
+        defend_create_response = await client.defend.create_workflow(
             improvement_action="fixit",
             name="Push Alert Workflow",
-            type="custom",
+            threshold_type="custom",
             custom_hallucination_threshold_values={
                 "completeness": 0.7,
                 "instruction_adherence": 0.75,
             },
+            web_search=True,
         )
-        print(defend_response.workflow_id)
+        print(defend_create_response.workflow_id)
 
 
 asyncio.run(main())
@@ -146,23 +149,6 @@ workflow_event_response = client.defend.submit_event(
 print(workflow_event_response.model_input)
 ```
 
-## File uploads
-
-Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
-
-```python
-from pathlib import Path
-from deeprails import Deeprails
-
-client = Deeprails()
-
-client.files.upload(
-    file=Path("/path/to/file"),
-)
-```
-
-The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
-
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `deeprails.APIConnectionError` is raised.
@@ -182,11 +168,12 @@ try:
     client.defend.create_workflow(
         improvement_action="fixit",
         name="Push Alert Workflow",
-        type="custom",
+        threshold_type="custom",
         custom_hallucination_threshold_values={
             "completeness": 0.7,
             "instruction_adherence": 0.75,
         },
+        web_search=True,
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -233,11 +220,12 @@ client = Deeprails(
 client.with_options(max_retries=5).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
 ```
 
@@ -264,11 +252,12 @@ client = Deeprails(
 client.with_options(timeout=5.0).defend.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
 ```
 
@@ -313,11 +302,12 @@ client = Deeprails()
 response = client.defend.with_raw_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 )
 print(response.headers.get('X-My-Header'))
 
@@ -339,11 +329,12 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.defend.with_streaming_response.create_workflow(
     improvement_action="fixit",
     name="Push Alert Workflow",
-    type="custom",
+    threshold_type="custom",
     custom_hallucination_threshold_values={
         "completeness": 0.7,
         "instruction_adherence": 0.75,
     },
+    web_search=True,
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{deeprails-1.12.0 → deeprails-1.14.0}/api.md

@@ -3,30 +3,43 @@
 Types:
 
 ```python
-from deeprails.types import DefendResponse, WorkflowEventResponse
+from deeprails.types import (
+    DefendCreateResponse,
+    DefendResponse,
+    DefendUpdateResponse,
+    WorkflowEventDetailResponse,
+    WorkflowEventResponse,
+)
 ```
 
 Methods:
 
-- <code title="post /defend">client.defend.<a href="./src/deeprails/resources/defend.py">create_workflow</a>(\*\*<a href="src/deeprails/types/defend_create_workflow_params.py">params</a>) -> <a href="./src/deeprails/types/defend_response.py">DefendResponse</a></code>
-- <code title="get /defend/{workflow_id}/events/{event_id}">client.defend.<a href="./src/deeprails/resources/defend.py">retrieve_event</a>(event_id, \*, workflow_id) -> <a href="./src/deeprails/types/workflow_event_response.py">WorkflowEventResponse</a></code>
-- <code title="get /defend/{workflow_id}">client.defend.<a href="./src/deeprails/resources/defend.py">retrieve_workflow</a>(workflow_id) -> <a href="./src/deeprails/types/defend_response.py">DefendResponse</a></code>
+- <code title="post /defend">client.defend.<a href="./src/deeprails/resources/defend.py">create_workflow</a>(\*\*<a href="src/deeprails/types/defend_create_workflow_params.py">params</a>) -> <a href="./src/deeprails/types/defend_create_response.py">DefendCreateResponse</a></code>
+- <code title="get /defend/{workflow_id}/events/{event_id}">client.defend.<a href="./src/deeprails/resources/defend.py">retrieve_event</a>(event_id, \*, workflow_id) -> <a href="./src/deeprails/types/workflow_event_detail_response.py">WorkflowEventDetailResponse</a></code>
+- <code title="get /defend/{workflow_id}">client.defend.<a href="./src/deeprails/resources/defend.py">retrieve_workflow</a>(workflow_id, \*\*<a href="src/deeprails/types/defend_retrieve_workflow_params.py">params</a>) -> <a href="./src/deeprails/types/defend_response.py">DefendResponse</a></code>
 - <code title="post /defend/{workflow_id}/events">client.defend.<a href="./src/deeprails/resources/defend.py">submit_event</a>(workflow_id, \*\*<a href="src/deeprails/types/defend_submit_event_params.py">params</a>) -> <a href="./src/deeprails/types/workflow_event_response.py">WorkflowEventResponse</a></code>
-- <code title="put /defend/{workflow_id}">client.defend.<a href="./src/deeprails/resources/defend.py">update_workflow</a>(workflow_id, \*\*<a href="src/deeprails/types/defend_update_workflow_params.py">params</a>) -> <a href="./src/deeprails/types/defend_response.py">DefendResponse</a></code>
+- <code title="put /defend/{workflow_id}">client.defend.<a href="./src/deeprails/resources/defend.py">update_workflow</a>(workflow_id, \*\*<a href="src/deeprails/types/defend_update_workflow_params.py">params</a>) -> <a href="./src/deeprails/types/defend_update_response.py">DefendUpdateResponse</a></code>
 
 # Monitor
 
 Types:
 
 ```python
-from deeprails.types import MonitorDetailResponse, MonitorEventResponse, MonitorResponse
+from deeprails.types import (
+    MonitorCreateResponse,
+    MonitorDetailResponse,
+    MonitorEventDetailResponse,
+    MonitorEventResponse,
+    MonitorUpdateResponse,
+)
 ```
 
 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/monitor_response.py">MonitorResponse</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_create_response.py">MonitorCreateResponse</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="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_update_response.py">MonitorUpdateResponse</a></code>
+- <code title="get /monitor/{monitor_id}/events/{event_id}">client.monitor.<a href="./src/deeprails/resources/monitor.py">retrieve_event</a>(event_id, \*, monitor_id) -> <a href="./src/deeprails/types/monitor_event_detail_response.py">MonitorEventDetailResponse</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>
 
 # Files

{deeprails-1.12.0 → deeprails-1.14.0}/pyproject.toml

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

{deeprails-1.12.0 → deeprails-1.14.0}/src/deeprails/_files.py

@@ -34,7 +34,7 @@ def assert_is_file_content(obj: object, *, key: str | None = None) -> None:
     if not is_file_content(obj):
         prefix = f"Expected entry at `{key}`" if key is not None else f"Expected file input `{obj!r}`"
         raise RuntimeError(
-            f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead. See https://github.com/deeprails/deeprails-sdk-python/tree/main#file-uploads"
+            f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead."
         ) from None
 
 

{deeprails-1.12.0 → deeprails-1.14.0}/src/deeprails/_utils/_utils.py

@@ -133,7 +133,7 @@ def is_given(obj: _T | NotGiven | Omit) -> TypeGuard[_T]:
 # Type safe methods for narrowing types with TypeVars.
 # The default narrowing for isinstance(obj, dict) is dict[unknown, unknown],
 # however this cause Pyright to rightfully report errors. As we know we don't
-# care about the contained types we can safely use `object` in it's place.
+# care about the contained types we can safely use `object` in its place.
 #
 # There are two separate functions defined, `is_*` and `is_*_t` for different use cases.
 # `is_*` is for when you're dealing with an unknown input

{deeprails-1.12.0 → deeprails-1.14.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.12.0"  # x-release-please-version
+__version__ = "1.14.0"  # x-release-please-version