Class RealtimeConversationItemFunctionCallOutput
-
- All Implemented Interfaces:
public final class RealtimeConversationItemFunctionCallOutput
A function call output item in a Realtime conversation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RealtimeConversationItemFunctionCallOutput.Builder
A builder for RealtimeConversationItemFunctionCallOutput.
public final class
RealtimeConversationItemFunctionCallOutput.Object
Identifier for the API object being returned - always
realtime.item
. Optional when creating a new item.public final class
RealtimeConversationItemFunctionCallOutput.Status
The status of the item. Has no effect on the conversation.
-
Method Summary
Modifier and Type Method Description final String
callId()
The ID of the function call this output is for. final String
output()
The output of the function call, this is free text and can contain any information or simply be empty. final JsonValue
_type()
The type of the item. final Optional<String>
id()
The unique ID of the item. final Optional<RealtimeConversationItemFunctionCallOutput.Object>
object_()
Identifier for the API object being returned - always realtime.item
.final Optional<RealtimeConversationItemFunctionCallOutput.Status>
status()
The status of the item. final JsonField<String>
_callId()
Returns the raw JSON value of callId. final JsonField<String>
_output()
Returns the raw JSON value of output. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<RealtimeConversationItemFunctionCallOutput.Object>
_object_()
Returns the raw JSON value of object_. final JsonField<RealtimeConversationItemFunctionCallOutput.Status>
_status()
Returns the raw JSON value of status. final Map<String, JsonValue>
_additionalProperties()
final RealtimeConversationItemFunctionCallOutput.Builder
toBuilder()
final RealtimeConversationItemFunctionCallOutput
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RealtimeConversationItemFunctionCallOutput.Builder
builder()
Returns a mutable builder for constructing an instance of RealtimeConversationItemFunctionCallOutput. -
-
Method Detail
-
output
final String output()
The output of the function call, this is free text and can contain any information or simply be empty.
-
_type
final JsonValue _type()
The type of the item. Always
function_call_output
.Expected to always return the following:
JsonValue.from("function_call_output")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
id
final Optional<String> id()
The unique ID of the item. This may be provided by the client or generated by the server.
-
object_
final Optional<RealtimeConversationItemFunctionCallOutput.Object> object_()
Identifier for the API object being returned - always
realtime.item
. Optional when creating a new item.
-
status
final Optional<RealtimeConversationItemFunctionCallOutput.Status> status()
The status of the item. Has no effect on the conversation.
-
_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.
-
_output
final JsonField<String> _output()
Returns the raw JSON value of output.
Unlike output, this method doesn't throw if the JSON field has an unexpected type.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_object_
final JsonField<RealtimeConversationItemFunctionCallOutput.Object> _object_()
Returns the raw JSON value of object_.
Unlike object_, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<RealtimeConversationItemFunctionCallOutput.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 RealtimeConversationItemFunctionCallOutput.Builder toBuilder()
-
validate
final RealtimeConversationItemFunctionCallOutput validate()
-
builder
final static RealtimeConversationItemFunctionCallOutput.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeConversationItemFunctionCallOutput.
The following fields are required:
.callId() .output()
-
-
-
-