ChatResponseFormat.ForJsonSchema Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit dem angegebenen Schema.
Überlädt
| Name | Beschreibung |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit dem angegebenen Schema. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit einem Schema basierend auf |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit einem Schema basierend auf |
ForJsonSchema(JsonElement, String, String)
- Quelle:
- ChatResponseFormat.cs
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit dem angegebenen Schema.
public static Microsoft.Extensions.AI.ChatResponseFormatJson ForJsonSchema(System.Text.Json.JsonElement schema, string? schemaName = default, string? schemaDescription = default);static member ForJsonSchema : System.Text.Json.JsonElement * string * string -> Microsoft.Extensions.AI.ChatResponseFormatJsonPublic Shared Function ForJsonSchema (schema As JsonElement, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJsonParameter
- schema
- JsonElement
Das JSON-Schema.
- schemaName
- String
Optionaler Name des Schemas. Wenn das Schema beispielsweise eine bestimmte Klasse darstellt, kann dies der Name der Klasse sein.
- schemaDescription
- String
Eine optionale Beschreibung des Schemas.
Gibt zurück
Die ChatResponseFormatJson-Instanz.
Gilt für:
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Quelle:
- ChatResponseFormat.cs
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit einem Schema basierend auf schemaType.
public static Microsoft.Extensions.AI.ChatResponseFormatJson ForJsonSchema(Type schemaType, System.Text.Json.JsonSerializerOptions? serializerOptions = default, string? schemaName = default, string? schemaDescription = default);static member ForJsonSchema : Type * System.Text.Json.JsonSerializerOptions * string * string -> Microsoft.Extensions.AI.ChatResponseFormatJsonPublic Shared Function ForJsonSchema (schemaType As Type, Optional serializerOptions As JsonSerializerOptions = Nothing, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJsonParameter
- schemaType
- Type
Das Type Schema, für das ein Schema exportiert und als Antwortschema verwendet werden soll.
- serializerOptions
- JsonSerializerOptions
Die zu verwendenden JSON-Serialisierungsoptionen.
- schemaName
- String
Optionaler Name des Schemas. Standardmäßig wird dies von schemaType.
- schemaDescription
- String
Eine optionale Beschreibung des Schemas. Standardmäßig wird dies von schemaType.
Gibt zurück
Die ChatResponseFormatJson-Instanz.
Ausnahmen
schemaType ist null.
Hinweise
Viele KI-Dienste, die strukturierte Ausgabe unterstützen, erfordern, dass das JSON-Schema über ein "type=object" der obersten Ebene verfügt. Wenn schemaType es sich um einen primitiven Typ wie String, Int32oder Boolean, oder wenn es sich um einen Typ handelt, der als JSON-Array serialisiert wird, kann der Versuch, das resultierende Schema mit solchen Diensten zu verwenden, fehlschlagen. In solchen Fällen sollten Sie stattdessen einen schemaType Solchen verwenden, der den tatsächlichen Typ in einer Klasse oder Struktur umschließt, sodass er als JSON-Objekt mit dem ursprünglichen Typ als Eigenschaft dieses Objekts serialisiert wird.
Gilt für:
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Quelle:
- ChatResponseFormat.cs
Erstellt eine ChatResponseFormatJson darstellung strukturierte JSON-Daten mit einem Schema basierend auf T.
public static Microsoft.Extensions.AI.ChatResponseFormatJson ForJsonSchema<T>(System.Text.Json.JsonSerializerOptions? serializerOptions = default, string? schemaName = default, string? schemaDescription = default);static member ForJsonSchema : System.Text.Json.JsonSerializerOptions * string * string -> Microsoft.Extensions.AI.ChatResponseFormatJsonPublic Shared Function ForJsonSchema(Of T) (Optional serializerOptions As JsonSerializerOptions = Nothing, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJsonTypparameter
- T
Der Typ, für den ein Schema exportiert und als Antwortschema verwendet werden soll.
Parameter
- serializerOptions
- JsonSerializerOptions
Die zu verwendenden JSON-Serialisierungsoptionen.
- schemaName
- String
Optionaler Name des Schemas. Standardmäßig wird dies von T.
- schemaDescription
- String
Eine optionale Beschreibung des Schemas. Standardmäßig wird dies von T.
Gibt zurück
Die ChatResponseFormatJson-Instanz.
Hinweise
Viele KI-Dienste, die strukturierte Ausgabe unterstützen, erfordern, dass das JSON-Schema über ein "type=object" der obersten Ebene verfügt. Wenn T es sich um einen primitiven Typ wie String, Int32oder Boolean, oder wenn es sich um einen Typ handelt, der als JSON-Array serialisiert wird, kann der Versuch, das resultierende Schema mit solchen Diensten zu verwenden, fehlschlagen. In solchen Fällen sollten Sie stattdessen einen T Solchen verwenden, der den tatsächlichen Typ in einer Klasse oder Struktur umschließt, sodass er als JSON-Objekt mit dem ursprünglichen Typ als Eigenschaft dieses Objekts serialisiert wird.
