Class: OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom

Defined in:

lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb

Defined Under Namespace

Classes: Custom

Instance Attribute Summary

• #custom ⇒ OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom
• #type ⇒ Symbol, :custom

  For custom tool calling, the type is always ‘custom`.

Instance Method Summary

• #initialize(custom:, type: :custom) ⇒ Object constructor

  Specifies a tool the model should use.

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

Specifies a tool the model should use. Use to force the model to call a specific custom tool.

Parameters:

• custom (OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom)
• type (Symbol, :custom) (defaults to: :custom) —

  For custom tool calling, the type is always ‘custom`.

# File 'lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb', line 18

Instance Attribute Details

#custom ⇒ OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom

Returns:

• (OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom)

# File 'lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb', line 10

required :custom, -> { OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom }

#type ⇒ Symbol, :custom

For custom tool calling, the type is always ‘custom`.

Returns:

• (Symbol, :custom)

# File 'lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb', line 16

required :type, const: :custom