546 lines
21 KiB
Python
546 lines
21 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 .... import _legacy_response
|
|
from .content import (
|
|
Content,
|
|
AsyncContent,
|
|
ContentWithRawResponse,
|
|
AsyncContentWithRawResponse,
|
|
ContentWithStreamingResponse,
|
|
AsyncContentWithStreamingResponse,
|
|
)
|
|
from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, 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 to_streamed_response_wrapper, async_to_streamed_response_wrapper
|
|
from ....pagination import SyncCursorPage, AsyncCursorPage
|
|
from ...._base_client import AsyncPaginator, make_request_options
|
|
from ....types.containers import file_list_params, file_create_params
|
|
from ....types.containers.file_list_response import FileListResponse
|
|
from ....types.containers.file_create_response import FileCreateResponse
|
|
from ....types.containers.file_retrieve_response import FileRetrieveResponse
|
|
|
|
__all__ = ["Files", "AsyncFiles"]
|
|
|
|
|
|
class Files(SyncAPIResource):
|
|
@cached_property
|
|
def content(self) -> Content:
|
|
return Content(self._client)
|
|
|
|
@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/openai/openai-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/openai/openai-python#with_streaming_response
|
|
"""
|
|
return FilesWithStreamingResponse(self)
|
|
|
|
def create(
|
|
self,
|
|
container_id: str,
|
|
*,
|
|
file: FileTypes | NotGiven = NOT_GIVEN,
|
|
file_id: 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,
|
|
) -> FileCreateResponse:
|
|
"""
|
|
Create a Container File
|
|
|
|
You can send either a multipart/form-data request with the raw file content, or
|
|
a JSON request with a file ID.
|
|
|
|
Args:
|
|
file: The File object (not file name) to be uploaded.
|
|
|
|
file_id: Name of the file to create.
|
|
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
body = deepcopy_minimal(
|
|
{
|
|
"file": file,
|
|
"file_id": file_id,
|
|
}
|
|
)
|
|
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(
|
|
f"/containers/{container_id}/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 retrieve(
|
|
self,
|
|
file_id: str,
|
|
*,
|
|
container_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,
|
|
) -> FileRetrieveResponse:
|
|
"""
|
|
Retrieve Container 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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
if not file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
return self._get(
|
|
f"/containers/{container_id}/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileRetrieveResponse,
|
|
)
|
|
|
|
def list(
|
|
self,
|
|
container_id: str,
|
|
*,
|
|
after: str | NotGiven = NOT_GIVEN,
|
|
limit: int | NotGiven = NOT_GIVEN,
|
|
order: Literal["asc", "desc"] | 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,
|
|
) -> SyncCursorPage[FileListResponse]:
|
|
"""List Container files
|
|
|
|
Args:
|
|
after: A cursor for use in pagination.
|
|
|
|
`after` is an object ID that defines your place
|
|
in the list. For instance, if you make a list request and receive 100 objects,
|
|
ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
fetch the next page of the list.
|
|
|
|
limit: A limit on the number of objects to be returned. Limit can range between 1 and
|
|
100, and the default is 20.
|
|
|
|
order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
order and `desc` for descending order.
|
|
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
return self._get_api_list(
|
|
f"/containers/{container_id}/files",
|
|
page=SyncCursorPage[FileListResponse],
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"after": after,
|
|
"limit": limit,
|
|
"order": order,
|
|
},
|
|
file_list_params.FileListParams,
|
|
),
|
|
),
|
|
model=FileListResponse,
|
|
)
|
|
|
|
def delete(
|
|
self,
|
|
file_id: str,
|
|
*,
|
|
container_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,
|
|
) -> None:
|
|
"""
|
|
Delete Container 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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
if not file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
|
|
return self._delete(
|
|
f"/containers/{container_id}/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=NoneType,
|
|
)
|
|
|
|
|
|
class AsyncFiles(AsyncAPIResource):
|
|
@cached_property
|
|
def content(self) -> AsyncContent:
|
|
return AsyncContent(self._client)
|
|
|
|
@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/openai/openai-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/openai/openai-python#with_streaming_response
|
|
"""
|
|
return AsyncFilesWithStreamingResponse(self)
|
|
|
|
async def create(
|
|
self,
|
|
container_id: str,
|
|
*,
|
|
file: FileTypes | NotGiven = NOT_GIVEN,
|
|
file_id: 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,
|
|
) -> FileCreateResponse:
|
|
"""
|
|
Create a Container File
|
|
|
|
You can send either a multipart/form-data request with the raw file content, or
|
|
a JSON request with a file ID.
|
|
|
|
Args:
|
|
file: The File object (not file name) to be uploaded.
|
|
|
|
file_id: Name of the file to create.
|
|
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
body = deepcopy_minimal(
|
|
{
|
|
"file": file,
|
|
"file_id": file_id,
|
|
}
|
|
)
|
|
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(
|
|
f"/containers/{container_id}/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 retrieve(
|
|
self,
|
|
file_id: str,
|
|
*,
|
|
container_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,
|
|
) -> FileRetrieveResponse:
|
|
"""
|
|
Retrieve Container 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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
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"/containers/{container_id}/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=FileRetrieveResponse,
|
|
)
|
|
|
|
def list(
|
|
self,
|
|
container_id: str,
|
|
*,
|
|
after: str | NotGiven = NOT_GIVEN,
|
|
limit: int | NotGiven = NOT_GIVEN,
|
|
order: Literal["asc", "desc"] | 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,
|
|
) -> AsyncPaginator[FileListResponse, AsyncCursorPage[FileListResponse]]:
|
|
"""List Container files
|
|
|
|
Args:
|
|
after: A cursor for use in pagination.
|
|
|
|
`after` is an object ID that defines your place
|
|
in the list. For instance, if you make a list request and receive 100 objects,
|
|
ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
fetch the next page of the list.
|
|
|
|
limit: A limit on the number of objects to be returned. Limit can range between 1 and
|
|
100, and the default is 20.
|
|
|
|
order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
order and `desc` for descending order.
|
|
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
return self._get_api_list(
|
|
f"/containers/{container_id}/files",
|
|
page=AsyncCursorPage[FileListResponse],
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"after": after,
|
|
"limit": limit,
|
|
"order": order,
|
|
},
|
|
file_list_params.FileListParams,
|
|
),
|
|
),
|
|
model=FileListResponse,
|
|
)
|
|
|
|
async def delete(
|
|
self,
|
|
file_id: str,
|
|
*,
|
|
container_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,
|
|
) -> None:
|
|
"""
|
|
Delete Container 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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
if not file_id:
|
|
raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
|
|
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
|
|
return await self._delete(
|
|
f"/containers/{container_id}/files/{file_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=NoneType,
|
|
)
|
|
|
|
|
|
class FilesWithRawResponse:
|
|
def __init__(self, files: Files) -> None:
|
|
self._files = files
|
|
|
|
self.create = _legacy_response.to_raw_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.retrieve = _legacy_response.to_raw_response_wrapper(
|
|
files.retrieve,
|
|
)
|
|
self.list = _legacy_response.to_raw_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = _legacy_response.to_raw_response_wrapper(
|
|
files.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def content(self) -> ContentWithRawResponse:
|
|
return ContentWithRawResponse(self._files.content)
|
|
|
|
|
|
class AsyncFilesWithRawResponse:
|
|
def __init__(self, files: AsyncFiles) -> None:
|
|
self._files = files
|
|
|
|
self.create = _legacy_response.async_to_raw_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.retrieve = _legacy_response.async_to_raw_response_wrapper(
|
|
files.retrieve,
|
|
)
|
|
self.list = _legacy_response.async_to_raw_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = _legacy_response.async_to_raw_response_wrapper(
|
|
files.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def content(self) -> AsyncContentWithRawResponse:
|
|
return AsyncContentWithRawResponse(self._files.content)
|
|
|
|
|
|
class FilesWithStreamingResponse:
|
|
def __init__(self, files: Files) -> None:
|
|
self._files = files
|
|
|
|
self.create = to_streamed_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.retrieve = to_streamed_response_wrapper(
|
|
files.retrieve,
|
|
)
|
|
self.list = to_streamed_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = to_streamed_response_wrapper(
|
|
files.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def content(self) -> ContentWithStreamingResponse:
|
|
return ContentWithStreamingResponse(self._files.content)
|
|
|
|
|
|
class AsyncFilesWithStreamingResponse:
|
|
def __init__(self, files: AsyncFiles) -> None:
|
|
self._files = files
|
|
|
|
self.create = async_to_streamed_response_wrapper(
|
|
files.create,
|
|
)
|
|
self.retrieve = async_to_streamed_response_wrapper(
|
|
files.retrieve,
|
|
)
|
|
self.list = async_to_streamed_response_wrapper(
|
|
files.list,
|
|
)
|
|
self.delete = async_to_streamed_response_wrapper(
|
|
files.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def content(self) -> AsyncContentWithStreamingResponse:
|
|
return AsyncContentWithStreamingResponse(self._files.content)
|