Class: OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_conversation_item_function_call.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(arguments:, name:, id: nil, call_id: nil, object: nil, status: nil, type: :function_call) ⇒ Object

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

A function call item in a Realtime conversation.

Parameters:

  • arguments (String) —

    The arguments of the function call. This is a JSON-encoded string representing t

  • name (String) —

    The name of the function being called.

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

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

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

    The ID of the function call.

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

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

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

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

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

    The type of the item. Always ‘function_call`.




# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 53

Instance Attribute Details

#arguments ⇒ String

The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example ‘“value1”, “arg2”: 42`.

Returns:

  • (String) 


13
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 13

required :arguments, String

#call_id ⇒ String?

The ID of the function call.

Returns:

  • (String, nil) 


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

optional :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) 


32
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 32

optional :id, String

#name ⇒ String

The name of the function being called.

Returns:

  • (String) 


19
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 19

required :name, String

#object ⇒ Symbol, ...

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

Returns:



45
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 45

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

#status ⇒ Symbol, ...

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

Returns:



51
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 51

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

#type ⇒ Symbol, :function_call

The type of the item. Always ‘function_call`.

Returns:

  • (Symbol, :function_call) 


25
 
# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 25

required :type, const: :function_call

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/realtime/realtime_conversation_item_function_call.rb', line 83