All Implemented Interfaces:: com.openai.core.Params


public final class ImageCreateVariationParams
 implements Params

Creates a variation of a given image.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ImageCreateVariationParams.Body`
`public final class`	`ImageCreateVariationParams.Builder`	A builder for ImageCreateVariationParams.
`public final class`	`ImageCreateVariationParams.ResponseFormat`	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.
`public final class`	`ImageCreateVariationParams.Size`	The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

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()`	The image to use as the basis for the variation(s).
`final MultipartField<ImageModel>`	`_model()`	The model to use for image generation.
`final MultipartField<Long>`	`_n()`	The number of images to generate.
`final MultipartField<ImageCreateVariationParams.ResponseFormat>`	`_responseFormat()`	The format in which the generated images are returned.
`final MultipartField<ImageCreateVariationParams.Size>`	`_size()`	The size of the generated images.
`final MultipartField<String>`	`_user()`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`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.
`final ImageCreateVariationParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ImageCreateVariationParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ImageCreateVariationParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- 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.
  - n
```
 final Optional<Long> n()
```
    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
  - responseFormat
```
 final Optional<ImageCreateVariationParams.ResponseFormat> responseFormat()
```
    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
```
 final Optional<ImageCreateVariationParams.Size> size()
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - 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()
```
    The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
  - _model
```
 final MultipartField<ImageModel> _model()
```
    The model to use for image generation. Only dall-e-2 is supported at this time.
  - _n
```
 final MultipartField<Long> _n()
```
    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
  - _responseFormat
```
 final MultipartField<ImageCreateVariationParams.ResponseFormat> _responseFormat()
```
    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
```
 final MultipartField<ImageCreateVariationParams.Size> _size()
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - _user
```
 final MultipartField<String> _user()
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _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.
  - toBuilder
```
 final ImageCreateVariationParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ImageCreateVariationParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ImageCreateVariationParams.
    The following fields are required:
    .image()

Class ImageCreateVariationParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

image

model

n

responseFormat

size

user

_image

_model

_n

_responseFormat

_size

_user

_additionalHeaders

_additionalQueryParams

_headers

_queryParams

toBuilder

equals

hashCode

toString

builder