Class: OpenAI::Models::Beta::Threads::Runs::FunctionToolCall::Function

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/threads/runs/function_tool_call.rb

Overview

See Also:

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, 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: , output: ) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::Threads::Runs::FunctionToolCall::Function for more details.

The definition of the function that was called.

Parameters:

  • arguments (String) (defaults to: ) —

    The arguments passed to the function.

  • name (String) (defaults to: ) —

    The name of the function.

  • output (String, nil) (defaults to: ) —

    The output of the function. This will be ‘null` if the outputs have not been [su




# File 'lib/openai/models/beta/threads/runs/function_tool_call.rb', line 60

Instance Attribute Details

#arguments ⇒ String

The arguments passed to the function.

Returns:

  • (String) 


44
 
# File 'lib/openai/models/beta/threads/runs/function_tool_call.rb', line 44

required :arguments, String

#name ⇒ String

The name of the function.

Returns:

  • (String) 


50
 
# File 'lib/openai/models/beta/threads/runs/function_tool_call.rb', line 50

required :name, String

#output ⇒ String?

The output of the function. This will be ‘null` if the outputs have not been [submitted](platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet.

Returns:

  • (String, nil) 


58
 
# File 'lib/openai/models/beta/threads/runs/function_tool_call.rb', line 58

required :output, String, nil?: true