openai-core/com.aallam.openai.api.image/ImageCreation

ImageCreation

class ImageCreation(val prompt: String, val n: Int? = null, val size: ImageSize? = null, val user: String? = null, val model: ModelId? = null, val quality: Quality? = null, val style: Style? = null)

Image generation request.

Constructors

Link copied to clipboard
constructor(prompt: String, n: Int? = null, size: ImageSize? = null, user: String? = null, model: ModelId? = null, quality: Quality? = null, style: Style? = null)

Properties

Link copied to clipboard
val model: ModelId? = null

The model used to generate image. Must be one of dall-e-2 or dall-e-3. If not provided, dall-e-2 is used.

Link copied to clipboard
val n: Int? = null

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

Link copied to clipboard
val prompt: String

A text description of the desired image(s). The maximum length is 1000 characters.

Link copied to clipboard
val quality: Quality? = null

The quality of the image that will be generated. Quality.HD creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

Link copied to clipboard
val size: ImageSize? = null

The size of the generated images.

Link copied to clipboard
val style: Style? = null

The style of the generated images. Must be one of Style.Vivid or [Style.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.

Link copied to clipboard
val user: String? = null

The format in which the generated images are returned. Must be one of url or b64_json.