View Source ExOpenAI.Components.ImageEditCompletedEvent (ex_openai.ex v2.0.0-beta2)

Emitted when image editing has completed and the final image is available.

Fields

  • :b64_json - required - String.t()
    Base64-encoded final edited image data, suitable for rendering as an image.

  • :background - required - :transparent | :opaque | :auto
    The background setting for the edited image.
    Allowed values: "transparent", "opaque", "auto"

  • :created_at - required - integer()
    The Unix timestamp when the event was created.

  • :output_format - required - :png | :webp | :jpeg
    The output format for the edited image.
    Allowed values: "png", "webp", "jpeg"

  • :quality - required - :low | :medium | :high | :auto
    The quality setting for the edited image.
    Allowed values: "low", "medium", "high", "auto"

  • :size - required - :"1024x1024" | :"1024x1536" | :"1536x1024" | :auto
    The size of the edited image.
    Allowed values: "1024x1024", "1024x1536", "1536x1024", "auto"

  • :type - required - :"image_edit.completed"
    The type of the event. Always image_edit.completed.
    Allowed values: "image_edit.completed"

  • :usage - required - ExOpenAI.Components.ImagesUsage.t()

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.ImageEditCompletedEvent{
  b64_json: String.t(),
  background: (:transparent | :opaque) | :auto,
  created_at: integer(),
  output_format: (:png | :webp) | :jpeg,
  quality: ((:low | :medium) | :high) | :auto,
  size: ((:"1024x1024" | :"1024x1536") | :"1536x1024") | :auto,
  type: :"image_edit.completed",
  usage: ExOpenAI.Components.ImagesUsage.t()
}