A function call item in a Realtime conversation.
Constructors
new(id :
String |
Nil = nil, object :
RealtimeConversationItemFunctionCallObject |
Nil = nil, type_value :
RealtimeConversationItemFunctionCallType =
RealtimeConversationItemFunctionCallType::FunctionCall, status :
RealtimeConversationItemFunctionCallStatus |
Nil = nil, call_id :
String |
Nil = nil, name :
String = "", arguments :
String = "")
SourceInstance methods
arguments
The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example {"arg1": "value1", "arg2": 42}.
arguments=(arguments :
String)
The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example {"arg1": "value1", "arg2": 42}.
call_id
The ID of the function call.
call_id=(call_id :
String |
Nil)
The ID of the function call.
id
The unique ID of the item. This may be provided by the client or generated by the server.
The unique ID of the item. This may be provided by the client or generated by the server.
name
The name of the function being called.
The name of the function being called.
object
Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
object=(object : RealtimeConversationItemFunctionCallObject | Nil)
Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
status
The status of the item. Has no effect on the conversation.
status=(status : RealtimeConversationItemFunctionCallStatus | Nil)
The status of the item. Has no effect on the conversation.
type_value
The type of the item. Always function_call.
type_value=(type_value : RealtimeConversationItemFunctionCallType)
The type of the item. Always function_call.