Class: OpenAI::Models::ResponseFormatJSONSchema

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/response_format_json_schema.rb,
sig/openai/models/response_format_json_schema.rbs

Defined Under Namespace

Classes: JSONSchema

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

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

Parameters:

  • json_schema —

    Structured Outputs configuration options, including a JSON Schema.

  • type (defaults to: :json_schema) —

    The type of response format being defined. Always json_schema.




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

Instance Attribute Details

#json_schema ⇒ OpenAI::ResponseFormatJSONSchema::JSONSchema

Structured Outputs configuration options, including a JSON Schema.

Returns:

  • (OpenAI::ResponseFormatJSONSchema::JSONSchema) 


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

required :json_schema, -> { OpenAI::ResponseFormatJSONSchema::JSONSchema }

#type ⇒ :json_schema

The type of response format being defined. Always json_schema.

Returns:

  • (:json_schema) 


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

required :type, const: :json_schema

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


25
 
# File 'sig/openai/models/response_format_json_schema.rbs', line 25

def to_hash: -> {