Class: OpenAI::Models::ResponseFormatJSONSchema

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

Defined Under Namespace

Classes: JSONSchema

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, 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

Some parameter documentations has been truncated, see OpenAI::Models::ResponseFormatJSONSchema for more details.

JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](platform.openai.com/docs/guides/structured-outputs).

Parameters:

  • json_schema (OpenAI::Models::ResponseFormatJSONSchema::JSONSchema) (defaults to: ) —

    Structured Outputs configuration options, including a JSON Schema.

  • type (Symbol, :json_schema) (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::Models::ResponseFormatJSONSchema::JSONSchema

Structured Outputs configuration options, including a JSON Schema.

Returns:



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

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

#type ⇒ Symbol, :json_schema

The type of response format being defined. Always ‘json_schema`.

Returns:

  • (Symbol, :json_schema) 


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

required :type, const: :json_schema