| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545 |
- # 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 Body, Omit, Query, Headers, NoneType, NotGiven, FileTypes, omit, not_given
- 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 | Omit = omit,
- file_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,
- ) -> 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 | Omit = omit,
- limit: int | Omit = omit,
- order: Literal["asc", "desc"] | 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,
- ) -> 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 | Omit = omit,
- file_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,
- ) -> 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 | Omit = omit,
- limit: int | Omit = omit,
- order: Literal["asc", "desc"] | 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,
- ) -> 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)
|