Class: OpenAI::Models::Beta::TextFormatParam::JSONSchema

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::TextFormatParam::JSONSchema

Defined in:

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

Instance Attribute Summary

• #schema ⇒ Hash{Symbol=>Object}

  The JSON Schema that generated text must match.

• #type ⇒ Symbol, :json_schema

  The type of the object.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(schema:, type: :json_schema) ⇒ Object constructor

  Constrains generated text to a JSON Schema.

• #to_hash ⇒ { schema: ::Hash[Symbol, top], ?type: :json_schema }

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(schema:, type: :json_schema) ⇒ Object

Constrains generated text to a JSON Schema.

Parameters:

• schema (Hash{Symbol=>Object}) —

  The JSON Schema that generated text must match.

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

  The type of the object. Always json_schema.

# File 'lib/openai/models/beta/text_format_param.rb', line 45

Instance Attribute Details

#schema ⇒ Hash{Symbol=>Object}

The JSON Schema that generated text must match.

Parameters:

• value (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object})

# File 'lib/openai/models/beta/text_format_param.rb', line 37

required :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]

#type ⇒ Symbol, :json_schema

The type of the object. Always json_schema.

Parameters:

• value (:json_schema)

Returns:

• (Symbol, :json_schema)

# File 'lib/openai/models/beta/text_format_param.rb', line 43

required :type, const: :json_schema

Instance Method Details

#to_hash ⇒ { schema: ::Hash[Symbol, top], ?type: :json_schema }

Returns:

• ({ schema: ::Hash[Symbol, top], ?type: :json_schema })

# File 'sig/openai/models/beta/text_format_param.rbs', line 33

def to_hash: -> { schema: ::Hash[Symbol, top], ?type: :json_schema }