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.  def createImage(prompt: String, n: Optional[N] = Optional.Absent, size: Optional[Size] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Images, 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.

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

7.  def createImage(body: CreateImageRequest): ZIO[Images, OpenAIFailure, ImagesResponse]

   Creates an image given a prompt.

8.  def createImageEdit(image: File, mask: Optional[File] = Optional.Absent, prompt: String, n: Optional[N] = Optional.Absent, size: Optional[Size] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Images, 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.

   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.

   prompt

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

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

9.  def createImageEdit(body: CreateImageEditRequest): ZIO[Images, OpenAIFailure, ImagesResponse]

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

10.  def createImageVariation(image: File, n: Optional[N] = Optional.Absent, size: Optional[Size] = Optional.Absent, responseFormat: Optional[ResponseFormat] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Images, 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.

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

11.  def createImageVariation(body: CreateImageVariationRequest): ZIO[Images, OpenAIFailure, ImagesResponse]

    Creates a variation of a given image.

12.  def default: ZLayer[Any, Throwable, Images]
13.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

14.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

15.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

16.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

17.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

18.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

19.  def live: ZLayer[Client, Nothing, Images]
20.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

21.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

22.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

23.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

24.  def toString(): String

    Definition Classes

    AnyRef → Any

25.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

26.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

27.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()