class

OpenAI::TextResponseFormatJsonSchema

Inherits JSON::Serializable < Reference < Object

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

Constructors

new(pull : JSON::PullParser)
Source
new(type_value : TextResponseFormatJsonSchemaType = TextResponseFormatJsonSchemaType::JsonSchema, description : String | Nil = nil, name : String = "", schema : ResponseFormatJsonSchemaSchema = ResponseFormatJsonSchemaSchema.new, strict : TextResponseFormatJsonSchemaStrict | 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)
Source
strict
Source
strict=(strict : TextResponseFormatJsonSchemaStrict | Nil)
Source
type_value

The type of response format being defined. Always json_schema.

Source
type_value=(type_value : TextResponseFormatJsonSchemaType)

The type of response format being defined. Always json_schema.

Source