class

OpenAI::ImageEditPartialImageEvent

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(type_value : ImageEditPartialImageEventType = ImageEditPartialImageEventType::ImageEditPartialImage, b64_json : String = "", created_at : Int64 = 0, size : ImageEditPartialImageEventSize = ImageEditPartialImageEventSize::N1024X1024, quality : ImageEditPartialImageEventQuality = ImageEditPartialImageEventQuality::Low, background : ImageEditPartialImageEventBackground = ImageEditPartialImageEventBackground::Transparent, output_format : ImageEditPartialImageEventOutputFormat = ImageEditPartialImageEventOutputFormat::Png, partial_image_index : Int64 = 0)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

b64_json

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

Source
b64_json=(b64_json : String)

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

Source
background

The background setting for the requested edited image.

Source
background=(background : ImageEditPartialImageEventBackground)

The background setting for the requested edited image.

Source
created_at

The Unix timestamp when the event was created.

Source
created_at=(created_at : Int64)

The Unix timestamp when the event was created.

Source
output_format

The output format for the requested edited image.

Source
output_format=(output_format : ImageEditPartialImageEventOutputFormat)

The output format for the requested edited image.

Source
partial_image_index

0-based index for the partial image (streaming).

Source
partial_image_index=(partial_image_index : Int64)

0-based index for the partial image (streaming).

Source
quality

The quality setting for the requested edited image.

Source
quality=(quality : ImageEditPartialImageEventQuality)

The quality setting for the requested edited image.

Source
size

The size of the requested edited image.

Source
size=(size : ImageEditPartialImageEventSize)

The size of the requested edited image.

Source
type_value

The type of the event. Always image_edit.partial_image.

Source
type_value=(type_value : ImageEditPartialImageEventType)

The type of the event. Always image_edit.partial_image.

Source