AIJsonUtilities.CreateJsonSchema Método

Definición

Crea un esquema JSON para el tipo especificado.

public static System.Text.Json.JsonElement CreateJsonSchema(Type? type, string? description = default, bool hasDefaultValue = false, object? defaultValue = default, System.Text.Json.JsonSerializerOptions? serializerOptions = default, Microsoft.Extensions.AI.AIJsonSchemaCreateOptions? inferenceOptions = default);
static member CreateJsonSchema : Type * string * bool * obj * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.AIJsonSchemaCreateOptions -> System.Text.Json.JsonElement
Public Function CreateJsonSchema (type As Type, Optional description As String = Nothing, Optional hasDefaultValue As Boolean = false, Optional defaultValue As Object = Nothing, Optional serializerOptions As JsonSerializerOptions = Nothing, Optional inferenceOptions As AIJsonSchemaCreateOptions = Nothing) As JsonElement

Parámetros

type
Type

Tipo para el que se va a generar el esquema.

description
String

Descripción del parámetro .

hasDefaultValue
Boolean

true si el parámetro es opcional; de lo contrario, false.

defaultValue
Object

Valor predeterminado del parámetro opcional, si procede.

serializerOptions
JsonSerializerOptions

Las opciones usadas para extraer el esquema del tipo especificado.

inferenceOptions
AIJsonSchemaCreateOptions

Opciones que controlan la creación del esquema.

Devoluciones

que JsonElement representa el esquema.

Comentarios

Usa una caché con clave en para almacenar el resultado del serializerOptions esquema, a menos que se haya especificado un TransformSchemaNode delegado.

Se aplica a