Class ResponseFunctionCallArgumentsDoneEvent
-
- All Implemented Interfaces:
public final class ResponseFunctionCallArgumentsDoneEvent
Returned when the model-generated function call arguments are done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.
-
-
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 final arguments as a JSON string. final String
callId()
The ID of the function call. final String
eventId()
The unique ID of the server event. final String
itemId()
The ID of the function call item. final Long
outputIndex()
The index of the output item in the response. final String
responseId()
The ID of the response. final JsonValue
_type()
The event type, must be response.function_call_arguments.done
.final JsonField<String>
_arguments()
Returns the raw JSON value of arguments. final JsonField<String>
_callId()
Returns the raw JSON value of callId. final JsonField<String>
_eventId()
Returns the raw JSON value of eventId. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_outputIndex()
Returns the raw JSON value of outputIndex. final JsonField<String>
_responseId()
Returns the raw JSON value of responseId. 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 in the response.
-
responseId
final String responseId()
The ID of the response.
-
_type
final JsonValue _type()
The event type, must be
response.function_call_arguments.done
.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.
-
_callId
final JsonField<String> _callId()
Returns the raw JSON value of callId.
Unlike callId, this method doesn't throw if the JSON field has an unexpected type.
-
_eventId
final JsonField<String> _eventId()
Returns the raw JSON value of eventId.
Unlike eventId, 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.
-
_responseId
final JsonField<String> _responseId()
Returns the raw JSON value of responseId.
Unlike responseId, 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() .callId() .eventId() .itemId() .outputIndex() .responseId()
-
-
-
-