All Implemented Interfaces:


public final class ImageEditParams.Body.Builder

A builder for Body.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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 ImageEditParams.Body.Builder`	`image(InputStream image)`	The image to edit.
`final ImageEditParams.Body.Builder`	`image(MultipartField<InputStream> image)`	The image to edit.
`final ImageEditParams.Body.Builder`	`image(ByteArray image)`	The image to edit.
`final ImageEditParams.Body.Builder`	`image(Path image)`	The image to edit.
`final ImageEditParams.Body.Builder`	`prompt(String prompt)`	A text description of the desired image(s).
`final ImageEditParams.Body.Builder`	`prompt(MultipartField<String> prompt)`	A text description of the desired image(s).
`final ImageEditParams.Body.Builder`	`mask(InputStream mask)`	An additional image whose fully transparent areas (e.g.
`final ImageEditParams.Body.Builder`	`mask(MultipartField<InputStream> mask)`	An additional image whose fully transparent areas (e.g.
`final ImageEditParams.Body.Builder`	`mask(ByteArray mask)`	An additional image whose fully transparent areas (e.g.
`final ImageEditParams.Body.Builder`	`mask(Path mask)`	An additional image whose fully transparent areas (e.g.
`final ImageEditParams.Body.Builder`	`model(ImageModel model)`	The model to use for image generation.
`final ImageEditParams.Body.Builder`	`model(Optional<ImageModel> model)`	The model to use for image generation.
`final ImageEditParams.Body.Builder`	`model(MultipartField<ImageModel> model)`	The model to use for image generation.
`final ImageEditParams.Body.Builder`	`model(String value)`	The model to use for image generation.
`final ImageEditParams.Body.Builder`	`n(Long n)`	The number of images to generate.
`final ImageEditParams.Body.Builder`	`n(Long n)`	The number of images to generate.
`final ImageEditParams.Body.Builder`	`n(Optional<Long> n)`	The number of images to generate.
`final ImageEditParams.Body.Builder`	`n(MultipartField<Long> n)`	The number of images to generate.
`final ImageEditParams.Body.Builder`	`responseFormat(ImageEditParams.ResponseFormat responseFormat)`	The format in which the generated images are returned.
`final ImageEditParams.Body.Builder`	`responseFormat(Optional<ImageEditParams.ResponseFormat> responseFormat)`	The format in which the generated images are returned.
`final ImageEditParams.Body.Builder`	`responseFormat(MultipartField<ImageEditParams.ResponseFormat> responseFormat)`	The format in which the generated images are returned.
`final ImageEditParams.Body.Builder`	`size(ImageEditParams.Size size)`	The size of the generated images.
`final ImageEditParams.Body.Builder`	`size(Optional<ImageEditParams.Size> size)`	The size of the generated images.
`final ImageEditParams.Body.Builder`	`size(MultipartField<ImageEditParams.Size> size)`	The size of the generated images.
`final ImageEditParams.Body.Builder`	`user(String user)`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final ImageEditParams.Body.Builder`	`user(MultipartField<String> user)`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final ImageEditParams.Body`	`build()`

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

- Constructor Detail
- Method Detail
  - image
```
 final ImageEditParams.Body.Builder image(InputStream 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.
  - image
```
 final ImageEditParams.Body.Builder image(MultipartField<InputStream> 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.
  - image
```
 final ImageEditParams.Body.Builder image(ByteArray 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.
  - image
```
 final ImageEditParams.Body.Builder image(Path 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
```
 final ImageEditParams.Body.Builder prompt(String prompt)
```
    A text description of the desired image(s). The maximum length is 1000 characters.
  - prompt
```
 final ImageEditParams.Body.Builder prompt(MultipartField<String> prompt)
```
    A text description of the desired image(s). The maximum length is 1000 characters.
  - mask
```
 final ImageEditParams.Body.Builder mask(InputStream 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.
  - mask
```
 final ImageEditParams.Body.Builder mask(MultipartField<InputStream> 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.
  - mask
```
 final ImageEditParams.Body.Builder mask(ByteArray 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.
  - mask
```
 final ImageEditParams.Body.Builder mask(Path 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
```
 final ImageEditParams.Body.Builder model(ImageModel model)
```
    The model to use for image generation. Only dall-e-2 is supported at this time.
  - model
```
 final ImageEditParams.Body.Builder model(Optional<ImageModel> model)
```
    The model to use for image generation. Only dall-e-2 is supported at this time.
  - model
```
 final ImageEditParams.Body.Builder model(MultipartField<ImageModel> model)
```
    The model to use for image generation. Only dall-e-2 is supported at this time.
  - model
```
 final ImageEditParams.Body.Builder model(String value)
```
    The model to use for image generation. Only dall-e-2 is supported at this time.
  - n
```
 final ImageEditParams.Body.Builder n(Long n)
```
    The number of images to generate. Must be between 1 and 10.
  - n
```
 final ImageEditParams.Body.Builder n(Long n)
```
    The number of images to generate. Must be between 1 and 10.
  - n
```
 final ImageEditParams.Body.Builder n(Optional<Long> n)
```
    The number of images to generate. Must be between 1 and 10.
  - n
```
 final ImageEditParams.Body.Builder n(MultipartField<Long> n)
```
    The number of images to generate. Must be between 1 and 10.
  - responseFormat
```
 final ImageEditParams.Body.Builder responseFormat(ImageEditParams.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 ImageEditParams.Body.Builder responseFormat(Optional<ImageEditParams.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 ImageEditParams.Body.Builder responseFormat(MultipartField<ImageEditParams.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 ImageEditParams.Body.Builder size(ImageEditParams.Size size)
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - size
```
 final ImageEditParams.Body.Builder size(Optional<ImageEditParams.Size> size)
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - size
```
 final ImageEditParams.Body.Builder size(MultipartField<ImageEditParams.Size> size)
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - user
```
 final ImageEditParams.Body.Builder user(String user)
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - user
```
 final ImageEditParams.Body.Builder user(MultipartField<String> user)
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - build
```
 final ImageEditParams.Body build()
```

Class ImageEditParams.Body.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

image

image

image

image

prompt

prompt

mask

mask

mask

mask

model

model

model

model

n

n

n

n

responseFormat

responseFormat

responseFormat

size

size

size

user

user

build