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

Emitted when a partial image is available during image generation streaming.

Fields

  • :item_id - required - String.t()
    The unique identifier of the image generation item being processed.

  • :output_index - required - integer()
    The index of the output item in the response's output array.

  • :partial_image_b64 - required - String.t()
    Base64-encoded partial image data, suitable for rendering as an image.

  • :partial_image_index - required - integer()
    0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

  • :sequence_number - required - integer()
    The sequence number of the image generation item being processed.

  • :type - required - :"response.image_generation_call.partial_image"
    The type of the event. Always 'response.image_generation_call.partial_image'.
    Allowed values: "response.image_generation_call.partial_image"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.ResponseImageGenCallPartialImageEvent{
  item_id: String.t(),
  output_index: integer(),
  partial_image_b64: String.t(),
  partial_image_index: integer(),
  sequence_number: integer(),
  type: :"response.image_generation_call.partial_image"
}