deeprails 1.11.0__py3-none-any.whl → 1.12.0__py3-none-any.whl

deeprails/_version.py

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

deeprails/resources/monitor.py

@@ -8,7 +8,7 @@ from typing_extensions import Literal
 import httpx
 
 from ..types import monitor_create_params, monitor_update_params, monitor_retrieve_params, monitor_submit_event_params
-from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -49,8 +49,20 @@ class MonitorResource(SyncAPIResource):
     def create(
         self,
         *,
+        guardrail_metrics: List[
+            Literal[
+                "correctness",
+                "completeness",
+                "instruction_adherence",
+                "context_adherence",
+                "ground_truth_adherence",
+                "comprehensive_safety",
+            ]
+        ],
         name: str,
         description: str | Omit = omit,
+        file_search: SequenceNotStr[str] | Omit = omit,
+        web_search: bool | 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,
@@ -63,10 +75,20 @@ class MonitorResource(SyncAPIResource):
         using guardrails
 
         Args:
+          guardrail_metrics: An array of guardrail metrics that the model input and output pair will be
+              evaluated on. For non-enterprise users, these will be limited to `correctness`,
+              `completeness`, `instruction_adherence`, `context_adherence`,
+              `ground_truth_adherence`, and/or `comprehensive_safety`.
+
           name: Name of the new monitor.
 
           description: Description of the new monitor.
 
+          file_search: An array of file IDs to search in the monitor's evaluations. Files must be
+              uploaded via the DeepRails API first.
+
+          web_search: Whether to enable web search for this monitor's evaluations. Defaults to false.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -79,8 +101,11 @@ class MonitorResource(SyncAPIResource):
             "/monitor",
             body=maybe_transform(
                 {
+                    "guardrail_metrics": guardrail_metrics,
                     "name": name,
                     "description": description,
+                    "file_search": file_search,
+                    "web_search": web_search,
                 },
                 monitor_create_params.MonitorCreateParams,
             ),
@@ -187,19 +212,8 @@ class MonitorResource(SyncAPIResource):
         self,
         monitor_id: str,
         *,
-        guardrail_metrics: List[
-            Literal[
-                "correctness",
-                "completeness",
-                "instruction_adherence",
-                "context_adherence",
-                "ground_truth_adherence",
-                "comprehensive_safety",
-            ]
-        ],
         model_input: monitor_submit_event_params.ModelInput,
         model_output: str,
-        model_used: str | Omit = omit,
         nametag: str | Omit = omit,
         run_mode: Literal["precision_plus", "precision", "smart", "economy"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -214,19 +228,12 @@ class MonitorResource(SyncAPIResource):
         evaluation
 
         Args:
-          guardrail_metrics: An array of guardrail metrics that the model input and output pair will be
-              evaluated on. For non-enterprise users, these will be limited to `correctness`,
-              `completeness`, `instruction_adherence`, `context_adherence`,
-              `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` 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.
 
-          model_used: Model ID used to generate the output, like `gpt-4o` or `o3`.
-
           nametag: An optional, user-defined tag for the event.
 
           run_mode: Run mode for the monitor event. The run mode allows the user to optimize for
@@ -248,10 +255,8 @@ class MonitorResource(SyncAPIResource):
             f"/monitor/{monitor_id}/events",
             body=maybe_transform(
                 {
-                    "guardrail_metrics": guardrail_metrics,
                     "model_input": model_input,
                     "model_output": model_output,
-                    "model_used": model_used,
                     "nametag": nametag,
                     "run_mode": run_mode,
                 },
@@ -287,8 +292,20 @@ class AsyncMonitorResource(AsyncAPIResource):
     async def create(
         self,
         *,
+        guardrail_metrics: List[
+            Literal[
+                "correctness",
+                "completeness",
+                "instruction_adherence",
+                "context_adherence",
+                "ground_truth_adherence",
+                "comprehensive_safety",
+            ]
+        ],
         name: str,
         description: str | Omit = omit,
+        file_search: SequenceNotStr[str] | Omit = omit,
+        web_search: bool | 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,
@@ -301,10 +318,20 @@ class AsyncMonitorResource(AsyncAPIResource):
         using guardrails
 
         Args:
+          guardrail_metrics: An array of guardrail metrics that the model input and output pair will be
+              evaluated on. For non-enterprise users, these will be limited to `correctness`,
+              `completeness`, `instruction_adherence`, `context_adherence`,
+              `ground_truth_adherence`, and/or `comprehensive_safety`.
+
           name: Name of the new monitor.
 
           description: Description of the new monitor.
 
+          file_search: An array of file IDs to search in the monitor's evaluations. Files must be
+              uploaded via the DeepRails API first.
+
+          web_search: Whether to enable web search for this monitor's evaluations. Defaults to false.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -317,8 +344,11 @@ class AsyncMonitorResource(AsyncAPIResource):
             "/monitor",
             body=await async_maybe_transform(
                 {
+                    "guardrail_metrics": guardrail_metrics,
                     "name": name,
                     "description": description,
+                    "file_search": file_search,
+                    "web_search": web_search,
                 },
                 monitor_create_params.MonitorCreateParams,
             ),
@@ -425,19 +455,8 @@ class AsyncMonitorResource(AsyncAPIResource):
         self,
         monitor_id: str,
         *,
-        guardrail_metrics: List[
-            Literal[
-                "correctness",
-                "completeness",
-                "instruction_adherence",
-                "context_adherence",
-                "ground_truth_adherence",
-                "comprehensive_safety",
-            ]
-        ],
         model_input: monitor_submit_event_params.ModelInput,
         model_output: str,
-        model_used: str | Omit = omit,
         nametag: str | Omit = omit,
         run_mode: Literal["precision_plus", "precision", "smart", "economy"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -452,19 +471,12 @@ class AsyncMonitorResource(AsyncAPIResource):
         evaluation
 
         Args:
-          guardrail_metrics: An array of guardrail metrics that the model input and output pair will be
-              evaluated on. For non-enterprise users, these will be limited to `correctness`,
-              `completeness`, `instruction_adherence`, `context_adherence`,
-              `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` 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.
 
-          model_used: Model ID used to generate the output, like `gpt-4o` or `o3`.
-
           nametag: An optional, user-defined tag for the event.
 
           run_mode: Run mode for the monitor event. The run mode allows the user to optimize for
@@ -486,10 +498,8 @@ class AsyncMonitorResource(AsyncAPIResource):
             f"/monitor/{monitor_id}/events",
             body=await async_maybe_transform(
                 {
-                    "guardrail_metrics": guardrail_metrics,
                     "model_input": model_input,
                     "model_output": model_output,
-                    "model_used": model_used,
                     "nametag": nametag,
                     "run_mode": run_mode,
                 },

deeprails/types/monitor_create_params.py

@@ -2,14 +2,45 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
 
 __all__ = ["MonitorCreateParams"]
 
 
 class MonitorCreateParams(TypedDict, total=False):
+    guardrail_metrics: Required[
+        List[
+            Literal[
+                "correctness",
+                "completeness",
+                "instruction_adherence",
+                "context_adherence",
+                "ground_truth_adherence",
+                "comprehensive_safety",
+            ]
+        ]
+    ]
+    """
+    An array of guardrail metrics that the model input and output pair will be
+    evaluated on. For non-enterprise users, these will be limited to `correctness`,
+    `completeness`, `instruction_adherence`, `context_adherence`,
+    `ground_truth_adherence`, and/or `comprehensive_safety`.
+    """
+
     name: Required[str]
     """Name of the new monitor."""
 
     description: str
     """Description of the new monitor."""
+
+    file_search: SequenceNotStr[str]
+    """An array of file IDs to search in the monitor's evaluations.
+
+    Files must be uploaded via the DeepRails API first.
+    """
+
+    web_search: bool
+    """Whether to enable web search for this monitor's evaluations. Defaults to false."""

deeprails/types/monitor_submit_event_params.py

@@ -2,32 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["MonitorSubmitEventParams", "ModelInput"]
 
 
 class MonitorSubmitEventParams(TypedDict, total=False):
-    guardrail_metrics: Required[
-        List[
-            Literal[
-                "correctness",
-                "completeness",
-                "instruction_adherence",
-                "context_adherence",
-                "ground_truth_adherence",
-                "comprehensive_safety",
-            ]
-        ]
-    ]
-    """
-    An array of guardrail metrics that the model input and output pair will be
-    evaluated on. For non-enterprise users, these will be limited to `correctness`,
-    `completeness`, `instruction_adherence`, `context_adherence`,
-    `ground_truth_adherence`, and/or `comprehensive_safety`.
-    """
-
     model_input: Required[ModelInput]
     """A dictionary of inputs sent to the LLM to generate output.
 
@@ -39,9 +19,6 @@ class MonitorSubmitEventParams(TypedDict, total=False):
     model_output: Required[str]
     """Output generated by the LLM to be evaluated."""
 
-    model_used: str
-    """Model ID used to generate the output, like `gpt-4o` or `o3`."""
-
     nametag: str
     """An optional, user-defined tag for the event."""
 

{deeprails-1.11.0.dist-info → deeprails-1.12.0.dist-info}/METADATA

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

{deeprails-1.11.0.dist-info → deeprails-1.12.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ deeprails/_resource.py,sha256=7RXX5KZr4j0TIE66vnduHp7p9Yf9X0FyDDECuvRHARg,1118
 deeprails/_response.py,sha256=yj0HJDU91WPpiczwi6CBOLAl_bqf4I_I96vWMAwx6Fg,28806
 deeprails/_streaming.py,sha256=Q6e6KLMPe7Pe4AWnbiC5pDrbRRIaNUh0svOWpWXLheY,10161
 deeprails/_types.py,sha256=XR3mad9NsGqZsjrd1VVJ657-4O4kwyw9Qzg4M3i6Vh0,7239
-deeprails/_version.py,sha256=MVUgG9bx7Py0Ffm0juLvfcP6YoqkSRWecRGjY0XWMLk,162
+deeprails/_version.py,sha256=Lu9BU95-FlOx4Vp5TnTzo6mRfvfmbANoTKPP3Y24uck,162
 deeprails/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 deeprails/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 deeprails/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
@@ -29,7 +29,7 @@ deeprails/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 deeprails/resources/__init__.py,sha256=VyIb1MX_ovlwJo6XAW_ZN9Ib0Ea-Oapbs5Hfwx0o_IY,1452
 deeprails/resources/defend.py,sha256=Ztcn4OEw8GIhlXx1QHIzIdnNP2obeIhmeEmvNyVza2g,29094
 deeprails/resources/files.py,sha256=zHtuxEm-t9MMdbH7gQcDQat3qXPh1ABWDmqxrUY2a8k,6903
-deeprails/resources/monitor.py,sha256=bW7HCn8lDpWqaPd11J_tVnGSduWTX3sfXlDYYycvk8k,22524
+deeprails/resources/monitor.py,sha256=4X6c4yPJ4ZZZXd2ViTdHpa5cCXrbd6Mg34Riz2SYerM,23090
 deeprails/types/__init__.py,sha256=h4_LUTZM98zsmfk3ziFmihgjQO_DI41gbgx2xVOGy78,1249
 deeprails/types/defend_create_workflow_params.py,sha256=gVK6ORTsvo3ur4Inyq6dU0rN7F9RyNnm4SFfQyyO5ZU,2434
 deeprails/types/defend_response.py,sha256=VoePIT9RKN795y-3ZvoFmzSTCetqkZZh6iQLYjJEFoY,1603
@@ -37,15 +37,15 @@ deeprails/types/defend_submit_event_params.py,sha256=yL_rLUGKlZjXHGbdi8h9ZItb4sI
 deeprails/types/defend_update_workflow_params.py,sha256=QH2k7EDMLub3mW1lPV5SUoKDHW_T2arSo-RGHLterwo,373
 deeprails/types/file_response.py,sha256=8RAkrlfgt9d27ryd4qMf6gHi_gTsD3LhDen2MtxYZ-I,656
 deeprails/types/file_upload_params.py,sha256=64xHtKiy39dFANWYBWeqK5eeOJV-zxJejwNjXY7kW8E,363
-deeprails/types/monitor_create_params.py,sha256=kTSj-PhuzpT-HPDTQJemRWfd8w32foUMH9FQZj8symk,384
+deeprails/types/monitor_create_params.py,sha256=uU_wqGLAo9B4r-nFZw_UG5YbUF0hxIJf0_P5HqpOIw8,1365
 deeprails/types/monitor_detail_response.py,sha256=s8dzFFaU9uI-GHCfUxCN9yLhpmq4LTu7CSww9z0SLvk,5028
 deeprails/types/monitor_event_response.py,sha256=-cnugHD_3QeeZRMbo6aQBirqSPgKIKpaD2qNkgxCeCA,565
 deeprails/types/monitor_response.py,sha256=LjnJVYniee1hgvZu8RT-9jX4xd0Ob_yvq4NBOxVn59c,950
 deeprails/types/monitor_retrieve_params.py,sha256=PEsRmbd-81z4pJvhfi4JbrQWNzmeiLkoNsTUoPZ6kFY,352
-deeprails/types/monitor_submit_event_params.py,sha256=YetTV8HzmDGNnSYoKZp8tv3u9L6oYn4tnvWOppTRfOQ,2164
+deeprails/types/monitor_submit_event_params.py,sha256=D6ecLaN7y4Y3q7PI2qplXpItXN5dmrasjrdTumjLnHc,1420
 deeprails/types/monitor_update_params.py,sha256=gJyFFxT_u_iWABknuKnLpPl9r-VPfCcGtOAmh6sPwUw,550
 deeprails/types/workflow_event_response.py,sha256=mIzOCnYJg4TDSq_tG_0WfA0_Gmc9-0q-befyookfUFM,867
-deeprails-1.11.0.dist-info/METADATA,sha256=JIwVEgKfcNHRhP0uahL0dAfUUvaXdLqraXNPs1prlAE,12660
-deeprails-1.11.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-deeprails-1.11.0.dist-info/licenses/LICENSE,sha256=rFTxPcYE516UQLju2SCY1r2pSDDfodL0-ZvxF_fgueg,11339
-deeprails-1.11.0.dist-info/RECORD,,
+deeprails-1.12.0.dist-info/METADATA,sha256=iR51Ti99Htf03ehr-ygjOzattoN9tc2dKw78QSbiV1A,12660
+deeprails-1.12.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+deeprails-1.12.0.dist-info/licenses/LICENSE,sha256=rFTxPcYE516UQLju2SCY1r2pSDDfodL0-ZvxF_fgueg,11339
+deeprails-1.12.0.dist-info/RECORD,,