584 lines
24 KiB
Python
584 lines
24 KiB
Python
|
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
||
|
|
|
||
|
|
from __future__ import annotations
|
||
|
|
|
||
|
|
from typing import Union, Mapping, Optional, cast
|
||
|
|
from typing_extensions import Literal
|
||
|
|
|
||
|
|
import httpx
|
||
|
|
|
||
|
|
from .. import _legacy_response
|
||
|
|
from ..types import image_edit_params, image_generate_params, image_create_variation_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 to_streamed_response_wrapper, async_to_streamed_response_wrapper
|
||
|
|
from .._base_client import (
|
||
|
|
make_request_options,
|
||
|
|
)
|
||
|
|
from ..types.images_response import ImagesResponse
|
||
|
|
|
||
|
|
__all__ = ["Images", "AsyncImages"]
|
||
|
|
|
||
|
|
|
||
|
|
class Images(SyncAPIResource):
|
||
|
|
@cached_property
|
||
|
|
def with_raw_response(self) -> ImagesWithRawResponse:
|
||
|
|
return ImagesWithRawResponse(self)
|
||
|
|
|
||
|
|
@cached_property
|
||
|
|
def with_streaming_response(self) -> ImagesWithStreamingResponse:
|
||
|
|
return ImagesWithStreamingResponse(self)
|
||
|
|
|
||
|
|
def create_variation(
|
||
|
|
self,
|
||
|
|
*,
|
||
|
|
image: FileTypes,
|
||
|
|
model: Union[str, Literal["dall-e-2"], None] | NotGiven = NOT_GIVEN,
|
||
|
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
||
|
|
response_format: Optional[Literal["url", "b64_json"]] | NotGiven = NOT_GIVEN,
|
||
|
|
size: Optional[Literal["256x256", "512x512", "1024x1024"]] | NotGiven = NOT_GIVEN,
|
||
|
|
user: 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,
|
||
|
|
) -> ImagesResponse:
|
||
|
|
"""
|
||
|
|
Creates a variation of a given image.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
image: The image to use as the basis for the variation(s). Must be a valid PNG file,
|
||
|
|
less than 4MB, and square.
|
||
|
|
|
||
|
|
model: The model to use for image generation. Only `dall-e-2` is supported at this
|
||
|
|
time.
|
||
|
|
|
||
|
|
n: The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
|
||
|
|
`n=1` is supported.
|
||
|
|
|
||
|
|
response_format: The format in which the generated images are returned. Must be one of `url` or
|
||
|
|
`b64_json`. URLs are only valid for 60 minutes after the image has been
|
||
|
|
generated.
|
||
|
|
|
||
|
|
size: The size of the generated images. Must be one of `256x256`, `512x512`, or
|
||
|
|
`1024x1024`.
|
||
|
|
|
||
|
|
user: A unique identifier representing your end-user, which can help OpenAI to monitor
|
||
|
|
and detect abuse.
|
||
|
|
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
|
||
|
|
|
||
|
|
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(
|
||
|
|
{
|
||
|
|
"image": image,
|
||
|
|
"model": model,
|
||
|
|
"n": n,
|
||
|
|
"response_format": response_format,
|
||
|
|
"size": size,
|
||
|
|
"user": user,
|
||
|
|
}
|
||
|
|
)
|
||
|
|
files = extract_files(cast(Mapping[str, object], body), paths=[["image"]])
|
||
|
|
if files:
|
||
|
|
# 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(
|
||
|
|
"/images/variations",
|
||
|
|
body=maybe_transform(body, image_create_variation_params.ImageCreateVariationParams),
|
||
|
|
files=files,
|
||
|
|
options=make_request_options(
|
||
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
|
),
|
||
|
|
cast_to=ImagesResponse,
|
||
|
|
)
|
||
|
|
|
||
|
|
def edit(
|
||
|
|
self,
|
||
|
|
*,
|
||
|
|
image: FileTypes,
|
||
|
|
prompt: str,
|
||
|
|
mask: FileTypes | NotGiven = NOT_GIVEN,
|
||
|
|
model: Union[str, Literal["dall-e-2"], None] | NotGiven = NOT_GIVEN,
|
||
|
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
||
|
|
response_format: Optional[Literal["url", "b64_json"]] | NotGiven = NOT_GIVEN,
|
||
|
|
size: Optional[Literal["256x256", "512x512", "1024x1024"]] | NotGiven = NOT_GIVEN,
|
||
|
|
user: 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,
|
||
|
|
) -> ImagesResponse:
|
||
|
|
"""
|
||
|
|
Creates an edited or extended image given an original image and a prompt.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
image: The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask
|
||
|
|
is not provided, image must have transparency, which will be used as the mask.
|
||
|
|
|
||
|
|
prompt: A text description of the desired image(s). The maximum length is 1000
|
||
|
|
characters.
|
||
|
|
|
||
|
|
mask: An additional image whose fully transparent areas (e.g. where alpha is zero)
|
||
|
|
indicate where `image` should be edited. Must be a valid PNG file, less than
|
||
|
|
4MB, and have the same dimensions as `image`.
|
||
|
|
|
||
|
|
model: The model to use for image generation. Only `dall-e-2` is supported at this
|
||
|
|
time.
|
||
|
|
|
||
|
|
n: The number of images to generate. Must be between 1 and 10.
|
||
|
|
|
||
|
|
response_format: The format in which the generated images are returned. Must be one of `url` or
|
||
|
|
`b64_json`. URLs are only valid for 60 minutes after the image has been
|
||
|
|
generated.
|
||
|
|
|
||
|
|
size: The size of the generated images. Must be one of `256x256`, `512x512`, or
|
||
|
|
`1024x1024`.
|
||
|
|
|
||
|
|
user: A unique identifier representing your end-user, which can help OpenAI to monitor
|
||
|
|
and detect abuse.
|
||
|
|
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
|
||
|
|
|
||
|
|
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(
|
||
|
|
{
|
||
|
|
"image": image,
|
||
|
|
"prompt": prompt,
|
||
|
|
"mask": mask,
|
||
|
|
"model": model,
|
||
|
|
"n": n,
|
||
|
|
"response_format": response_format,
|
||
|
|
"size": size,
|
||
|
|
"user": user,
|
||
|
|
}
|
||
|
|
)
|
||
|
|
files = extract_files(cast(Mapping[str, object], body), paths=[["image"], ["mask"]])
|
||
|
|
if files:
|
||
|
|
# 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(
|
||
|
|
"/images/edits",
|
||
|
|
body=maybe_transform(body, image_edit_params.ImageEditParams),
|
||
|
|
files=files,
|
||
|
|
options=make_request_options(
|
||
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
|
),
|
||
|
|
cast_to=ImagesResponse,
|
||
|
|
)
|
||
|
|
|
||
|
|
def generate(
|
||
|
|
self,
|
||
|
|
*,
|
||
|
|
prompt: str,
|
||
|
|
model: Union[str, Literal["dall-e-2", "dall-e-3"], None] | NotGiven = NOT_GIVEN,
|
||
|
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
||
|
|
quality: Literal["standard", "hd"] | NotGiven = NOT_GIVEN,
|
||
|
|
response_format: Optional[Literal["url", "b64_json"]] | NotGiven = NOT_GIVEN,
|
||
|
|
size: Optional[Literal["256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"]] | NotGiven = NOT_GIVEN,
|
||
|
|
style: Optional[Literal["vivid", "natural"]] | NotGiven = NOT_GIVEN,
|
||
|
|
user: 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,
|
||
|
|
) -> ImagesResponse:
|
||
|
|
"""
|
||
|
|
Creates an image given a prompt.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
prompt: A text description of the desired image(s). The maximum length is 1000
|
||
|
|
characters for `dall-e-2` and 4000 characters for `dall-e-3`.
|
||
|
|
|
||
|
|
model: The model to use for image generation.
|
||
|
|
|
||
|
|
n: The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
|
||
|
|
`n=1` is supported.
|
||
|
|
|
||
|
|
quality: The quality of the image that will be generated. `hd` creates images with finer
|
||
|
|
details and greater consistency across the image. This param is only supported
|
||
|
|
for `dall-e-3`.
|
||
|
|
|
||
|
|
response_format: The format in which the generated images are returned. Must be one of `url` or
|
||
|
|
`b64_json`. URLs are only valid for 60 minutes after the image has been
|
||
|
|
generated.
|
||
|
|
|
||
|
|
size: The size of the generated images. Must be one of `256x256`, `512x512`, or
|
||
|
|
`1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or
|
||
|
|
`1024x1792` for `dall-e-3` models.
|
||
|
|
|
||
|
|
style: The style of the generated images. Must be one of `vivid` or `natural`. Vivid
|
||
|
|
causes the model to lean towards generating hyper-real and dramatic images.
|
||
|
|
Natural causes the model to produce more natural, less hyper-real looking
|
||
|
|
images. This param is only supported for `dall-e-3`.
|
||
|
|
|
||
|
|
user: A unique identifier representing your end-user, which can help OpenAI to monitor
|
||
|
|
and detect abuse.
|
||
|
|
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
|
||
|
|
|
||
|
|
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(
|
||
|
|
"/images/generations",
|
||
|
|
body=maybe_transform(
|
||
|
|
{
|
||
|
|
"prompt": prompt,
|
||
|
|
"model": model,
|
||
|
|
"n": n,
|
||
|
|
"quality": quality,
|
||
|
|
"response_format": response_format,
|
||
|
|
"size": size,
|
||
|
|
"style": style,
|
||
|
|
"user": user,
|
||
|
|
},
|
||
|
|
image_generate_params.ImageGenerateParams,
|
||
|
|
),
|
||
|
|
options=make_request_options(
|
||
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
|
),
|
||
|
|
cast_to=ImagesResponse,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class AsyncImages(AsyncAPIResource):
|
||
|
|
@cached_property
|
||
|
|
def with_raw_response(self) -> AsyncImagesWithRawResponse:
|
||
|
|
return AsyncImagesWithRawResponse(self)
|
||
|
|
|
||
|
|
@cached_property
|
||
|
|
def with_streaming_response(self) -> AsyncImagesWithStreamingResponse:
|
||
|
|
return AsyncImagesWithStreamingResponse(self)
|
||
|
|
|
||
|
|
async def create_variation(
|
||
|
|
self,
|
||
|
|
*,
|
||
|
|
image: FileTypes,
|
||
|
|
model: Union[str, Literal["dall-e-2"], None] | NotGiven = NOT_GIVEN,
|
||
|
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
||
|
|
response_format: Optional[Literal["url", "b64_json"]] | NotGiven = NOT_GIVEN,
|
||
|
|
size: Optional[Literal["256x256", "512x512", "1024x1024"]] | NotGiven = NOT_GIVEN,
|
||
|
|
user: 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,
|
||
|
|
) -> ImagesResponse:
|
||
|
|
"""
|
||
|
|
Creates a variation of a given image.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
image: The image to use as the basis for the variation(s). Must be a valid PNG file,
|
||
|
|
less than 4MB, and square.
|
||
|
|
|
||
|
|
model: The model to use for image generation. Only `dall-e-2` is supported at this
|
||
|
|
time.
|
||
|
|
|
||
|
|
n: The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
|
||
|
|
`n=1` is supported.
|
||
|
|
|
||
|
|
response_format: The format in which the generated images are returned. Must be one of `url` or
|
||
|
|
`b64_json`. URLs are only valid for 60 minutes after the image has been
|
||
|
|
generated.
|
||
|
|
|
||
|
|
size: The size of the generated images. Must be one of `256x256`, `512x512`, or
|
||
|
|
`1024x1024`.
|
||
|
|
|
||
|
|
user: A unique identifier representing your end-user, which can help OpenAI to monitor
|
||
|
|
and detect abuse.
|
||
|
|
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
|
||
|
|
|
||
|
|
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(
|
||
|
|
{
|
||
|
|
"image": image,
|
||
|
|
"model": model,
|
||
|
|
"n": n,
|
||
|
|
"response_format": response_format,
|
||
|
|
"size": size,
|
||
|
|
"user": user,
|
||
|
|
}
|
||
|
|
)
|
||
|
|
files = extract_files(cast(Mapping[str, object], body), paths=[["image"]])
|
||
|
|
if files:
|
||
|
|
# 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(
|
||
|
|
"/images/variations",
|
||
|
|
body=await async_maybe_transform(body, image_create_variation_params.ImageCreateVariationParams),
|
||
|
|
files=files,
|
||
|
|
options=make_request_options(
|
||
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
|
),
|
||
|
|
cast_to=ImagesResponse,
|
||
|
|
)
|
||
|
|
|
||
|
|
async def edit(
|
||
|
|
self,
|
||
|
|
*,
|
||
|
|
image: FileTypes,
|
||
|
|
prompt: str,
|
||
|
|
mask: FileTypes | NotGiven = NOT_GIVEN,
|
||
|
|
model: Union[str, Literal["dall-e-2"], None] | NotGiven = NOT_GIVEN,
|
||
|
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
||
|
|
response_format: Optional[Literal["url", "b64_json"]] | NotGiven = NOT_GIVEN,
|
||
|
|
size: Optional[Literal["256x256", "512x512", "1024x1024"]] | NotGiven = NOT_GIVEN,
|
||
|
|
user: 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,
|
||
|
|
) -> ImagesResponse:
|
||
|
|
"""
|
||
|
|
Creates an edited or extended image given an original image and a prompt.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
image: The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask
|
||
|
|
is not provided, image must have transparency, which will be used as the mask.
|
||
|
|
|
||
|
|
prompt: A text description of the desired image(s). The maximum length is 1000
|
||
|
|
characters.
|
||
|
|
|
||
|
|
mask: An additional image whose fully transparent areas (e.g. where alpha is zero)
|
||
|
|
indicate where `image` should be edited. Must be a valid PNG file, less than
|
||
|
|
4MB, and have the same dimensions as `image`.
|
||
|
|
|
||
|
|
model: The model to use for image generation. Only `dall-e-2` is supported at this
|
||
|
|
time.
|
||
|
|
|
||
|
|
n: The number of images to generate. Must be between 1 and 10.
|
||
|
|
|
||
|
|
response_format: The format in which the generated images are returned. Must be one of `url` or
|
||
|
|
`b64_json`. URLs are only valid for 60 minutes after the image has been
|
||
|
|
generated.
|
||
|
|
|
||
|
|
size: The size of the generated images. Must be one of `256x256`, `512x512`, or
|
||
|
|
`1024x1024`.
|
||
|
|
|
||
|
|
user: A unique identifier representing your end-user, which can help OpenAI to monitor
|
||
|
|
and detect abuse.
|
||
|
|
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
|
||
|
|
|
||
|
|
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(
|
||
|
|
{
|
||
|
|
"image": image,
|
||
|
|
"prompt": prompt,
|
||
|
|
"mask": mask,
|
||
|
|
"model": model,
|
||
|
|
"n": n,
|
||
|
|
"response_format": response_format,
|
||
|
|
"size": size,
|
||
|
|
"user": user,
|
||
|
|
}
|
||
|
|
)
|
||
|
|
files = extract_files(cast(Mapping[str, object], body), paths=[["image"], ["mask"]])
|
||
|
|
if files:
|
||
|
|
# 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(
|
||
|
|
"/images/edits",
|
||
|
|
body=await async_maybe_transform(body, image_edit_params.ImageEditParams),
|
||
|
|
files=files,
|
||
|
|
options=make_request_options(
|
||
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
|
),
|
||
|
|
cast_to=ImagesResponse,
|
||
|
|
)
|
||
|
|
|
||
|
|
async def generate(
|
||
|
|
self,
|
||
|
|
*,
|
||
|
|
prompt: str,
|
||
|
|
model: Union[str, Literal["dall-e-2", "dall-e-3"], None] | NotGiven = NOT_GIVEN,
|
||
|
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
||
|
|
quality: Literal["standard", "hd"] | NotGiven = NOT_GIVEN,
|
||
|
|
response_format: Optional[Literal["url", "b64_json"]] | NotGiven = NOT_GIVEN,
|
||
|
|
size: Optional[Literal["256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"]] | NotGiven = NOT_GIVEN,
|
||
|
|
style: Optional[Literal["vivid", "natural"]] | NotGiven = NOT_GIVEN,
|
||
|
|
user: 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,
|
||
|
|
) -> ImagesResponse:
|
||
|
|
"""
|
||
|
|
Creates an image given a prompt.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
prompt: A text description of the desired image(s). The maximum length is 1000
|
||
|
|
characters for `dall-e-2` and 4000 characters for `dall-e-3`.
|
||
|
|
|
||
|
|
model: The model to use for image generation.
|
||
|
|
|
||
|
|
n: The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
|
||
|
|
`n=1` is supported.
|
||
|
|
|
||
|
|
quality: The quality of the image that will be generated. `hd` creates images with finer
|
||
|
|
details and greater consistency across the image. This param is only supported
|
||
|
|
for `dall-e-3`.
|
||
|
|
|
||
|
|
response_format: The format in which the generated images are returned. Must be one of `url` or
|
||
|
|
`b64_json`. URLs are only valid for 60 minutes after the image has been
|
||
|
|
generated.
|
||
|
|
|
||
|
|
size: The size of the generated images. Must be one of `256x256`, `512x512`, or
|
||
|
|
`1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or
|
||
|
|
`1024x1792` for `dall-e-3` models.
|
||
|
|
|
||
|
|
style: The style of the generated images. Must be one of `vivid` or `natural`. Vivid
|
||
|
|
causes the model to lean towards generating hyper-real and dramatic images.
|
||
|
|
Natural causes the model to produce more natural, less hyper-real looking
|
||
|
|
images. This param is only supported for `dall-e-3`.
|
||
|
|
|
||
|
|
user: A unique identifier representing your end-user, which can help OpenAI to monitor
|
||
|
|
and detect abuse.
|
||
|
|
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
|
||
|
|
|
||
|
|
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(
|
||
|
|
"/images/generations",
|
||
|
|
body=await async_maybe_transform(
|
||
|
|
{
|
||
|
|
"prompt": prompt,
|
||
|
|
"model": model,
|
||
|
|
"n": n,
|
||
|
|
"quality": quality,
|
||
|
|
"response_format": response_format,
|
||
|
|
"size": size,
|
||
|
|
"style": style,
|
||
|
|
"user": user,
|
||
|
|
},
|
||
|
|
image_generate_params.ImageGenerateParams,
|
||
|
|
),
|
||
|
|
options=make_request_options(
|
||
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
|
),
|
||
|
|
cast_to=ImagesResponse,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class ImagesWithRawResponse:
|
||
|
|
def __init__(self, images: Images) -> None:
|
||
|
|
self._images = images
|
||
|
|
|
||
|
|
self.create_variation = _legacy_response.to_raw_response_wrapper(
|
||
|
|
images.create_variation,
|
||
|
|
)
|
||
|
|
self.edit = _legacy_response.to_raw_response_wrapper(
|
||
|
|
images.edit,
|
||
|
|
)
|
||
|
|
self.generate = _legacy_response.to_raw_response_wrapper(
|
||
|
|
images.generate,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class AsyncImagesWithRawResponse:
|
||
|
|
def __init__(self, images: AsyncImages) -> None:
|
||
|
|
self._images = images
|
||
|
|
|
||
|
|
self.create_variation = _legacy_response.async_to_raw_response_wrapper(
|
||
|
|
images.create_variation,
|
||
|
|
)
|
||
|
|
self.edit = _legacy_response.async_to_raw_response_wrapper(
|
||
|
|
images.edit,
|
||
|
|
)
|
||
|
|
self.generate = _legacy_response.async_to_raw_response_wrapper(
|
||
|
|
images.generate,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class ImagesWithStreamingResponse:
|
||
|
|
def __init__(self, images: Images) -> None:
|
||
|
|
self._images = images
|
||
|
|
|
||
|
|
self.create_variation = to_streamed_response_wrapper(
|
||
|
|
images.create_variation,
|
||
|
|
)
|
||
|
|
self.edit = to_streamed_response_wrapper(
|
||
|
|
images.edit,
|
||
|
|
)
|
||
|
|
self.generate = to_streamed_response_wrapper(
|
||
|
|
images.generate,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class AsyncImagesWithStreamingResponse:
|
||
|
|
def __init__(self, images: AsyncImages) -> None:
|
||
|
|
self._images = images
|
||
|
|
|
||
|
|
self.create_variation = async_to_streamed_response_wrapper(
|
||
|
|
images.create_variation,
|
||
|
|
)
|
||
|
|
self.edit = async_to_streamed_response_wrapper(
|
||
|
|
images.edit,
|
||
|
|
)
|
||
|
|
self.generate = async_to_streamed_response_wrapper(
|
||
|
|
images.generate,
|
||
|
|
)
|