Packages

final case class CreateImageEditRequest(image: File, prompt: String, mask: Optional[File] = Optional.Absent, model: Optional[CreateImageEditRequest.Model] = Optional.Absent, n: Optional[CreateImageEditRequest.N] = Optional.Absent, size: Optional[Size] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, user: Optional[String] = Optional.Absent) extends Product with Serializable

CreateImageEditRequest model

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.

prompt

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

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.

model

The model to use for image generation. Only dall-e-2 is supported at this time.

n

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

size

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

responseFormat

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

user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CreateImageEditRequest
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CreateImageEditRequest(image: File, prompt: String, mask: Optional[File] = Optional.Absent, model: Optional[CreateImageEditRequest.Model] = Optional.Absent, n: Optional[CreateImageEditRequest.N] = Optional.Absent, size: Optional[Size] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, user: Optional[String] = Optional.Absent)

    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.

    prompt

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

    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.

    model

    The model to use for image generation. Only dall-e-2 is supported at this time.

    n

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

    size

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

    responseFormat

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

    user

    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. val image: File
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val mask: Optional[File]
  12. val model: Optional[CreateImageEditRequest.Model]
  13. val n: Optional[CreateImageEditRequest.N]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val prompt: String
  19. val responseFormat: Optional[ResponseFormat]
  20. val size: Optional[Size]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. val user: Optional[String]
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped