Class ImageCreateVariationParams.Body
-
- All Implemented Interfaces:
public final class ImageCreateVariationParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classImageCreateVariationParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final InputStreamimage()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 Map<String, JsonValue>_additionalProperties()final ImageCreateVariationParams.Body.BuildertoBuilder()final ImageCreateVariationParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ImageCreateVariationParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
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-2is supported at this time.
-
responseFormat
final Optional<ImageCreateVariationParams.ResponseFormat> responseFormat()
The format in which the generated images are returned. Must be one of
urlorb64_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ImageCreateVariationParams.Body.Builder toBuilder()
-
validate
final ImageCreateVariationParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static ImageCreateVariationParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.image()
-
-
-
-