Constructor Detail

Method Detail

• body

   final ImageCreateVariationParams.Builder body(ImageCreateVariationParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • image

  • model

  • n

  • responseFormat

  • size

  • etc.

• image

   final ImageCreateVariationParams.Builder image(InputStream image)

  The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

• image

   final ImageCreateVariationParams.Builder image(MultipartField<InputStream> image)

  Sets Builder.image to an arbitrary multipart value.

  You should usually call Builder.image with a well-typed InputStream value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• image

   final ImageCreateVariationParams.Builder image(ByteArray image)

  The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

• image

   final ImageCreateVariationParams.Builder image(Path path)

  The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

• model

   final ImageCreateVariationParams.Builder model(ImageModel model)

  The model to use for image generation. Only dall-e-2 is supported at this time.

• model

   final ImageCreateVariationParams.Builder model(Optional<ImageModel> model)

  Alias for calling Builder.model with model.orElse(null).

• model

   final ImageCreateVariationParams.Builder model(MultipartField<ImageModel> model)

  Sets Builder.model to an arbitrary multipart value.

  You should usually call Builder.model with a well-typed ImageModel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final ImageCreateVariationParams.Builder model(String value)

  Sets model to an arbitrary String.

  You should usually call model with a well-typed ImageModel constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• n

   final ImageCreateVariationParams.Builder n(Long n)

  The number of images to generate. Must be between 1 and 10.

• n

   final ImageCreateVariationParams.Builder n(Long n)

  Alias for Builder.n.

  This unboxed primitive overload exists for backwards compatibility.

• n

   final ImageCreateVariationParams.Builder n(Optional<Long> n)

  Alias for calling Builder.n with n.orElse(null).

• n

   final ImageCreateVariationParams.Builder n(MultipartField<Long> n)

  Sets Builder.n to an arbitrary multipart value.

  You should usually call Builder.n with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• responseFormat

   final ImageCreateVariationParams.Builder responseFormat(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.

• responseFormat

   final ImageCreateVariationParams.Builder responseFormat(Optional<ImageCreateVariationParams.ResponseFormat> responseFormat)

  Alias for calling Builder.responseFormat with responseFormat.orElse(null).

• responseFormat

   final ImageCreateVariationParams.Builder responseFormat(MultipartField<ImageCreateVariationParams.ResponseFormat> responseFormat)

  Sets Builder.responseFormat to an arbitrary multipart value.

  You should usually call Builder.responseFormat with a well-typed ResponseFormat value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• size

   final ImageCreateVariationParams.Builder size(ImageCreateVariationParams.Size size)

  The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

• size

   final ImageCreateVariationParams.Builder size(Optional<ImageCreateVariationParams.Size> size)

  Alias for calling Builder.size with size.orElse(null).

• size

   final ImageCreateVariationParams.Builder size(MultipartField<ImageCreateVariationParams.Size> size)

  Sets Builder.size to an arbitrary multipart value.

  You should usually call Builder.size with a well-typed Size value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• user

   final ImageCreateVariationParams.Builder user(String user)

  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

• user

   final ImageCreateVariationParams.Builder user(MultipartField<String> user)

  Sets Builder.user to an arbitrary multipart value.

  You should usually call Builder.user with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final ImageCreateVariationParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final ImageCreateVariationParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final ImageCreateVariationParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final ImageCreateVariationParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final ImageCreateVariationParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final ImageCreateVariationParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final ImageCreateVariationParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final ImageCreateVariationParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final ImageCreateVariationParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final ImageCreateVariationParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final ImageCreateVariationParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final ImageCreateVariationParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final ImageCreateVariationParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final ImageCreateVariationParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final ImageCreateVariationParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final ImageCreateVariationParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final ImageCreateVariationParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final ImageCreateVariationParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final ImageCreateVariationParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final ImageCreateVariationParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final ImageCreateVariationParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final ImageCreateVariationParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final ImageCreateVariationParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final ImageCreateVariationParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final ImageCreateVariationParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final ImageCreateVariationParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final ImageCreateVariationParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final ImageCreateVariationParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final ImageCreateVariationParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final ImageCreateVariationParams build()

  Returns an immutable instance of ImageCreateVariationParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .image()