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

deeprails/resources/{defend/defend.py → defend.py}

@@ -7,43 +7,32 @@ from typing_extensions import Literal
 
 import httpx
 
-from .events import (
-    EventsResource,
-    AsyncEventsResource,
-    EventsResourceWithRawResponse,
-    AsyncEventsResourceWithRawResponse,
-    EventsResourceWithStreamingResponse,
-    AsyncEventsResourceWithStreamingResponse,
-)
-from ...types import defend_create_workflow_params, defend_update_workflow_params
-from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
-from ..._utils import maybe_transform, async_maybe_transform
-from ..._compat import cached_property
-from ..._resource import SyncAPIResource, AsyncAPIResource
-from ..._response import (
+from ..types import defend_submit_event_params, defend_create_workflow_params, defend_update_workflow_params
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from .._utils import maybe_transform, async_maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
     to_raw_response_wrapper,
     to_streamed_response_wrapper,
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ..._base_client import make_request_options
-from ...types.defend_response import DefendResponse
+from .._base_client import make_request_options
+from ..types.defend_response import DefendResponse
+from ..types.workflow_event_response import WorkflowEventResponse
 
 __all__ = ["DefendResource", "AsyncDefendResource"]
 
 
 class DefendResource(SyncAPIResource):
-    @cached_property
-    def events(self) -> EventsResource:
-        return EventsResource(self._client)
-
     @cached_property
     def with_raw_response(self) -> DefendResourceWithRawResponse:
         """
         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 DefendResourceWithRawResponse(self)
 
@@ -52,7 +41,7 @@ class DefendResource(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 DefendResourceWithStreamingResponse(self)
 
@@ -74,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.
 
@@ -134,6 +123,42 @@ class DefendResource(SyncAPIResource):
             cast_to=DefendResponse,
         )
 
+    def retrieve_event(
+        self,
+        event_id: str,
+        *,
+        workflow_id: str,
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WorkflowEventResponse:
+        """
+        Use this endpoint to retrieve a specific event of a guardrail workflow
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not workflow_id:
+            raise ValueError(f"Expected a non-empty value for `workflow_id` but received {workflow_id!r}")
+        if not event_id:
+            raise ValueError(f"Expected a non-empty value for `event_id` but received {event_id!r}")
+        return self._get(
+            f"/defend/{workflow_id}/events/{event_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WorkflowEventResponse,
+        )
+
     def retrieve_workflow(
         self,
         workflow_id: str,
@@ -146,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
@@ -167,13 +192,76 @@ class DefendResource(SyncAPIResource):
             cast_to=DefendResponse,
         )
 
+    def submit_event(
+        self,
+        workflow_id: str,
+        *,
+        model_input: defend_submit_event_params.ModelInput,
+        model_output: str,
+        model_used: str,
+        nametag: str,
+        run_mode: Literal["precision_plus", "precision", "smart", "economy"],
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WorkflowEventResponse:
+        """
+        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
+              `user_prompt` field and an optional `context` field. Additional properties are
+              allowed.
+
+          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 workflow event. The run mode allows the user to optimize for
+              speed, accuracy, and cost by determining which models are used to evaluate the
+              event. Available run modes include `precision_plus`, `precision`, `smart`, and
+              `economy`. Defaults to `smart`.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not workflow_id:
+            raise ValueError(f"Expected a non-empty value for `workflow_id` but received {workflow_id!r}")
+        return self._post(
+            f"/defend/{workflow_id}/events",
+            body=maybe_transform(
+                {
+                    "model_input": model_input,
+                    "model_output": model_output,
+                    "model_used": model_used,
+                    "nametag": nametag,
+                    "run_mode": run_mode,
+                },
+                defend_submit_event_params.DefendSubmitEventParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WorkflowEventResponse,
+        )
+
     def update_workflow(
         self,
         workflow_id: str,
         *,
         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,
@@ -182,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
@@ -207,7 +293,6 @@ class DefendResource(SyncAPIResource):
                 {
                     "description": description,
                     "name": name,
-                    "type": type,
                 },
                 defend_update_workflow_params.DefendUpdateWorkflowParams,
             ),
@@ -219,17 +304,13 @@ class DefendResource(SyncAPIResource):
 
 
 class AsyncDefendResource(AsyncAPIResource):
-    @cached_property
-    def events(self) -> AsyncEventsResource:
-        return AsyncEventsResource(self._client)
-
     @cached_property
     def with_raw_response(self) -> AsyncDefendResourceWithRawResponse:
         """
         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 AsyncDefendResourceWithRawResponse(self)
 
@@ -238,7 +319,7 @@ class AsyncDefendResource(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 AsyncDefendResourceWithStreamingResponse(self)
 
@@ -260,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.
 
@@ -320,6 +401,42 @@ class AsyncDefendResource(AsyncAPIResource):
             cast_to=DefendResponse,
         )
 
+    async def retrieve_event(
+        self,
+        event_id: str,
+        *,
+        workflow_id: str,
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WorkflowEventResponse:
+        """
+        Use this endpoint to retrieve a specific event of a guardrail workflow
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not workflow_id:
+            raise ValueError(f"Expected a non-empty value for `workflow_id` but received {workflow_id!r}")
+        if not event_id:
+            raise ValueError(f"Expected a non-empty value for `event_id` but received {event_id!r}")
+        return await self._get(
+            f"/defend/{workflow_id}/events/{event_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WorkflowEventResponse,
+        )
+
     async def retrieve_workflow(
         self,
         workflow_id: str,
@@ -332,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
@@ -353,13 +470,76 @@ class AsyncDefendResource(AsyncAPIResource):
             cast_to=DefendResponse,
         )
 
+    async def submit_event(
+        self,
+        workflow_id: str,
+        *,
+        model_input: defend_submit_event_params.ModelInput,
+        model_output: str,
+        model_used: str,
+        nametag: str,
+        run_mode: Literal["precision_plus", "precision", "smart", "economy"],
+        # 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WorkflowEventResponse:
+        """
+        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
+              `user_prompt` field and an optional `context` field. Additional properties are
+              allowed.
+
+          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 workflow event. The run mode allows the user to optimize for
+              speed, accuracy, and cost by determining which models are used to evaluate the
+              event. Available run modes include `precision_plus`, `precision`, `smart`, and
+              `economy`. Defaults to `smart`.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not workflow_id:
+            raise ValueError(f"Expected a non-empty value for `workflow_id` but received {workflow_id!r}")
+        return await self._post(
+            f"/defend/{workflow_id}/events",
+            body=await async_maybe_transform(
+                {
+                    "model_input": model_input,
+                    "model_output": model_output,
+                    "model_used": model_used,
+                    "nametag": nametag,
+                    "run_mode": run_mode,
+                },
+                defend_submit_event_params.DefendSubmitEventParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WorkflowEventResponse,
+        )
+
     async def update_workflow(
         self,
         workflow_id: str,
         *,
         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,
@@ -368,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
@@ -393,7 +571,6 @@ class AsyncDefendResource(AsyncAPIResource):
                 {
                     "description": description,
                     "name": name,
-                    "type": type,
                 },
                 defend_update_workflow_params.DefendUpdateWorkflowParams,
             ),
@@ -411,17 +588,19 @@ class DefendResourceWithRawResponse:
         self.create_workflow = to_raw_response_wrapper(
             defend.create_workflow,
         )
+        self.retrieve_event = to_raw_response_wrapper(
+            defend.retrieve_event,
+        )
         self.retrieve_workflow = to_raw_response_wrapper(
             defend.retrieve_workflow,
         )
+        self.submit_event = to_raw_response_wrapper(
+            defend.submit_event,
+        )
         self.update_workflow = to_raw_response_wrapper(
             defend.update_workflow,
         )
 
-    @cached_property
-    def events(self) -> EventsResourceWithRawResponse:
-        return EventsResourceWithRawResponse(self._defend.events)
-
 
 class AsyncDefendResourceWithRawResponse:
     def __init__(self, defend: AsyncDefendResource) -> None:
@@ -430,17 +609,19 @@ class AsyncDefendResourceWithRawResponse:
         self.create_workflow = async_to_raw_response_wrapper(
             defend.create_workflow,
         )
+        self.retrieve_event = async_to_raw_response_wrapper(
+            defend.retrieve_event,
+        )
         self.retrieve_workflow = async_to_raw_response_wrapper(
             defend.retrieve_workflow,
         )
+        self.submit_event = async_to_raw_response_wrapper(
+            defend.submit_event,
+        )
         self.update_workflow = async_to_raw_response_wrapper(
             defend.update_workflow,
         )
 
-    @cached_property
-    def events(self) -> AsyncEventsResourceWithRawResponse:
-        return AsyncEventsResourceWithRawResponse(self._defend.events)
-
 
 class DefendResourceWithStreamingResponse:
     def __init__(self, defend: DefendResource) -> None:
@@ -449,17 +630,19 @@ class DefendResourceWithStreamingResponse:
         self.create_workflow = to_streamed_response_wrapper(
             defend.create_workflow,
         )
+        self.retrieve_event = to_streamed_response_wrapper(
+            defend.retrieve_event,
+        )
         self.retrieve_workflow = to_streamed_response_wrapper(
             defend.retrieve_workflow,
         )
+        self.submit_event = to_streamed_response_wrapper(
+            defend.submit_event,
+        )
         self.update_workflow = to_streamed_response_wrapper(
             defend.update_workflow,
         )
 
-    @cached_property
-    def events(self) -> EventsResourceWithStreamingResponse:
-        return EventsResourceWithStreamingResponse(self._defend.events)
-
 
 class AsyncDefendResourceWithStreamingResponse:
     def __init__(self, defend: AsyncDefendResource) -> None:
@@ -468,13 +651,15 @@ class AsyncDefendResourceWithStreamingResponse:
         self.create_workflow = async_to_streamed_response_wrapper(
             defend.create_workflow,
         )
+        self.retrieve_event = async_to_streamed_response_wrapper(
+            defend.retrieve_event,
+        )
         self.retrieve_workflow = async_to_streamed_response_wrapper(
             defend.retrieve_workflow,
         )
+        self.submit_event = async_to_streamed_response_wrapper(
+            defend.submit_event,
+        )
         self.update_workflow = async_to_streamed_response_wrapper(
             defend.update_workflow,
         )
-
-    @cached_property
-    def events(self) -> AsyncEventsResourceWithStreamingResponse:
-        return AsyncEventsResourceWithStreamingResponse(self._defend.events)

deeprails/resources/evaluate.py

@@ -31,7 +31,7 @@ class EvaluateResource(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 EvaluateResourceWithRawResponse(self)
 
@@ -40,7 +40,7 @@ class EvaluateResource(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 EvaluateResourceWithStreamingResponse(self)
 
@@ -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
@@ -162,7 +162,7 @@ class AsyncEvaluateResource(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 AsyncEvaluateResourceWithRawResponse(self)
 
@@ -171,7 +171,7 @@ class AsyncEvaluateResource(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 AsyncEvaluateResourceWithStreamingResponse(self)
 
@@ -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