Class ResponseImageGenCallCompletedEvent
-
- All Implemented Interfaces:
public final class ResponseImageGenCallCompletedEvent
Emitted when an image generation tool call has completed and the final image is available.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseImageGenCallCompletedEvent.Builder
A builder for ResponseImageGenCallCompletedEvent.
-
Method Summary
Modifier and Type Method Description final String
itemId()
The unique identifier of the image generation item being processed. final Long
outputIndex()
The index of the output item in the response's output array. final Long
sequenceNumber()
The sequence number of this event. 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<Long>
_sequenceNumber()
Returns the raw JSON value of sequenceNumber. final Map<String, JsonValue>
_additionalProperties()
final ResponseImageGenCallCompletedEvent.Builder
toBuilder()
final ResponseImageGenCallCompletedEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseImageGenCallCompletedEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseImageGenCallCompletedEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item in the response's output array.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
The type of the event. Always 'response.image_generation_call.completed'.
Expected to always return the following:
JsonValue.from("response.image_generation_call.completed")
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.
-
_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 ResponseImageGenCallCompletedEvent.Builder toBuilder()
-
validate
final ResponseImageGenCallCompletedEvent validate()
-
builder
final static ResponseImageGenCallCompletedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseImageGenCallCompletedEvent.
The following fields are required:
.itemId() .outputIndex() .sequenceNumber()
-
-
-
-