AIJsonUtilities.CreateJsonSchema Methode

Definition

Erstellt ein JSON-Schema für den angegebenen Typ.

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

Parameter

type
Type

Der Typ, für den das Schema generiert werden soll.

description
String

Die Beschreibung des Parameters.

hasDefaultValue
Boolean

truewenn der Parameter optional ist; andernfalls . false

defaultValue
Object

Der Standardwert des optionalen Parameters, falls zutreffend.

serializerOptions
JsonSerializerOptions

Die Optionen zum Extrahieren des Schemas aus dem angegebenen Typ.

inferenceOptions
AIJsonSchemaCreateOptions

Die Optionen zur Steuerung der Schemaerstellung.

Gibt zurück

A JsonElement representing the schema.

Hinweise

Verwendet einen Cacheschlüssel, der im serializerOptions Schemaergebnis gespeichert wird, es sei denn, ein TransformSchemaNode Delegat wurde angegeben.

Gilt für: