Class BetaResponseReasoningSummaryPartDoneEvent
-
- All Implemented Interfaces:
public final class BetaResponseReasoningSummaryPartDoneEventEmitted when a reasoning summary part is completed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseReasoningSummaryPartDoneEvent.BuilderA builder for BetaResponseReasoningSummaryPartDoneEvent.
public final classBetaResponseReasoningSummaryPartDoneEvent.PartThe completed summary part.
public final classBetaResponseReasoningSummaryPartDoneEvent.AgentThe agent that owns this multi-agent streaming event.
public final classBetaResponseReasoningSummaryPartDoneEvent.StatusThe completion status of the summary part. Omitted when the part completed normally and set to
incompletewhen generation was interrupted.
-
Method Summary
Modifier and Type Method Description final StringitemId()The ID of the item this summary part is associated with. final LongoutputIndex()The index of the output item this summary part is associated with. final BetaResponseReasoningSummaryPartDoneEvent.Partpart()The completed summary part. final LongsequenceNumber()The sequence number of this event. final LongsummaryIndex()The index of the summary part within the reasoning summary. final JsonValue_type()The type of the event. final Optional<BetaResponseReasoningSummaryPartDoneEvent.Agent>agent()The agent that owns this multi-agent streaming event. final Optional<BetaResponseReasoningSummaryPartDoneEvent.Status>status()The completion status of the summary part. final JsonField<String>_itemId()Returns the raw JSON value of itemId. final JsonField<Long>_outputIndex()Returns the raw JSON value of outputIndex. final JsonField<BetaResponseReasoningSummaryPartDoneEvent.Part>_part()Returns the raw JSON value of part. final JsonField<Long>_sequenceNumber()Returns the raw JSON value of sequenceNumber. final JsonField<Long>_summaryIndex()Returns the raw JSON value of summaryIndex. final JsonField<BetaResponseReasoningSummaryPartDoneEvent.Agent>_agent()Returns the raw JSON value of agent. final JsonField<BetaResponseReasoningSummaryPartDoneEvent.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final BetaResponseReasoningSummaryPartDoneEvent.BuildertoBuilder()final BetaResponseReasoningSummaryPartDoneEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseReasoningSummaryPartDoneEvent.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseReasoningSummaryPartDoneEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item this summary part is associated with.
-
part
final BetaResponseReasoningSummaryPartDoneEvent.Part part()
The completed summary part.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
summaryIndex
final Long summaryIndex()
The index of the summary part within the reasoning summary.
-
_type
final JsonValue _type()
The type of the event. Always
response.reasoning_summary_part.done.Expected to always return the following:
JsonValue.from("response.reasoning_summary_part.done")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseReasoningSummaryPartDoneEvent.Agent> agent()
The agent that owns this multi-agent streaming event.
-
status
final Optional<BetaResponseReasoningSummaryPartDoneEvent.Status> status()
The completion status of the summary part. Omitted when the part completed normally and set to
incompletewhen generation was interrupted.
-
_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.
-
_part
final JsonField<BetaResponseReasoningSummaryPartDoneEvent.Part> _part()
Returns the raw JSON value of part.
Unlike part, 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.
-
_summaryIndex
final JsonField<Long> _summaryIndex()
Returns the raw JSON value of summaryIndex.
Unlike summaryIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_agent
final JsonField<BetaResponseReasoningSummaryPartDoneEvent.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<BetaResponseReasoningSummaryPartDoneEvent.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseReasoningSummaryPartDoneEvent.Builder toBuilder()
-
validate
final BetaResponseReasoningSummaryPartDoneEvent 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 BetaResponseReasoningSummaryPartDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseReasoningSummaryPartDoneEvent.
The following fields are required:
.itemId() .outputIndex() .part() .sequenceNumber() .summaryIndex()
-
-
-
-