Iyeoluwa Akinrinola
430 lines
16 KiB
Python
430 lines
16 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Dict, Optional
|
|
from typing_extensions import Literal
|
|
|
|
import httpx
|
|
|
|
from ..types import batch_create_params
|
|
from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
|
|
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.batch_list_response import BatchListResponse
|
|
from ..types.batch_cancel_response import BatchCancelResponse
|
|
from ..types.batch_create_response import BatchCreateResponse
|
|
from ..types.batch_retrieve_response import BatchRetrieveResponse
|
|
|
|
__all__ = ["Batches", "AsyncBatches"]
|
|
|
|
|
|
class Batches(SyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> BatchesWithRawResponse:
|
|
"""
|
|
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/groq/groq-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return BatchesWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> BatchesWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/groq/groq-python#with_streaming_response
|
|
"""
|
|
return BatchesWithStreamingResponse(self)
|
|
|
|
def create(
|
|
self,
|
|
*,
|
|
completion_window: str,
|
|
endpoint: Literal["/v1/chat/completions"],
|
|
input_file_id: str,
|
|
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
|
# 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,
|
|
) -> BatchCreateResponse:
|
|
"""
|
|
Creates and executes a batch from an uploaded file of requests.
|
|
[Learn more](/docs/batch).
|
|
|
|
Args:
|
|
completion_window: The time frame within which the batch should be processed. Durations from `24h`
|
|
to `7d` are supported.
|
|
|
|
endpoint: The endpoint to be used for all requests in the batch. Currently
|
|
`/v1/chat/completions` is supported.
|
|
|
|
input_file_id: The ID of an uploaded file that contains requests for the new batch.
|
|
|
|
See [upload file](/docs/api-reference#files-upload) for how to upload a file.
|
|
|
|
Your input file must be formatted as a [JSONL file](/docs/batch), and must be
|
|
uploaded with the purpose `batch`. The file can be up to 100 MB in size.
|
|
|
|
metadata: Optional custom metadata for the batch.
|
|
|
|
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(
|
|
"/openai/v1/batches",
|
|
body=maybe_transform(
|
|
{
|
|
"completion_window": completion_window,
|
|
"endpoint": endpoint,
|
|
"input_file_id": input_file_id,
|
|
"metadata": metadata,
|
|
},
|
|
batch_create_params.BatchCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchCreateResponse,
|
|
)
|
|
|
|
def retrieve(
|
|
self,
|
|
batch_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,
|
|
) -> BatchRetrieveResponse:
|
|
"""
|
|
Retrieves a batch.
|
|
|
|
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 batch_id:
|
|
raise ValueError(f"Expected a non-empty value for `batch_id` but received {batch_id!r}")
|
|
return self._get(
|
|
f"/openai/v1/batches/{batch_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchRetrieveResponse,
|
|
)
|
|
|
|
def list(
|
|
self,
|
|
*,
|
|
# 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,
|
|
) -> BatchListResponse:
|
|
"""List your organization's batches."""
|
|
return self._get(
|
|
"/openai/v1/batches",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchListResponse,
|
|
)
|
|
|
|
def cancel(
|
|
self,
|
|
batch_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,
|
|
) -> BatchCancelResponse:
|
|
"""
|
|
Cancels a batch.
|
|
|
|
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 batch_id:
|
|
raise ValueError(f"Expected a non-empty value for `batch_id` but received {batch_id!r}")
|
|
return self._post(
|
|
f"/openai/v1/batches/{batch_id}/cancel",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchCancelResponse,
|
|
)
|
|
|
|
|
|
class AsyncBatches(AsyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncBatchesWithRawResponse:
|
|
"""
|
|
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/groq/groq-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return AsyncBatchesWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncBatchesWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/groq/groq-python#with_streaming_response
|
|
"""
|
|
return AsyncBatchesWithStreamingResponse(self)
|
|
|
|
async def create(
|
|
self,
|
|
*,
|
|
completion_window: str,
|
|
endpoint: Literal["/v1/chat/completions"],
|
|
input_file_id: str,
|
|
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
|
# 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,
|
|
) -> BatchCreateResponse:
|
|
"""
|
|
Creates and executes a batch from an uploaded file of requests.
|
|
[Learn more](/docs/batch).
|
|
|
|
Args:
|
|
completion_window: The time frame within which the batch should be processed. Durations from `24h`
|
|
to `7d` are supported.
|
|
|
|
endpoint: The endpoint to be used for all requests in the batch. Currently
|
|
`/v1/chat/completions` is supported.
|
|
|
|
input_file_id: The ID of an uploaded file that contains requests for the new batch.
|
|
|
|
See [upload file](/docs/api-reference#files-upload) for how to upload a file.
|
|
|
|
Your input file must be formatted as a [JSONL file](/docs/batch), and must be
|
|
uploaded with the purpose `batch`. The file can be up to 100 MB in size.
|
|
|
|
metadata: Optional custom metadata for the batch.
|
|
|
|
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(
|
|
"/openai/v1/batches",
|
|
body=await async_maybe_transform(
|
|
{
|
|
"completion_window": completion_window,
|
|
"endpoint": endpoint,
|
|
"input_file_id": input_file_id,
|
|
"metadata": metadata,
|
|
},
|
|
batch_create_params.BatchCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchCreateResponse,
|
|
)
|
|
|
|
async def retrieve(
|
|
self,
|
|
batch_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,
|
|
) -> BatchRetrieveResponse:
|
|
"""
|
|
Retrieves a batch.
|
|
|
|
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 batch_id:
|
|
raise ValueError(f"Expected a non-empty value for `batch_id` but received {batch_id!r}")
|
|
return await self._get(
|
|
f"/openai/v1/batches/{batch_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchRetrieveResponse,
|
|
)
|
|
|
|
async def list(
|
|
self,
|
|
*,
|
|
# 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,
|
|
) -> BatchListResponse:
|
|
"""List your organization's batches."""
|
|
return await self._get(
|
|
"/openai/v1/batches",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchListResponse,
|
|
)
|
|
|
|
async def cancel(
|
|
self,
|
|
batch_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,
|
|
) -> BatchCancelResponse:
|
|
"""
|
|
Cancels a batch.
|
|
|
|
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 batch_id:
|
|
raise ValueError(f"Expected a non-empty value for `batch_id` but received {batch_id!r}")
|
|
return await self._post(
|
|
f"/openai/v1/batches/{batch_id}/cancel",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BatchCancelResponse,
|
|
)
|
|
|
|
|
|
class BatchesWithRawResponse:
|
|
def __init__(self, batches: Batches) -> None:
|
|
self._batches = batches
|
|
|
|
self.create = to_raw_response_wrapper(
|
|
batches.create,
|
|
)
|
|
self.retrieve = to_raw_response_wrapper(
|
|
batches.retrieve,
|
|
)
|
|
self.list = to_raw_response_wrapper(
|
|
batches.list,
|
|
)
|
|
self.cancel = to_raw_response_wrapper(
|
|
batches.cancel,
|
|
)
|
|
|
|
|
|
class AsyncBatchesWithRawResponse:
|
|
def __init__(self, batches: AsyncBatches) -> None:
|
|
self._batches = batches
|
|
|
|
self.create = async_to_raw_response_wrapper(
|
|
batches.create,
|
|
)
|
|
self.retrieve = async_to_raw_response_wrapper(
|
|
batches.retrieve,
|
|
)
|
|
self.list = async_to_raw_response_wrapper(
|
|
batches.list,
|
|
)
|
|
self.cancel = async_to_raw_response_wrapper(
|
|
batches.cancel,
|
|
)
|
|
|
|
|
|
class BatchesWithStreamingResponse:
|
|
def __init__(self, batches: Batches) -> None:
|
|
self._batches = batches
|
|
|
|
self.create = to_streamed_response_wrapper(
|
|
batches.create,
|
|
)
|
|
self.retrieve = to_streamed_response_wrapper(
|
|
batches.retrieve,
|
|
)
|
|
self.list = to_streamed_response_wrapper(
|
|
batches.list,
|
|
)
|
|
self.cancel = to_streamed_response_wrapper(
|
|
batches.cancel,
|
|
)
|
|
|
|
|
|
class AsyncBatchesWithStreamingResponse:
|
|
def __init__(self, batches: AsyncBatches) -> None:
|
|
self._batches = batches
|
|
|
|
self.create = async_to_streamed_response_wrapper(
|
|
batches.create,
|
|
)
|
|
self.retrieve = async_to_streamed_response_wrapper(
|
|
batches.retrieve,
|
|
)
|
|
self.list = async_to_streamed_response_wrapper(
|
|
batches.list,
|
|
)
|
|
self.cancel = async_to_streamed_response_wrapper(
|
|
batches.cancel,
|
|
)
|