Class ResponseFunctionCallArgumentsDoneEvent
-
- All Implemented Interfaces:
public final class ResponseFunctionCallArgumentsDoneEvent
Emitted when function-call arguments are finalized.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFunctionCallArgumentsDoneEvent.Builder
A builder for ResponseFunctionCallArgumentsDoneEvent.
-
Method Summary
Modifier and Type Method Description final String
arguments()
The function-call arguments. final String
itemId()
The ID of the item. final String
name()
The name of the function that was called. final Long
outputIndex()
The index of the output item. final Long
sequenceNumber()
The sequence number of this event. final JsonValue
_type()
Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("response.function_call_arguments.done")
final JsonField<String>
_arguments()
Returns the raw JSON value of arguments. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<String>
_name()
Returns the raw JSON value of name. 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 ResponseFunctionCallArgumentsDoneEvent.Builder
toBuilder()
final ResponseFunctionCallArgumentsDoneEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFunctionCallArgumentsDoneEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFunctionCallArgumentsDoneEvent. -
-
Method Detail
-
outputIndex
final Long outputIndex()
The index of the output item.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("response.function_call_arguments.done")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_arguments
final JsonField<String> _arguments()
Returns the raw JSON value of arguments.
Unlike arguments, 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.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, 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 ResponseFunctionCallArgumentsDoneEvent.Builder toBuilder()
-
validate
final ResponseFunctionCallArgumentsDoneEvent validate()
-
builder
final static ResponseFunctionCallArgumentsDoneEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFunctionCallArgumentsDoneEvent.
The following fields are required:
.arguments() .itemId() .name() .outputIndex() .sequenceNumber()
-
-
-
-