Packages

final case class CreateImageRequest(prompt: String, model: Optional[CreateImageRequest.Model] = Optional.Absent, n: Optional[N] = Optional.Absent, quality: Optional[Quality] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, size: Optional[CreateImageRequest.Size] = Optional.Absent, style: Optional[Style] = Optional.Absent, user: Optional[String] = Optional.Absent) extends Product with Serializable

CreateImageRequest model

prompt

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

model

The model to use for image generation.

n

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

quality

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

responseFormat

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

size

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

style

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

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. CreateImageRequest
  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 CreateImageRequest(prompt: String, model: Optional[CreateImageRequest.Model] = Optional.Absent, n: Optional[N] = Optional.Absent, quality: Optional[Quality] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, size: Optional[CreateImageRequest.Size] = Optional.Absent, style: Optional[Style] = Optional.Absent, user: Optional[String] = Optional.Absent)

    prompt

    A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

    model

    The model to use for image generation.

    n

    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

    quality

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

    responseFormat

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

    size

    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

    style

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

    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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. val model: Optional[CreateImageRequest.Model]
  11. val n: Optional[N]
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. val prompt: String
  17. val quality: Optional[Quality]
  18. val responseFormat: Optional[ResponseFormat]
  19. val size: Optional[CreateImageRequest.Size]
  20. val style: Optional[Style]
  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