Class BetaResponseCustomToolCallInputDoneEvent
-
- All Implemented Interfaces:
public final class BetaResponseCustomToolCallInputDoneEventEvent indicating that input for a custom tool call is complete.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseCustomToolCallInputDoneEvent.BuilderA builder for BetaResponseCustomToolCallInputDoneEvent.
public final classBetaResponseCustomToolCallInputDoneEvent.AgentThe agent that owns this multi-agent streaming event.
-
Method Summary
Modifier and Type Method Description final Stringinput()The complete input data for the custom tool call. final StringitemId()Unique identifier for the API item associated with this event. final LongoutputIndex()The index of the output this event applies to. final LongsequenceNumber()The sequence number of this event. final JsonValue_type()The event type identifier. final Optional<BetaResponseCustomToolCallInputDoneEvent.Agent>agent()The agent that owns this multi-agent streaming event. final JsonField<String>_input()Returns the raw JSON value of input. 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 JsonField<BetaResponseCustomToolCallInputDoneEvent.Agent>_agent()Returns the raw JSON value of agent. final Map<String, JsonValue>_additionalProperties()final BetaResponseCustomToolCallInputDoneEvent.BuildertoBuilder()final BetaResponseCustomToolCallInputDoneEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseCustomToolCallInputDoneEvent.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseCustomToolCallInputDoneEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output this event applies to.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
The event type identifier.
Expected to always return the following:
JsonValue.from("response.custom_tool_call_input.done")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseCustomToolCallInputDoneEvent.Agent> agent()
The agent that owns this multi-agent streaming event.
-
_input
final JsonField<String> _input()
Returns the raw JSON value of input.
Unlike input, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_agent
final JsonField<BetaResponseCustomToolCallInputDoneEvent.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 BetaResponseCustomToolCallInputDoneEvent.Builder toBuilder()
-
validate
final BetaResponseCustomToolCallInputDoneEvent 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 BetaResponseCustomToolCallInputDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseCustomToolCallInputDoneEvent.
The following fields are required:
.input() .itemId() .outputIndex() .sequenceNumber()
-
-
-
-