Class BetaResponseOutputItemDoneEvent
-
- All Implemented Interfaces:
public final class BetaResponseOutputItemDoneEventEmitted when an output item is marked done.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseOutputItemDoneEvent.BuilderA builder for BetaResponseOutputItemDoneEvent.
public final classBetaResponseOutputItemDoneEvent.AgentThe agent that owns this multi-agent streaming event.
-
Method Summary
Modifier and Type Method Description final BetaResponseOutputItemitem()The output item that was marked done. final LongoutputIndex()The index of the output item that was marked done. final LongsequenceNumber()The sequence number of this event. final JsonValue_type()The type of the event. final Optional<BetaResponseOutputItemDoneEvent.Agent>agent()The agent that owns this multi-agent streaming event. final JsonField<BetaResponseOutputItem>_item()Returns the raw JSON value of item. final JsonField<Long>_outputIndex()Returns the raw JSON value of outputIndex. final JsonField<Long>_sequenceNumber()Returns the raw JSON value of sequenceNumber. final JsonField<BetaResponseOutputItemDoneEvent.Agent>_agent()Returns the raw JSON value of agent. final Map<String, JsonValue>_additionalProperties()final BetaResponseOutputItemDoneEvent.BuildertoBuilder()final BetaResponseOutputItemDoneEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseOutputItemDoneEvent.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseOutputItemDoneEvent. -
-
Method Detail
-
item
final BetaResponseOutputItem item()
The output item that was marked done.
-
outputIndex
final Long outputIndex()
The index of the output item that was marked done.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
The type of the event. Always
response.output_item.done.Expected to always return the following:
JsonValue.from("response.output_item.done")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseOutputItemDoneEvent.Agent> agent()
The agent that owns this multi-agent streaming event.
-
_item
final JsonField<BetaResponseOutputItem> _item()
Returns the raw JSON value of item.
Unlike item, 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.
-
_agent
final JsonField<BetaResponseOutputItemDoneEvent.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseOutputItemDoneEvent.Builder toBuilder()
-
validate
final BetaResponseOutputItemDoneEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaResponseOutputItemDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseOutputItemDoneEvent.
The following fields are required:
.item() .outputIndex() .sequenceNumber()
-
-
-
-