Class: OpenAI::Models::ResponseFormatTextGrammar

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::ResponseFormatTextGrammar

Defined in:

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

Instance Attribute Summary

• #grammar ⇒ String

  The custom grammar for the model to follow.

• #type ⇒ :grammar

  The type of response format being defined.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(grammar:, type: :grammar) ⇒ ResponseFormatTextGrammar constructor

  A new instance of ResponseFormatTextGrammar.

• #to_hash ⇒ { grammar: String, ?type: :grammar }

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(grammar:, type: :grammar) ⇒ ResponseFormatTextGrammar

Returns a new instance of ResponseFormatTextGrammar.

Parameters:

• grammar —

  The custom grammar for the model to follow.

• type (defaults to: :grammar) —

  The type of response format being defined. Always grammar.

• grammar: (String)
• type: (:grammar) (defaults to: :grammar)

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

Instance Attribute Details

#grammar ⇒ String

The custom grammar for the model to follow.

Returns:

• (String)

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

required :grammar, String

#type ⇒ :grammar

The type of response format being defined. Always grammar.

Returns:

• (:grammar)

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

required :type, const: :grammar

Instance Method Details

#to_hash ⇒ { grammar: String, ?type: :grammar }

Returns:

• ({ grammar: String, ?type: :grammar })

# File 'sig/openai/models/response_format_text_grammar.rbs', line 18

def to_hash: -> { grammar: String, ?type: :grammar }