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

ImageEdit

class ImageEdit(val image: FileSource, val mask: FileSource, val prompt: String, val n: Int? = null, val size: ImageSize? = null, val user: String? = null, val model: ModelId? = null)

Image edit request.

Constructors

ImageEdit

constructor(image: FileSource, mask: FileSource, prompt: String, n: Int? = null, size: ImageSize? = null, user: String? = null, model: ModelId? = null)

Properties

image

val image: FileSource

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.

mask

val mask: FileSource

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

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.

val n: Int? = null

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

prompt

val prompt: String

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

size

val size: ImageSize? = null

The size of the generated images.

user

val user: String? = null

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