together 1.5.17__py3-none-any.whl → 2.0.0a8__py3-none-any.whl

together/resources/evals.py

@@ -0,0 +1,452 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import eval_list_params, eval_create_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.evaluation_job import EvaluationJob
+from ..types.eval_list_response import EvalListResponse
+from ..types.eval_create_response import EvalCreateResponse
+from ..types.eval_status_response import EvalStatusResponse
+
+__all__ = ["EvalsResource", "AsyncEvalsResource"]
+
+
+class EvalsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> EvalsResourceWithRawResponse:
+        """
+        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/togethercomputer/together-py#accessing-raw-response-data-eg-headers
+        """
+        return EvalsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> EvalsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/togethercomputer/together-py#with_streaming_response
+        """
+        return EvalsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        parameters: eval_create_params.Parameters,
+        type: Literal["classify", "score", "compare"],
+        # 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,
+    ) -> EvalCreateResponse:
+        """
+        Create an evaluation job
+
+        Args:
+          parameters: Type-specific parameters for the evaluation
+
+          type: The type of evaluation to perform
+
+          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
+        """
+        return self._post(
+            "/evaluation",
+            body=maybe_transform(
+                {
+                    "parameters": parameters,
+                    "type": type,
+                },
+                eval_create_params.EvalCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvalCreateResponse,
+        )
+
+    def retrieve(
+        self,
+        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,
+    ) -> EvaluationJob:
+        """
+        Get evaluation job details
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/evaluation/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvaluationJob,
+        )
+
+    def list(
+        self,
+        *,
+        limit: int | Omit = omit,
+        status: str | Omit = omit,
+        user_id: str | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> EvalListResponse:
+        """
+        Get all evaluation jobs
+
+        Args:
+          user_id: Admin users can specify a user ID to filter jobs. Pass empty string to get all
+              jobs.
+
+          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
+        """
+        return self._get(
+            "/evaluation",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "status": status,
+                        "user_id": user_id,
+                    },
+                    eval_list_params.EvalListParams,
+                ),
+            ),
+            cast_to=EvalListResponse,
+        )
+
+    def status(
+        self,
+        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,
+    ) -> EvalStatusResponse:
+        """
+        Get evaluation job status and results
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/evaluation/{id}/status",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvalStatusResponse,
+        )
+
+
+class AsyncEvalsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncEvalsResourceWithRawResponse:
+        """
+        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/togethercomputer/together-py#accessing-raw-response-data-eg-headers
+        """
+        return AsyncEvalsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncEvalsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/togethercomputer/together-py#with_streaming_response
+        """
+        return AsyncEvalsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        parameters: eval_create_params.Parameters,
+        type: Literal["classify", "score", "compare"],
+        # 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,
+    ) -> EvalCreateResponse:
+        """
+        Create an evaluation job
+
+        Args:
+          parameters: Type-specific parameters for the evaluation
+
+          type: The type of evaluation to perform
+
+          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
+        """
+        return await self._post(
+            "/evaluation",
+            body=await async_maybe_transform(
+                {
+                    "parameters": parameters,
+                    "type": type,
+                },
+                eval_create_params.EvalCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvalCreateResponse,
+        )
+
+    async def retrieve(
+        self,
+        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,
+    ) -> EvaluationJob:
+        """
+        Get evaluation job details
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/evaluation/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvaluationJob,
+        )
+
+    async def list(
+        self,
+        *,
+        limit: int | Omit = omit,
+        status: str | Omit = omit,
+        user_id: str | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> EvalListResponse:
+        """
+        Get all evaluation jobs
+
+        Args:
+          user_id: Admin users can specify a user ID to filter jobs. Pass empty string to get all
+              jobs.
+
+          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
+        """
+        return await self._get(
+            "/evaluation",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "limit": limit,
+                        "status": status,
+                        "user_id": user_id,
+                    },
+                    eval_list_params.EvalListParams,
+                ),
+            ),
+            cast_to=EvalListResponse,
+        )
+
+    async def status(
+        self,
+        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,
+    ) -> EvalStatusResponse:
+        """
+        Get evaluation job status and results
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/evaluation/{id}/status",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EvalStatusResponse,
+        )
+
+
+class EvalsResourceWithRawResponse:
+    def __init__(self, evals: EvalsResource) -> None:
+        self._evals = evals
+
+        self.create = to_raw_response_wrapper(
+            evals.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            evals.retrieve,
+        )
+        self.list = to_raw_response_wrapper(
+            evals.list,
+        )
+        self.status = to_raw_response_wrapper(
+            evals.status,
+        )
+
+
+class AsyncEvalsResourceWithRawResponse:
+    def __init__(self, evals: AsyncEvalsResource) -> None:
+        self._evals = evals
+
+        self.create = async_to_raw_response_wrapper(
+            evals.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            evals.retrieve,
+        )
+        self.list = async_to_raw_response_wrapper(
+            evals.list,
+        )
+        self.status = async_to_raw_response_wrapper(
+            evals.status,
+        )
+
+
+class EvalsResourceWithStreamingResponse:
+    def __init__(self, evals: EvalsResource) -> None:
+        self._evals = evals
+
+        self.create = to_streamed_response_wrapper(
+            evals.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            evals.retrieve,
+        )
+        self.list = to_streamed_response_wrapper(
+            evals.list,
+        )
+        self.status = to_streamed_response_wrapper(
+            evals.status,
+        )
+
+
+class AsyncEvalsResourceWithStreamingResponse:
+    def __init__(self, evals: AsyncEvalsResource) -> None:
+        self._evals = evals
+
+        self.create = async_to_streamed_response_wrapper(
+            evals.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            evals.retrieve,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            evals.list,
+        )
+        self.status = async_to_streamed_response_wrapper(
+            evals.status,
+        )