Class: OpenAI::Models::Realtime::RealtimeFunctionTool

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

Defined Under Namespace

Modules: Type

Instance Attribute 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(description: nil, name: nil, parameters: nil, type: nil) ⇒ Object

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




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

Instance Attribute Details

#description ⇒ String?

The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).



12
 
# File 'lib/openai/models/realtime/realtime_function_tool.rb', line 12

optional :description, String

#name ⇒ String?

The name of the function.



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

optional :name, String

#parameters ⇒ Object?

Parameters of the function in JSON Schema.



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

optional :parameters, OpenAI::Internal::Type::Unknown

#type ⇒ Symbol, ...

The type of the tool, i.e. ‘function`.



30
 
# File 'lib/openai/models/realtime/realtime_function_tool.rb', line 30

optional :type, enum: -> { OpenAI::Realtime::RealtimeFunctionTool::Type }