Class: OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb

Defined Under Namespace

Modules: Object, Status

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(call_id:, output:, id: nil, object: nil, status: nil, type: :function_call_output) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput for more details.

A function call output item in a Realtime conversation.

Parameters:

  • call_id (String) —

    The ID of the function call this output is for.

  • output (String) —

    The output of the function call, this is free text and can contain any informati

  • id (String) (defaults to: nil) —

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

  • object (Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object) (defaults to: nil) —

    Identifier for the API object being returned - always ‘realtime.item`. Optional

  • status (Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status) (defaults to: nil) —

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

  • type (Symbol, :function_call_output) (defaults to: :function_call_output) —

    The type of the item. Always ‘function_call_output`.




# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 46

Instance Attribute Details

#call_id ⇒ String

The ID of the function call this output is for.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 11

required :call_id, String

#id ⇒ String?

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

Returns:

  • (String, nil) 


31
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 31

optional :id, String

#object ⇒ Symbol, ...

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

Returns:



38
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 38

optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Object }

#output ⇒ String

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

Returns:

  • (String) 


18
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 18

required :output, String

#status ⇒ Symbol, ...

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

Returns:



44
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 44

optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Status }

#type ⇒ Symbol, :function_call_output

The type of the item. Always ‘function_call_output`.

Returns:

  • (Symbol, :function_call_output) 


24
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 24

required :type, const: :function_call_output

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb', line 74