Class JsonSchema

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

https://platform.openai.com/docs/guides/structured-outputs
https://json-schema.org/overview/what-is-jsonschema

public sealed class JsonSchema

Inheritance

object

JsonSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

JsonSchema()

public JsonSchema()

JsonSchema(string, string, string, bool)

public JsonSchema(string name, string schema, string description = null, bool strict = true)

Parameters

name string

schema string

description string

strict bool

JsonSchema(string, JsonNode, string, bool)

Constructor.

public JsonSchema(string name, JsonNode schema, string description = null, bool strict = true)

Parameters

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.

schema JsonNode

The schema for the response format, described as a JSON Schema object.

description string

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

strict bool

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.

Properties

Description

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

[JsonInclude]
[JsonPropertyName("description")]
public string Description { get; }

Property Value

string

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.

[JsonInclude]
[JsonPropertyName("name")]
public string Name { get; }

Property Value

string

Schema

The schema for the response format, described as a JSON Schema object.

[JsonInclude]
[JsonPropertyName("schema")]
public JsonNode Schema { get; }

Property Value

JsonNode

Strict

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field.

[JsonInclude]
[JsonPropertyName("strict")]
public bool Strict { get; }

Property Value

bool

Remarks

Only a subset of JSON Schema is supported when strict is true.

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator ResponseFormatObject(JsonSchema)

public static implicit operator ResponseFormatObject(JsonSchema jsonSchema)

Parameters

jsonSchema JsonSchema

Returns

ResponseFormatObject

implicit operator JsonSchema(Type)

public static implicit operator JsonSchema(Type type)

Parameters

type Type

Returns

JsonSchema