class

OpenAI::ResponseImageGenCallPartialImageEvent

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(type_value : ResponseImageGenCallPartialImageEventType = ResponseImageGenCallPartialImageEventType::ResponseImageGenerationCallPartialImage, output_index : Int64 = 0, item_id : String = "", sequence_number : Int64 = 0, partial_image_index : Int64 = 0, partial_image_b64 : String = "")
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

item_id

The unique identifier of the image generation item being processed.

Source
item_id=(item_id : String)

The unique identifier of the image generation item being processed.

Source
output_index

The index of the output item in the response's output array.

Source
output_index=(output_index : Int64)

The index of the output item in the response's output array.

Source
partial_image_b64

Base64-encoded partial image data, suitable for rendering as an image.

Source
partial_image_b64=(partial_image_b64 : String)

Base64-encoded partial image data, suitable for rendering as an image.

Source
partial_image_index

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

Source
partial_image_index=(partial_image_index : Int64)

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

Source
sequence_number

The sequence number of the image generation item being processed.

Source
sequence_number=(sequence_number : Int64)

The sequence number of the image generation item being processed.

Source
type_value

The type of the event. Always 'response.image_generation_call.partial_image'.

Source
type_value=(type_value : ResponseImageGenCallPartialImageEventType)

The type of the event. Always 'response.image_generation_call.partial_image'.

Source