class

OpenAI::RealtimeConversationItemFunctionCallOutput

Inherits JSON::Serializable < Reference < Object

A function call output item in a Realtime conversation.

Constructors

new(pull : JSON::PullParser)
Source
new(id : String | Nil = nil, object : RealtimeConversationItemFunctionCallOutputObject | Nil = nil, type_value : RealtimeConversationItemFunctionCallOutputType = RealtimeConversationItemFunctionCallOutputType::FunctionCallOutput, status : RealtimeConversationItemFunctionCallOutputStatus | Nil = nil, call_id : String = "", output : String = "")
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

call_id

The ID of the function call this output is for.

Source
call_id=(call_id : String)

The ID of the function call this output is for.

Source
id

The unique ID of the item. This may be provided by the client or generated by the server.

Source
id=(id : String | Nil)

The unique ID of the item. This may be provided by the client or generated by the server.

Source
object

Identifier for the API object being returned - always realtime.item. Optional when creating a new item.

Source
object=(object : RealtimeConversationItemFunctionCallOutputObject | Nil)

Identifier for the API object being returned - always realtime.item. Optional when creating a new item.

Source
output

The output of the function call, this is free text and can contain any information or simply be empty.

Source
output=(output : String)

The output of the function call, this is free text and can contain any information or simply be empty.

Source
status

The status of the item. Has no effect on the conversation.

Source
status=(status : RealtimeConversationItemFunctionCallOutputStatus | Nil)

The status of the item. Has no effect on the conversation.

Source
type_value

The type of the item. Always function_call_output.

Source
type_value=(type_value : RealtimeConversationItemFunctionCallOutputType)

The type of the item. Always function_call_output.

Source