Packages

trait Images extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Live
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Images
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def createImage(body: CreateImageRequest): ZIO[Any, OpenAIFailure, ImagesResponse]

    Creates an image given a prompt.

  2. abstract def createImageEdit(body: CreateImageEditRequest): ZIO[Any, OpenAIFailure, ImagesResponse]

    Creates an edited or extended image given an original image and a prompt.

  3. abstract def createImageVariation(body: CreateImageVariationRequest): ZIO[Any, OpenAIFailure, ImagesResponse]

    Creates a variation of a given image.

Concrete 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]) @IntrinsicCandidate() @native()
  6. def createImage(prompt: String, model: Optional[Model] = Optional.Absent, n: Optional[N] = Optional.Absent, quality: Optional[Quality] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, size: Optional[Size] = Optional.Absent, style: Optional[Style] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, ImagesResponse]

    Creates an image given a prompt.

    Creates an image given a prompt.

    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).

  7. def createImageEdit(image: File, prompt: String, mask: Optional[File] = Optional.Absent, model: Optional[Model] = Optional.Absent, n: Optional[N] = Optional.Absent, size: Optional[Size] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, ImagesResponse]

    Creates an edited or extended image given an original image and a prompt.

    Creates an edited or extended image given an original image and a prompt.

    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).

  8. def createImageVariation(image: File, model: Optional[Model] = Optional.Absent, n: Optional[N] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, size: Optional[Size] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, ImagesResponse]

    Creates a variation of a given image.

    Creates a variation of a given image.

    image

    The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

    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. For dall-e-3, only n=1 is supported.

    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.

    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).

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped