ImageEditsConfig

sttp.openai.requests.images.edit.ImageEditsConfig
See theImageEditsConfig companion object
case class ImageEditsConfig(image: File, prompt: String, mask: Option[File], n: Option[Int], size: Option[Size], responseFormat: Option[ResponseFormat], user: Option[String])

Value parameters

image

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

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.

n

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

prompt

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

responseFormat

The format in which the generated images are returned. Must be one of url`` orb64_json`.

size

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

user

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

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product