All Implemented Interfaces:


public final class ImageGenerateParams.Body

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ImageGenerateParams.Body.Builder`	A builder for Body.

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 String`	`prompt()`	A text description of the desired image(s).
`final Optional<ImageModel>`	`model()`	The model to use for image generation.
`final Optional<Long>`	`n()`	The number of images to generate.
`final Optional<ImageGenerateParams.Quality>`	`quality()`	The quality of the image that will be generated.
`final Optional<ImageGenerateParams.ResponseFormat>`	`responseFormat()`	The format in which the generated images are returned.
`final Optional<ImageGenerateParams.Size>`	`size()`	The size of the generated images.
`final Optional<ImageGenerateParams.Style>`	`style()`	The style 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 JsonField<String>`	`_prompt()`	A text description of the desired image(s).
`final JsonField<ImageModel>`	`_model()`	The model to use for image generation.
`final JsonField<Long>`	`_n()`	The number of images to generate.
`final JsonField<ImageGenerateParams.Quality>`	`_quality()`	The quality of the image that will be generated.
`final JsonField<ImageGenerateParams.ResponseFormat>`	`_responseFormat()`	The format in which the generated images are returned.
`final JsonField<ImageGenerateParams.Size>`	`_size()`	The size of the generated images.
`final JsonField<ImageGenerateParams.Style>`	`_style()`	The style of the generated images.
`final JsonField<String>`	`_user()`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ImageGenerateParams.Body`	`validate()`
`final ImageGenerateParams.Body.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ImageGenerateParams.Body.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Body.

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

- Constructor Detail
- Method Detail
  - prompt
```
 final 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 Optional<ImageModel> model()
```
    The model to use for image generation.
  - 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.
  - quality
```
 final Optional<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 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.
  - size
```
 final 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.
  - style
```
 final 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.
  - user
```
 final Optional<String> user()
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - _prompt
```
 final 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 JsonField<ImageModel> _model()
```
    The model to use for image generation.
  - _n
```
 final 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 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 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 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 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 JsonField<String> _user()
```
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final ImageGenerateParams.Body validate()
```
  - toBuilder
```
 final ImageGenerateParams.Body.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ImageGenerateParams.Body.Builder builder()
```
    Returns a mutable builder for constructing an instance of Body.
    The following fields are required:
    .prompt()

Class ImageGenerateParams.Body

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

prompt

model

n

quality

responseFormat

size

style

user

_prompt

_model

_n

_quality

_responseFormat

_size

_style

_user

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder