Class ResponseCustomToolCallInputDoneEvent
-
- All Implemented Interfaces:
public final class ResponseCustomToolCallInputDoneEvent
Event indicating that input for a custom tool call is complete.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseCustomToolCallInputDoneEvent.Builder
A builder for ResponseCustomToolCallInputDoneEvent.
-
Method Summary
Modifier and Type Method Description final String
input()
The complete input data for the custom tool call. final String
itemId()
Unique identifier for the API item associated with this event. final Long
outputIndex()
The index of the output this event applies to. final Long
sequenceNumber()
The sequence number of this event. final JsonValue
_type()
The event type identifier. 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 Map<String, JsonValue>
_additionalProperties()
final ResponseCustomToolCallInputDoneEvent.Builder
toBuilder()
final ResponseCustomToolCallInputDoneEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseCustomToolCallInputDoneEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCallInputDoneEvent. -
-
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).
-
_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseCustomToolCallInputDoneEvent.Builder toBuilder()
-
validate
final ResponseCustomToolCallInputDoneEvent validate()
-
builder
final static ResponseCustomToolCallInputDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCallInputDoneEvent.
The following fields are required:
.input() .itemId() .outputIndex() .sequenceNumber()
-
-
-
-