Langue

ChatResponseFormat.ForJsonSchema Méthode

Définition

Crée une ChatResponseFormatJson représentation de données JSON structurées avec le schéma spécifié.

Surcharges

Nom Description
ForJsonSchema(JsonElement, String, String)

Crée une ChatResponseFormatJson représentation de données JSON structurées avec le schéma spécifié.

ForJsonSchema(Type, JsonSerializerOptions, String, String)

Crée une ChatResponseFormatJson représentation de données JSON structurées avec un schéma basé sur schemaType.

ForJsonSchema<T>(JsonSerializerOptions, String, String)

Crée une ChatResponseFormatJson représentation de données JSON structurées avec un schéma basé sur T.

ForJsonSchema(JsonElement, String, String)

Crée une ChatResponseFormatJson représentation de données JSON structurées avec le schéma spécifié.

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

Paramètres

schema
JsonElement

Schéma JSON.

schemaName
String

Nom facultatif du schéma. Par exemple, si le schéma représente une classe particulière, il peut s’agir du nom de la classe.

schemaDescription
String

Description facultative du schéma.

Retours

Instance ChatResponseFormatJson.

S’applique à

ForJsonSchema(Type, JsonSerializerOptions, String, String)

Crée une ChatResponseFormatJson représentation de données JSON structurées avec un schéma basé sur 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.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

Paramètres

schemaType
Type

Type Pour lequel un schéma doit être exporté et utilisé comme schéma de réponse.

serializerOptions
JsonSerializerOptions

Options de sérialisation JSON à utiliser.

schemaName
String

Nom facultatif du schéma. Par défaut, cela sera déduit de schemaType.

schemaDescription
String

Description facultative du schéma. Par défaut, cela sera déduit de schemaType.

Retours

Instance ChatResponseFormatJson.

Exceptions

schemaType a la valeur null.

Remarques

De nombreux services IA qui prennent en charge la sortie structurée nécessitent que le schéma JSON dispose d’un « type=object » de niveau supérieur. S’il schemaType s’agit d’un type primitif tel Stringque , Int32ou Booleans’il s’agit d’un type sérialisé en tant que tableau JSON, toute tentative d’utilisation du schéma obtenu avec ces services peut échouer. Dans ce cas, envisagez plutôt d’utiliser un schemaType type qui encapsule le type réel dans une classe ou un struct afin qu’il sérialise en tant qu’objet JSON avec le type d’origine comme propriété de cet objet.

S’applique à

ForJsonSchema<T>(JsonSerializerOptions, String, String)

Crée une ChatResponseFormatJson représentation de données JSON structurées avec un schéma basé sur 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.ChatResponseFormatJson
Public Shared Function ForJsonSchema(Of T) (Optional serializerOptions As JsonSerializerOptions = Nothing, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJson

Paramètres de type

T

Type pour lequel un schéma doit être exporté et utilisé comme schéma de réponse.

Paramètres

serializerOptions
JsonSerializerOptions

Options de sérialisation JSON à utiliser.

schemaName
String

Nom facultatif du schéma. Par défaut, cela sera déduit de T.

schemaDescription
String

Description facultative du schéma. Par défaut, cela sera déduit de T.

Retours

Instance ChatResponseFormatJson.

Remarques

De nombreux services IA qui prennent en charge la sortie structurée nécessitent que le schéma JSON dispose d’un « type=object » de niveau supérieur. S’il T s’agit d’un type primitif tel Stringque , Int32ou Booleans’il s’agit d’un type sérialisé en tant que tableau JSON, toute tentative d’utilisation du schéma obtenu avec ces services peut échouer. Dans ce cas, envisagez plutôt d’utiliser un T type qui encapsule le type réel dans une classe ou un struct afin qu’il sérialise en tant qu’objet JSON avec le type d’origine comme propriété de cet objet.

S’applique à