Iyeoluwa Akinrinola
514 lines
19 KiB
Python
514 lines
19 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Mapping, cast
|
|
from typing_extensions import Literal
|
|
|
|
import httpx
|
|
|
|
from ..types import file_create_params
|
|
from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, FileTypes
|
|
from .._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
|
|
from .._compat import cached_property
|
|
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
from .._response import (
|
|
BinaryAPIResponse,
|
|
AsyncBinaryAPIResponse,
|
|
StreamedBinaryAPIResponse,
|
|
AsyncStreamedBinaryAPIResponse,
|
|
to_raw_response_wrapper,
|
|
to_streamed_response_wrapper,
|
|
async_to_raw_response_wrapper,
|
|
to_custom_raw_response_wrapper,
|
|
async_to_streamed_response_wrapper,
|
|
to_custom_streamed_response_wrapper,
|
|
async_to_custom_raw_response_wrapper,
|
|
async_to_custom_streamed_response_wrapper,
|
|
)
|
|
from .._base_client import make_request_options
|
|
from ..types.file_info_response import FileInfoResponse
|
|
from ..types.file_list_response import FileListResponse
|
|
from ..types.file_create_response import FileCreateResponse
|
|
from ..types.file_delete_response import FileDeleteResponse
|
|
|
|
__all__ = ["Files", "AsyncFiles"]
|
|
|
|
|
|
class Files(SyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> FilesWithRawResponse:
|
|
"""
|
|
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 FilesWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> FilesWithStreamingResponse:
|
|
"""
|
|
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 FilesWithStreamingResponse(self)
|
|
|
|
def create(
|
|
self,
|
|
*,
|
|
file: FileTypes,
|
|
purpose: Literal["batch"],
|
|
# 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,
|
|
) -> FileCreateResponse:
|
|
"""
|
|
Upload a file that can be used across various endpoints.
|
|
|
|
The Batch API only supports `.jsonl` files up to 100 MB in size. The input also
|
|
has a specific required [format](/docs/batch).
|
|
|
|
Please contact us if you need to increase these storage limits.
|
|
|
|
Args:
|
|
file: The File object (not file name) to be uploaded.
|
|
|
|
purpose: The intended purpose of the uploaded file. Use "batch" for
|
|
[Batch API](/docs/api-reference#batches).
|
|
|
|
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
|
|
"""
|
|
body = deepcopy_minimal(
|
|
{
|
|
"file": file,
|
|
"purpose": purpose,
|
|
}
|
|
)
|
|
files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
|
|
# It should be noted that the actual Content-Type header that will be
|
|
# sent to the server will contain a `boundary` parameter, e.g.
|
|
# multipart/form-data; boundary=---abc--
|
|
extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
|
|
return self._post(
|
|
"/openai/v1/files",
|
|
body=maybe_transform(body, file_create_params.FileCreateParams),
|
|
files=files,
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileCreateResponse,
|
|
)
|
|
|
|
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,
|
|
) -> FileListResponse:
|
|
"""Returns a list of files."""
|
|
return self._get(
|
|
"/openai/v1/files",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileListResponse,
|
|
)
|
|
|
|
def delete(
|
|
self,
|
|
file_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,
|
|
) -> FileDeleteResponse:
|
|
"""
|
|
Delete a file.
|
|
|
|
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 file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
return self._delete(
|
|
f"/openai/v1/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileDeleteResponse,
|
|
)
|
|
|
|
def content(
|
|
self,
|
|
file_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,
|
|
) -> BinaryAPIResponse:
|
|
"""
|
|
Returns the contents of the specified file.
|
|
|
|
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 file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
extra_headers = {"Accept": "application/octet-stream", **(extra_headers or {})}
|
|
return self._get(
|
|
f"/openai/v1/files/{file_id}/content",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BinaryAPIResponse,
|
|
)
|
|
|
|
def info(
|
|
self,
|
|
file_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,
|
|
) -> FileInfoResponse:
|
|
"""
|
|
Returns information about a file.
|
|
|
|
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 file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
return self._get(
|
|
f"/openai/v1/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileInfoResponse,
|
|
)
|
|
|
|
|
|
class AsyncFiles(AsyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncFilesWithRawResponse:
|
|
"""
|
|
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 AsyncFilesWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncFilesWithStreamingResponse:
|
|
"""
|
|
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 AsyncFilesWithStreamingResponse(self)
|
|
|
|
async def create(
|
|
self,
|
|
*,
|
|
file: FileTypes,
|
|
purpose: Literal["batch"],
|
|
# 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,
|
|
) -> FileCreateResponse:
|
|
"""
|
|
Upload a file that can be used across various endpoints.
|
|
|
|
The Batch API only supports `.jsonl` files up to 100 MB in size. The input also
|
|
has a specific required [format](/docs/batch).
|
|
|
|
Please contact us if you need to increase these storage limits.
|
|
|
|
Args:
|
|
file: The File object (not file name) to be uploaded.
|
|
|
|
purpose: The intended purpose of the uploaded file. Use "batch" for
|
|
[Batch API](/docs/api-reference#batches).
|
|
|
|
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
|
|
"""
|
|
body = deepcopy_minimal(
|
|
{
|
|
"file": file,
|
|
"purpose": purpose,
|
|
}
|
|
)
|
|
files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
|
|
# It should be noted that the actual Content-Type header that will be
|
|
# sent to the server will contain a `boundary` parameter, e.g.
|
|
# multipart/form-data; boundary=---abc--
|
|
extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
|
|
return await self._post(
|
|
"/openai/v1/files",
|
|
body=await async_maybe_transform(body, file_create_params.FileCreateParams),
|
|
files=files,
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileCreateResponse,
|
|
)
|
|
|
|
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,
|
|
) -> FileListResponse:
|
|
"""Returns a list of files."""
|
|
return await self._get(
|
|
"/openai/v1/files",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileListResponse,
|
|
)
|
|
|
|
async def delete(
|
|
self,
|
|
file_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,
|
|
) -> FileDeleteResponse:
|
|
"""
|
|
Delete a file.
|
|
|
|
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 file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
return await self._delete(
|
|
f"/openai/v1/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileDeleteResponse,
|
|
)
|
|
|
|
async def content(
|
|
self,
|
|
file_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,
|
|
) -> AsyncBinaryAPIResponse:
|
|
"""
|
|
Returns the contents of the specified file.
|
|
|
|
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 file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
extra_headers = {"Accept": "application/octet-stream", **(extra_headers or {})}
|
|
return await self._get(
|
|
f"/openai/v1/files/{file_id}/content",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=AsyncBinaryAPIResponse,
|
|
)
|
|
|
|
async def info(
|
|
self,
|
|
file_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,
|
|
) -> FileInfoResponse:
|
|
"""
|
|
Returns information about a file.
|
|
|
|
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 file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
return await self._get(
|
|
f"/openai/v1/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileInfoResponse,
|
|
)
|
|
|
|
|
|
class FilesWithRawResponse:
|
|
def __init__(self, files: Files) -> None:
|
|
self._files = files
|
|
|
|
self.create = to_raw_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.list = to_raw_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = to_raw_response_wrapper(
|
|
files.delete,
|
|
)
|
|
self.content = to_custom_raw_response_wrapper(
|
|
files.content,
|
|
BinaryAPIResponse,
|
|
)
|
|
self.info = to_raw_response_wrapper(
|
|
files.info,
|
|
)
|
|
|
|
|
|
class AsyncFilesWithRawResponse:
|
|
def __init__(self, files: AsyncFiles) -> None:
|
|
self._files = files
|
|
|
|
self.create = async_to_raw_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.list = async_to_raw_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = async_to_raw_response_wrapper(
|
|
files.delete,
|
|
)
|
|
self.content = async_to_custom_raw_response_wrapper(
|
|
files.content,
|
|
AsyncBinaryAPIResponse,
|
|
)
|
|
self.info = async_to_raw_response_wrapper(
|
|
files.info,
|
|
)
|
|
|
|
|
|
class FilesWithStreamingResponse:
|
|
def __init__(self, files: Files) -> None:
|
|
self._files = files
|
|
|
|
self.create = to_streamed_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.list = to_streamed_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = to_streamed_response_wrapper(
|
|
files.delete,
|
|
)
|
|
self.content = to_custom_streamed_response_wrapper(
|
|
files.content,
|
|
StreamedBinaryAPIResponse,
|
|
)
|
|
self.info = to_streamed_response_wrapper(
|
|
files.info,
|
|
)
|
|
|
|
|
|
class AsyncFilesWithStreamingResponse:
|
|
def __init__(self, files: AsyncFiles) -> None:
|
|
self._files = files
|
|
|
|
self.create = async_to_streamed_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.list = async_to_streamed_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = async_to_streamed_response_wrapper(
|
|
files.delete,
|
|
)
|
|
self.content = async_to_custom_streamed_response_wrapper(
|
|
files.content,
|
|
AsyncStreamedBinaryAPIResponse,
|
|
)
|
|
self.info = async_to_streamed_response_wrapper(
|
|
files.info,
|
|
)
|