| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282 |
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
- from __future__ import annotations
- import httpx
- from .... import _legacy_response
- 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_streamed_response_wrapper, async_to_streamed_response_wrapper
- from ...._base_client import make_request_options
- from ....types.fine_tuning.alpha import grader_run_params, grader_validate_params
- from ....types.fine_tuning.alpha.grader_run_response import GraderRunResponse
- from ....types.fine_tuning.alpha.grader_validate_response import GraderValidateResponse
- __all__ = ["Graders", "AsyncGraders"]
- class Graders(SyncAPIResource):
- @cached_property
- def with_raw_response(self) -> GradersWithRawResponse:
- """
- 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/openai/openai-python#accessing-raw-response-data-eg-headers
- """
- return GradersWithRawResponse(self)
- @cached_property
- def with_streaming_response(self) -> GradersWithStreamingResponse:
- """
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
- For more information, see https://www.github.com/openai/openai-python#with_streaming_response
- """
- return GradersWithStreamingResponse(self)
- def run(
- self,
- *,
- grader: grader_run_params.Grader,
- model_sample: str,
- item: object | 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,
- ) -> GraderRunResponse:
- """
- Run a grader.
- Args:
- grader: The grader used for the fine-tuning job.
- model_sample: The model sample to be evaluated. This value will be used to populate the
- `sample` namespace. See
- [the guide](https://platform.openai.com/docs/guides/graders) for more details.
- The `output_json` variable will be populated if the model sample is a valid JSON
- string.
- item: The dataset item provided to the grader. This will be used to populate the
- `item` namespace. See
- [the guide](https://platform.openai.com/docs/guides/graders) for more details.
- 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(
- "/fine_tuning/alpha/graders/run",
- body=maybe_transform(
- {
- "grader": grader,
- "model_sample": model_sample,
- "item": item,
- },
- grader_run_params.GraderRunParams,
- ),
- options=make_request_options(
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
- ),
- cast_to=GraderRunResponse,
- )
- def validate(
- self,
- *,
- grader: grader_validate_params.Grader,
- # 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,
- ) -> GraderValidateResponse:
- """
- Validate a grader.
- Args:
- grader: The grader used for the fine-tuning job.
- 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(
- "/fine_tuning/alpha/graders/validate",
- body=maybe_transform({"grader": grader}, grader_validate_params.GraderValidateParams),
- options=make_request_options(
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
- ),
- cast_to=GraderValidateResponse,
- )
- class AsyncGraders(AsyncAPIResource):
- @cached_property
- def with_raw_response(self) -> AsyncGradersWithRawResponse:
- """
- 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/openai/openai-python#accessing-raw-response-data-eg-headers
- """
- return AsyncGradersWithRawResponse(self)
- @cached_property
- def with_streaming_response(self) -> AsyncGradersWithStreamingResponse:
- """
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
- For more information, see https://www.github.com/openai/openai-python#with_streaming_response
- """
- return AsyncGradersWithStreamingResponse(self)
- async def run(
- self,
- *,
- grader: grader_run_params.Grader,
- model_sample: str,
- item: object | 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,
- ) -> GraderRunResponse:
- """
- Run a grader.
- Args:
- grader: The grader used for the fine-tuning job.
- model_sample: The model sample to be evaluated. This value will be used to populate the
- `sample` namespace. See
- [the guide](https://platform.openai.com/docs/guides/graders) for more details.
- The `output_json` variable will be populated if the model sample is a valid JSON
- string.
- item: The dataset item provided to the grader. This will be used to populate the
- `item` namespace. See
- [the guide](https://platform.openai.com/docs/guides/graders) for more details.
- 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(
- "/fine_tuning/alpha/graders/run",
- body=await async_maybe_transform(
- {
- "grader": grader,
- "model_sample": model_sample,
- "item": item,
- },
- grader_run_params.GraderRunParams,
- ),
- options=make_request_options(
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
- ),
- cast_to=GraderRunResponse,
- )
- async def validate(
- self,
- *,
- grader: grader_validate_params.Grader,
- # 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,
- ) -> GraderValidateResponse:
- """
- Validate a grader.
- Args:
- grader: The grader used for the fine-tuning job.
- 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(
- "/fine_tuning/alpha/graders/validate",
- body=await async_maybe_transform({"grader": grader}, grader_validate_params.GraderValidateParams),
- options=make_request_options(
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
- ),
- cast_to=GraderValidateResponse,
- )
- class GradersWithRawResponse:
- def __init__(self, graders: Graders) -> None:
- self._graders = graders
- self.run = _legacy_response.to_raw_response_wrapper(
- graders.run,
- )
- self.validate = _legacy_response.to_raw_response_wrapper(
- graders.validate,
- )
- class AsyncGradersWithRawResponse:
- def __init__(self, graders: AsyncGraders) -> None:
- self._graders = graders
- self.run = _legacy_response.async_to_raw_response_wrapper(
- graders.run,
- )
- self.validate = _legacy_response.async_to_raw_response_wrapper(
- graders.validate,
- )
- class GradersWithStreamingResponse:
- def __init__(self, graders: Graders) -> None:
- self._graders = graders
- self.run = to_streamed_response_wrapper(
- graders.run,
- )
- self.validate = to_streamed_response_wrapper(
- graders.validate,
- )
- class AsyncGradersWithStreamingResponse:
- def __init__(self, graders: AsyncGraders) -> None:
- self._graders = graders
- self.run = async_to_streamed_response_wrapper(
- graders.run,
- )
- self.validate = async_to_streamed_response_wrapper(
- graders.validate,
- )
|