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

Package-level declarations

Types

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.

ImageCreationBuilder

class ImageCreationBuilder

Builder of ImageCreation instances.

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.

ImageEditBuilder

class ImageEditBuilder

Builder of ImageEdit instances.

@Serializable

data class ImageJSON(val b64JSON: String, val revisedPrompt: String? = null)

Generated image JSON (base 64).

@Serializable

value class ImageSize(val size: String)

The size of the generated images.

@Serializable

data class ImageURL(val url: String, val revisedPrompt: String? = null)

Generated image URL.

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

Image variant request.

ImageVariationBuilder

class ImageVariationBuilder

Builder of ImageVariation instances.

@Serializable

value class Quality(val value: String)

The quality of the image that will be generated

@Serializable

value class Style(val value: String)

The style of the generated images.

Functions

fun imageCreation(block: ImageCreationBuilder.() -> Unit): ImageCreation

Image generation request.

fun imageEdit(block: ImageEditBuilder.() -> Unit): ImageEdit

Image edit request.

fun imageVariation(block: ImageVariationBuilder.() -> Unit): ImageVariation

Image variant request.