Class ImageCreateVariationParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class ImageCreateVariationParams implements Params
Creates a variation of a given image. This endpoint only supports
dall-e-2
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ImageCreateVariationParams.Builder
A builder for ImageCreateVariationParams.
public final class
ImageCreateVariationParams.Body
public final class
ImageCreateVariationParams.ResponseFormat
The format in which the generated images are returned. Must be one of
url
orb64_json
. URLs are only valid for 60 minutes after the image has been generated.public final class
ImageCreateVariationParams.Size
The size of the generated images. Must be one of
256x256
,512x512
, or1024x1024
.
-
Method Summary
Modifier and Type Method Description final InputStream
image()
The image to use as the basis for the variation(s). final Optional<ImageModel>
model()
The model to use for image generation. final Optional<Long>
n()
The number of images to generate. final Optional<ImageCreateVariationParams.ResponseFormat>
responseFormat()
The format in which the generated images are returned. final Optional<ImageCreateVariationParams.Size>
size()
The size of the generated images. final Optional<String>
user()
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. final MultipartField<InputStream>
_image()
Returns the raw multipart value of image. final MultipartField<ImageModel>
_model()
Returns the raw multipart value of model. final MultipartField<Long>
_n()
Returns the raw multipart value of n. final MultipartField<ImageCreateVariationParams.ResponseFormat>
_responseFormat()
Returns the raw multipart value of responseFormat. final MultipartField<ImageCreateVariationParams.Size>
_size()
Returns the raw multipart value of size. final MultipartField<String>
_user()
Returns the raw multipart value of user. final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final ImageCreateVariationParams.Builder
toBuilder()
final Map<String, MultipartField<?>>
_body()
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ImageCreateVariationParams.Builder
builder()
Returns a mutable builder for constructing an instance of ImageCreateVariationParams. -
-
Method Detail
-
image
final InputStream image()
The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
-
model
final Optional<ImageModel> model()
The model to use for image generation. Only
dall-e-2
is supported at this time.
-
responseFormat
final Optional<ImageCreateVariationParams.ResponseFormat> responseFormat()
The format in which the generated images are returned. Must be one of
url
orb64_json
. URLs are only valid for 60 minutes after the image has been generated.
-
size
final Optional<ImageCreateVariationParams.Size> size()
The size of the generated images. Must be one of
256x256
,512x512
, or1024x1024
.
-
user
final Optional<String> user()
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
-
_image
final MultipartField<InputStream> _image()
Returns the raw multipart value of image.
Unlike image, this method doesn't throw if the multipart field has an unexpected type.
-
_model
final MultipartField<ImageModel> _model()
Returns the raw multipart value of model.
Unlike model, this method doesn't throw if the multipart field has an unexpected type.
-
_n
final MultipartField<Long> _n()
Returns the raw multipart value of n.
Unlike n, this method doesn't throw if the multipart field has an unexpected type.
-
_responseFormat
final MultipartField<ImageCreateVariationParams.ResponseFormat> _responseFormat()
Returns the raw multipart value of responseFormat.
Unlike responseFormat, this method doesn't throw if the multipart field has an unexpected type.
-
_size
final MultipartField<ImageCreateVariationParams.Size> _size()
Returns the raw multipart value of size.
Unlike size, this method doesn't throw if the multipart field has an unexpected type.
-
_user
final MultipartField<String> _user()
Returns the raw multipart value of user.
Unlike user, this method doesn't throw if the multipart field has an unexpected type.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ImageCreateVariationParams.Builder toBuilder()
-
_body
final Map<String, MultipartField<?>> _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static ImageCreateVariationParams.Builder builder()
Returns a mutable builder for constructing an instance of ImageCreateVariationParams.
The following fields are required:
.image()
-
-
-
-