class

OpenAI::ResponseFormatJsonSchema

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 : ResponseFormatJsonSchemaType = ResponseFormatJsonSchemaType::JsonSchema, json_schema : ResponseFormatJsonSchemaJsonSchema = ResponseFormatJsonSchemaJsonSchema.new)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

json_schema

Structured Outputs configuration options, including a JSON Schema.

Source
json_schema=(json_schema : ResponseFormatJsonSchemaJsonSchema)

Structured Outputs configuration options, including a JSON Schema.

Source
type_value

The type of response format being defined. Always json_schema.

Source
type_value=(type_value : ResponseFormatJsonSchemaType)

The type of response format being defined. Always json_schema.

Source