AIJsonUtilities.CreateJsonSchema Método

Definição

Cria um esquema JSON para o 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

O tipo para o qual gerar o esquema.

description
String

A descrição do parâmetro.

hasDefaultValue
Boolean

true se o parâmetro for opcional; caso contrário, false.

defaultValue
Object

O valor padrão do parâmetro opcional, se aplicável.

serializerOptions
JsonSerializerOptions

As opções usadas para extrair o esquema do tipo especificado.

inferenceOptions
AIJsonSchemaCreateOptions

As opções que controlam a criação de esquema.

Retornos

Um JsonElement que representa o esquema.

Comentários

Usa um cache com chave no resultado do serializerOptions esquema para armazenar, a menos que um TransformSchemaNode delegado tenha sido especificado.

Aplica-se a