All Implemented Interfaces:


public final class ImageGenerateParams.ImageGenerateBody.Builder

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`ImageGenerateParams.ImageGenerateBody.Builder()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final ImageGenerateParams.ImageGenerateBody.Builder`	`prompt(String prompt)`	A text description of the desired image(s).
`final ImageGenerateParams.ImageGenerateBody.Builder`	`prompt(JsonField<String> prompt)`	A text description of the desired image(s).
`final ImageGenerateParams.ImageGenerateBody.Builder`	`model(ImageModel model)`	The model to use for image generation.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`model(Optional<ImageModel> model)`	The model to use for image generation.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`model(JsonField<ImageModel> model)`	The model to use for image generation.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`model(String value)`	The model to use for image generation.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`n(Long n)`	The number of images to generate.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`n(Long n)`	The number of images to generate.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`n(Optional<Long> n)`	The number of images to generate.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`n(JsonField<Long> n)`	The number of images to generate.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`quality(ImageGenerateParams.Quality quality)`	The quality of the image that will be generated.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`quality(JsonField<ImageGenerateParams.Quality> quality)`	The quality of the image that will be generated.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`responseFormat(ImageGenerateParams.ResponseFormat responseFormat)`	The format in which the generated images are returned.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`responseFormat(Optional<ImageGenerateParams.ResponseFormat> responseFormat)`	The format in which the generated images are returned.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`responseFormat(JsonField<ImageGenerateParams.ResponseFormat> responseFormat)`	The format in which the generated images are returned.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`size(ImageGenerateParams.Size size)`	The size of the generated images.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`size(Optional<ImageGenerateParams.Size> size)`	The size of the generated images.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`size(JsonField<ImageGenerateParams.Size> size)`	The size of the generated images.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`style(ImageGenerateParams.Style style)`	The style of the generated images.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`style(Optional<ImageGenerateParams.Style> style)`	The style of the generated images.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`style(JsonField<ImageGenerateParams.Style> style)`	The style of the generated images.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`user(String user)`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`user(JsonField<String> user)`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final ImageGenerateParams.ImageGenerateBody.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final ImageGenerateParams.ImageGenerateBody.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final ImageGenerateParams.ImageGenerateBody.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final ImageGenerateParams.ImageGenerateBody.Builder`	`removeAdditionalProperty(String key)`
`final ImageGenerateParams.ImageGenerateBody.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final ImageGenerateParams.ImageGenerateBody`	`build()`

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

- Constructor Detail
  - ImageGenerateParams.ImageGenerateBody.Builder
```
ImageGenerateParams.ImageGenerateBody.Builder()
```
- Method Detail
  - prompt
```
 final ImageGenerateParams.ImageGenerateBody.Builder prompt(String prompt)
```
    A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.
  - prompt
```
 final ImageGenerateParams.ImageGenerateBody.Builder prompt(JsonField<String> prompt)
```
    A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.
  - model
```
 final ImageGenerateParams.ImageGenerateBody.Builder model(ImageModel model)
```
    The model to use for image generation.
  - model
```
 final ImageGenerateParams.ImageGenerateBody.Builder model(Optional<ImageModel> model)
```
    The model to use for image generation.
  - model
```
 final ImageGenerateParams.ImageGenerateBody.Builder model(JsonField<ImageModel> model)
```
    The model to use for image generation.
  - model
```
 final ImageGenerateParams.ImageGenerateBody.Builder model(String value)
```
    The model to use for image generation.
  - n
```
 final ImageGenerateParams.ImageGenerateBody.Builder n(Long n)
```
    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
  - n
```
 final ImageGenerateParams.ImageGenerateBody.Builder n(Long n)
```
    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
  - n
```
 final ImageGenerateParams.ImageGenerateBody.Builder n(Optional<Long> n)
```
    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
  - n
```
 final ImageGenerateParams.ImageGenerateBody.Builder n(JsonField<Long> n)
```
    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
  - quality
```
 final ImageGenerateParams.ImageGenerateBody.Builder quality(ImageGenerateParams.Quality quality)
```
    The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.
  - quality
```
 final ImageGenerateParams.ImageGenerateBody.Builder quality(JsonField<ImageGenerateParams.Quality> quality)
```
    The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.
  - responseFormat
```
 final ImageGenerateParams.ImageGenerateBody.Builder responseFormat(ImageGenerateParams.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 ImageGenerateParams.ImageGenerateBody.Builder responseFormat(Optional<ImageGenerateParams.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 ImageGenerateParams.ImageGenerateBody.Builder responseFormat(JsonField<ImageGenerateParams.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 ImageGenerateParams.ImageGenerateBody.Builder size(ImageGenerateParams.Size size)
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.
  - size
```
 final ImageGenerateParams.ImageGenerateBody.Builder size(Optional<ImageGenerateParams.Size> size)
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.
  - size
```
 final ImageGenerateParams.ImageGenerateBody.Builder size(JsonField<ImageGenerateParams.Size> size)
```
    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.
  - style
```
 final ImageGenerateParams.ImageGenerateBody.Builder style(ImageGenerateParams.Style style)
```
    The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.
  - style
```
 final ImageGenerateParams.ImageGenerateBody.Builder style(Optional<ImageGenerateParams.Style> style)
```
    The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.
  - style
```
 final ImageGenerateParams.ImageGenerateBody.Builder style(JsonField<ImageGenerateParams.Style> style)
```
    The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.
  - user
```
 final ImageGenerateParams.ImageGenerateBody.Builder user(String user)
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - user
```
 final ImageGenerateParams.ImageGenerateBody.Builder user(JsonField<String> user)
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - additionalProperties
```
 final ImageGenerateParams.ImageGenerateBody.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final ImageGenerateParams.ImageGenerateBody.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final ImageGenerateParams.ImageGenerateBody.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final ImageGenerateParams.ImageGenerateBody.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final ImageGenerateParams.ImageGenerateBody.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final ImageGenerateParams.ImageGenerateBody build()
```

Class ImageGenerateParams.ImageGenerateBody.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageGenerateParams.ImageGenerateBody.Builder

Method Detail

prompt

prompt

model

model

model

model

n

n

n

n

quality

quality

responseFormat

responseFormat

responseFormat

size

size

size

style

style

style

user

user

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build