Class ResponseImageGenCallPartialImageEvent
-
- All Implemented Interfaces:
public final class ResponseImageGenCallPartialImageEventEmitted when a partial image is available during image generation streaming.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseImageGenCallPartialImageEvent.BuilderA builder for ResponseImageGenCallPartialImageEvent.
-
Method Summary
Modifier and Type Method Description final StringitemId()The unique identifier of the image generation item being processed. final LongoutputIndex()The index of the output item in the response's output array. final StringpartialImageB64()Base64-encoded partial image data, suitable for rendering as an image. final LongpartialImageIndex()0-based index for the partial image (backend is 1-based, but this is 0-based for the user). final LongsequenceNumber()The sequence number of the image generation item being processed. final JsonValue_type()The type of the event. final JsonField<String>_itemId()Returns the raw JSON value of itemId. final JsonField<Long>_outputIndex()Returns the raw JSON value of outputIndex. final JsonField<String>_partialImageB64()Returns the raw JSON value of partialImageB64. final JsonField<Long>_partialImageIndex()Returns the raw JSON value of partialImageIndex. final JsonField<Long>_sequenceNumber()Returns the raw JSON value of sequenceNumber. final Map<String, JsonValue>_additionalProperties()final ResponseImageGenCallPartialImageEvent.BuildertoBuilder()final ResponseImageGenCallPartialImageEventvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseImageGenCallPartialImageEvent.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseImageGenCallPartialImageEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item in the response's output array.
-
partialImageB64
final String partialImageB64()
Base64-encoded partial image data, suitable for rendering as an image.
-
partialImageIndex
final Long partialImageIndex()
0-based index for the partial image (backend is 1-based, but this is 0-based for the user).
-
sequenceNumber
final Long sequenceNumber()
The sequence number of the image generation item being processed.
-
_type
final JsonValue _type()
The type of the event. Always 'response.image_generation_call.partial_image'.
Expected to always return the following:
JsonValue.from("response.image_generation_call.partial_image")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_itemId
final JsonField<String> _itemId()
Returns the raw JSON value of itemId.
Unlike itemId, this method doesn't throw if the JSON field has an unexpected type.
-
_outputIndex
final JsonField<Long> _outputIndex()
Returns the raw JSON value of outputIndex.
Unlike outputIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_partialImageB64
final JsonField<String> _partialImageB64()
Returns the raw JSON value of partialImageB64.
Unlike partialImageB64, this method doesn't throw if the JSON field has an unexpected type.
-
_partialImageIndex
final JsonField<Long> _partialImageIndex()
Returns the raw JSON value of partialImageIndex.
Unlike partialImageIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_sequenceNumber
final JsonField<Long> _sequenceNumber()
Returns the raw JSON value of sequenceNumber.
Unlike sequenceNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseImageGenCallPartialImageEvent.Builder toBuilder()
-
validate
final ResponseImageGenCallPartialImageEvent validate()
-
builder
final static ResponseImageGenCallPartialImageEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseImageGenCallPartialImageEvent.
The following fields are required:
.itemId() .outputIndex() .partialImageB64() .partialImageIndex() .sequenceNumber()
-
-
-
-