Module: OpenAI::Models::CustomToolInputFormat

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/custom_tool_input_format.rb,
sig/openai/models/custom_tool_input_format.rbs

Overview

The input format for the custom tool. Default is unconstrained text.

Defined Under Namespace

Classes: Grammar, Text

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::CustomToolInputFormat::Text, OpenAI::Models::CustomToolInputFormat::Grammar)

Instance Method Summary

• #initialize(type: :text) ⇒ Object

  Unconstrained free-form text.

• #self?.variants ⇒ ::Array[OpenAI::Models::custom_tool_input_format]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::CustomToolInputFormat::Text, OpenAI::Models::CustomToolInputFormat::Grammar)

Returns:

• (Array(OpenAI::Models::CustomToolInputFormat::Text, OpenAI::Models::CustomToolInputFormat::Grammar))

# File 'lib/openai/models/custom_tool_input_format.rb', line 72

Instance Method Details

#initialize(type: :text) ⇒ Object

Unconstrained free-form text.

Parameters:

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

  Unconstrained text format. Always text.

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

#self?.variants ⇒ ::Array[OpenAI::Models::custom_tool_input_format]

Returns:

• (::Array[OpenAI::Models::custom_tool_input_format])

# File 'sig/openai/models/custom_tool_input_format.rbs', line 58

def self?.variants: -> ::Array[OpenAI::Models::custom_tool_input_format]