Class: OpenAI::Models::Chat::ChatCompletionMessageToolCall::Function

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/chat/chat_completion_message_tool_call.rb

Overview

See Also:

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#arguments ⇒ String

The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

Returns:

  • (String) 


41
 
# File 'lib/openai/models/chat/chat_completion_message_tool_call.rb', line 41

required :arguments, String

#name ⇒ String

The name of the function to call.

Returns:

  • (String) 


53
 
# File 'lib/openai/models/chat/chat_completion_message_tool_call.rb', line 53

required :name, String

#parsed ⇒ Object?

The parsed contents of the arguments.

Returns:

  • (Object, nil) 


47
 
# File 'lib/openai/models/chat/chat_completion_message_tool_call.rb', line 47

required :parsed, OpenAI::Internal::Type::Unknown