Class: OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar

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

Overview

See Also:

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:) ⇒ Object

Your chosen grammar.

Parameters:




# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 127

Instance Attribute Details

#definition ⇒ String

The grammar definition.

Returns:

  • (String) 


118
 
# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 118

required :definition, String

#syntax ⇒ Symbol, OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax

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

Returns:



124
125
 
# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 124

required :syntax,
enum: -> { OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax }