Class: OpenAI::Models::Beta::BetaCustomTool::Format::Grammar

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::BetaCustomTool::Format::Grammar

Defined in:

lib/openai/models/beta/beta_custom_tool.rb,
sig/openai/models/beta/beta_custom_tool.rbs

Defined Under Namespace

Modules: Syntax

Instance Attribute Summary

• #definition ⇒ String

  The grammar definition.

• #syntax ⇒ Symbol, OpenAI::Models::Beta::BetaCustomTool::Format::Grammar::Syntax

  The syntax of the grammar definition.

• #type ⇒ Symbol, :grammar

  Grammar format.

Instance Method Summary

• #initialize(definition:, syntax:, type: :grammar) ⇒ Object constructor

  A grammar defined by the user.

• #to_hash ⇒ {

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(definition:, syntax:, type: :grammar) ⇒ Object

A grammar defined by the user.

Parameters:

• definition (String) —

  The grammar definition.

• syntax (Symbol, OpenAI::Models::Beta::BetaCustomTool::Format::Grammar::Syntax) —

  The syntax of the grammar definition. One of lark or regex.

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

  Grammar format. Always grammar.

# File 'lib/openai/models/beta/beta_custom_tool.rb', line 117

Instance Attribute Details

#definition ⇒ String

The grammar definition.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/beta/beta_custom_tool.rb', line 103

required :definition, String

#syntax ⇒ Symbol, OpenAI::Models::Beta::BetaCustomTool::Format::Grammar::Syntax

The syntax of the grammar definition. One of lark or regex.

Parameters:

• value (OpenAI::Models::Beta::BetaCustomTool::Format::Grammar::syntax)

Returns:

• (Symbol, OpenAI::Models::Beta::BetaCustomTool::Format::Grammar::Syntax)

# File 'lib/openai/models/beta/beta_custom_tool.rb', line 109

required :syntax, enum: -> { OpenAI::Beta::BetaCustomTool::Format::Grammar::Syntax }

#type ⇒ Symbol, :grammar

Grammar format. Always grammar.

Parameters:

• value (:grammar)

Returns:

• (Symbol, :grammar)

# File 'lib/openai/models/beta/beta_custom_tool.rb', line 115

required :type, const: :grammar

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/beta_custom_tool.rbs', line 103

def to_hash: -> {