Class: OpenAI::Models::Beta::Threads::RequiredActionFunctionToolCall

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

Defined Under Namespace

Classes: Function

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(id: , function: , type: :function) ⇒ Object

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

Tool call objects

Parameters:

  • id (String) (defaults to: ) —

    The ID of the tool call. This ID must be referenced when you submit the tool out

  • function (OpenAI::Models::Beta::Threads::RequiredActionFunctionToolCall::Function) (defaults to: ) —

    The function definition.

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

    The type of tool call the output is required for. For now, this is always ‘funct




# File 'lib/openai/models/beta/threads/required_action_function_tool_call.rb', line 30

Instance Attribute Details

#function ⇒ OpenAI::Models::Beta::Threads::RequiredActionFunctionToolCall::Function

The function definition.

Returns:



21
 
# File 'lib/openai/models/beta/threads/required_action_function_tool_call.rb', line 21

required :function, -> { OpenAI::Beta::Threads::RequiredActionFunctionToolCall::Function }

#id ⇒ String

The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint.

Returns:

  • (String) 


15
 
# File 'lib/openai/models/beta/threads/required_action_function_tool_call.rb', line 15

required :id, String

#type ⇒ Symbol, :function

The type of tool call the output is required for. For now, this is always ‘function`.

Returns:

  • (Symbol, :function) 


28
 
# File 'lib/openai/models/beta/threads/required_action_function_tool_call.rb', line 28

required :type, const: :function