Class: OpenAI::Models::CustomToolInputFormat::Grammar

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

Defined Under Namespace

Modules: Syntax

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, 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::CustomToolInputFormat::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/custom_tool_input_format.rb', line 49

Instance Attribute Details

#definition ⇒ String

The grammar definition.

Returns:

  • (String) 


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

required :definition, String

#syntax ⇒ Symbol, OpenAI::Models::CustomToolInputFormat::Grammar::Syntax

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

Returns:



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

required :syntax, enum: -> { OpenAI::CustomToolInputFormat::Grammar::Syntax }

#type ⇒ Symbol, :grammar

Grammar format. Always ‘grammar`.

Returns:

  • (Symbol, :grammar) 


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

required :type, const: :grammar