ChatResponseFormat.ForJsonSchema Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Overload
| Nome | Descrizione |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Crea un oggetto ChatResponseFormatJson che rappresenta dati JSON strutturati con lo schema specificato. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Crea un oggetto ChatResponseFormatJson che rappresenta dati JSON strutturati con uno schema basato su |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Crea un oggetto ChatResponseFormatJson che rappresenta dati JSON strutturati con uno schema basato su |
ForJsonSchema(JsonElement, String, String)
- Origine:
- ChatResponseFormat.cs
Crea un oggetto ChatResponseFormatJson che rappresenta dati JSON strutturati con lo schema specificato.
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 ChatResponseFormatJsonParametri
- schema
- JsonElement
Lo schema JSON.
- schemaName
- String
Nome facoltativo dello schema. Ad esempio, se lo schema rappresenta una determinata classe, potrebbe trattarsi del nome della classe .
- schemaDescription
- String
Descrizione facoltativa dello schema.
Valori restituiti
Istanza ChatResponseFormatJson.
Si applica a
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Origine:
- ChatResponseFormat.cs
Crea un oggetto ChatResponseFormatJson che rappresenta dati JSON strutturati con uno schema basato su 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 ChatResponseFormatJsonParametri
- schemaType
- Type
Oggetto Type per il quale uno schema deve essere esportato e usato come schema di risposta.
- serializerOptions
- JsonSerializerOptions
Opzioni di serializzazione JSON da usare.
- schemaName
- String
Nome facoltativo dello schema. Per impostazione predefinita, verrà dedotto da schemaType.
- schemaDescription
- String
Descrizione facoltativa dello schema. Per impostazione predefinita, verrà dedotto da schemaType.
Valori restituiti
Istanza ChatResponseFormatJson.
Eccezioni
schemaType è null.
Commenti
Molti servizi di intelligenza artificiale che supportano l'output strutturato richiedono che lo schema JSON abbia un 'type=object' di primo livello. Se schemaType è un tipo primitivo come String, Int32o Booleano se si tratta di un tipo serializzato come matrice JSON, il tentativo di usare lo schema risultante con tali servizi potrebbe non riuscire. In questi casi, è consigliabile usare invece un schemaType oggetto che esegue il wrapping del tipo effettivo in una classe o uno struct in modo che serializzi come oggetto JSON con il tipo originale come proprietà di tale oggetto.
Si applica a
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Origine:
- ChatResponseFormat.cs
Crea un oggetto ChatResponseFormatJson che rappresenta dati JSON strutturati con uno schema basato su 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 ChatResponseFormatJsonParametri di tipo
- T
Tipo per il quale uno schema deve essere esportato e usato come schema di risposta.
Parametri
- serializerOptions
- JsonSerializerOptions
Opzioni di serializzazione JSON da usare.
- schemaName
- String
Nome facoltativo dello schema. Per impostazione predefinita, verrà dedotto da T.
- schemaDescription
- String
Descrizione facoltativa dello schema. Per impostazione predefinita, verrà dedotto da T.
Valori restituiti
Istanza ChatResponseFormatJson.
Commenti
Molti servizi di intelligenza artificiale che supportano l'output strutturato richiedono che lo schema JSON abbia un 'type=object' di primo livello. Se T è un tipo primitivo come String, Int32o Booleano se si tratta di un tipo serializzato come matrice JSON, il tentativo di usare lo schema risultante con tali servizi potrebbe non riuscire. In questi casi, è consigliabile usare invece un T oggetto che esegue il wrapping del tipo effettivo in una classe o uno struct in modo che serializzi come oggetto JSON con il tipo originale come proprietà di tale oggetto.
