Taal

ChatResponseFormat.ForJsonSchema Methode

Definitie

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met het opgegeven schema.

Overloads

Naam Description
ForJsonSchema(JsonElement, String, String)

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met het opgegeven schema.

ForJsonSchema(Type, JsonSerializerOptions, String, String)

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met een schema op schemaTypebasis van .

ForJsonSchema<T>(JsonSerializerOptions, String, String)

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met een schema op Tbasis van .

ForJsonSchema(JsonElement, String, String)

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met het opgegeven 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.ChatResponseFormatJson
Public Shared Function ForJsonSchema (schema As JsonElement, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJson

Parameters

schema
JsonElement

Het JSON-schema.

schemaName
String

Een optionele naam van het schema. Als het schema bijvoorbeeld een bepaalde klasse vertegenwoordigt, kan dit de naam van de klasse zijn.

schemaDescription
String

Een optionele beschrijving van het schema.

Retouren

Het ChatResponseFormatJson-exemplaar.

Van toepassing op

ForJsonSchema(Type, JsonSerializerOptions, String, String)

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met een schema op schemaTypebasis van .

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.ChatResponseFormatJson
Public Shared Function ForJsonSchema (schemaType As Type, Optional serializerOptions As JsonSerializerOptions = Nothing, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJson

Parameters

schemaType
Type

Het Type schema waarvoor een schema moet worden geëxporteerd en gebruikt als het antwoordschema.

serializerOptions
JsonSerializerOptions

De te gebruiken JSON-serialisatieopties.

schemaName
String

Een optionele naam van het schema. Dit wordt standaard afgeleid van schemaType.

schemaDescription
String

Een optionele beschrijving van het schema. Dit wordt standaard afgeleid van schemaType.

Retouren

Het ChatResponseFormatJson-exemplaar.

Uitzonderingen

schemaType is null.

Opmerkingen

Veel AI-services die gestructureerde uitvoer ondersteunen, vereisen dat het JSON-schema een 'type=object' op het hoogste niveau heeft. Als schemaType het een primitief type is, zoals String, Int32of Boolean, of als het een type is dat serialiseert als een JSON-matrix, kan het gebruik van het resulterende schema met dergelijke services mislukken. In dergelijke gevallen kunt u in plaats daarvan overwegen een schemaType type te gebruiken dat het werkelijke type in een klasse of struct verpakt, zodat het wordt geserialiseerd als een JSON-object met het oorspronkelijke type als een eigenschap van dat object.

Van toepassing op

ForJsonSchema<T>(JsonSerializerOptions, String, String)

Hiermee maakt u een ChatResponseFormatJson representatie van gestructureerde JSON-gegevens met een schema op Tbasis van .

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.ChatResponseFormatJson
Public Shared Function ForJsonSchema(Of T) (Optional serializerOptions As JsonSerializerOptions = Nothing, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJson

Type parameters

T

Het type waarvoor een schema moet worden geëxporteerd en gebruikt als het antwoordschema.

Parameters

serializerOptions
JsonSerializerOptions

De te gebruiken JSON-serialisatieopties.

schemaName
String

Een optionele naam van het schema. Dit wordt standaard afgeleid van T.

schemaDescription
String

Een optionele beschrijving van het schema. Dit wordt standaard afgeleid van T.

Retouren

Het ChatResponseFormatJson-exemplaar.

Opmerkingen

Veel AI-services die gestructureerde uitvoer ondersteunen, vereisen dat het JSON-schema een 'type=object' op het hoogste niveau heeft. Als T het een primitief type is, zoals String, Int32of Boolean, of als het een type is dat serialiseert als een JSON-matrix, kan het gebruik van het resulterende schema met dergelijke services mislukken. In dergelijke gevallen kunt u in plaats daarvan overwegen een T type te gebruiken dat het werkelijke type in een klasse of struct verpakt, zodat het wordt geserialiseerd als een JSON-object met het oorspronkelijke type als een eigenschap van dat object.

Van toepassing op