class

OpenAI::ResponseFormatJsonSchemaJsonSchema

Inherits JSON::Serializable < Reference < Object

Structured Outputs configuration options, including a JSON Schema.

Constructors

new(pull : JSON::PullParser)
Source
new(description : String | Nil = nil, name : String = "", schema : ResponseFormatJsonSchemaSchema | Nil = nil, strict : ResponseFormatJsonSchemaJsonSchemaStrict | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

description

A description of what the response format is for, used by the model to determine how to respond in the format.

Source
description=(description : String | Nil)

A description of what the response format is for, used by the model to determine how to respond in the format.

Source
name

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Source
name=(name : String)

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Source
schema
Source
schema=(schema : ResponseFormatJsonSchemaSchema | Nil)
Source
strict
Source
strict=(strict : ResponseFormatJsonSchemaJsonSchemaStrict | Nil)
Source