ChatResponseFormat.ForJsonSchema Metod
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Överlagringar
| Name | Description |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Skapar en ChatResponseFormatJson representerar strukturerade JSON-data med det angivna schemat. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Skapar en ChatResponseFormatJson som representerar strukturerade JSON-data med ett schema baserat på |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Skapar en ChatResponseFormatJson som representerar strukturerade JSON-data med ett schema baserat på |
ForJsonSchema(JsonElement, String, String)
- Källa:
- ChatResponseFormat.cs
Skapar en ChatResponseFormatJson representerar strukturerade JSON-data med det angivna schemat.
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 ChatResponseFormatJsonParametrar
- schema
- JsonElement
JSON-schemat.
- schemaName
- String
Ett valfritt namn på schemat. Om schemat till exempel representerar en viss klass kan det vara namnet på klassen.
- schemaDescription
- String
En valfri beskrivning av schemat.
Returer
Instansen ChatResponseFormatJson .
Gäller för
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Källa:
- ChatResponseFormat.cs
Skapar en ChatResponseFormatJson som representerar strukturerade JSON-data med ett schema baserat på 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 ChatResponseFormatJsonParametrar
- serializerOptions
- JsonSerializerOptions
De JSON-serialiseringsalternativ som ska användas.
- schemaName
- String
Ett valfritt namn på schemat. Som standard kommer detta att härledas från schemaType.
- schemaDescription
- String
En valfri beskrivning av schemat. Som standard kommer detta att härledas från schemaType.
Returer
Instansen ChatResponseFormatJson .
Undantag
schemaType är null.
Kommentarer
Många AI-tjänster som stöder strukturerade utdata kräver att JSON-schemat har ett "type=object" på toppnivå. Om schemaType är en primitiv typ som String, Int32eller Boolean, eller om det är en typ som serialiseras som en JSON-matris, kan försök att använda det resulterande schemat med sådana tjänster misslyckas. I sådana fall bör du i stället överväga att använda en schemaType som omsluter den faktiska typen i en klass eller struct så att den serialiseras som ett JSON-objekt med den ursprungliga typen som egenskap för objektet.
Gäller för
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Källa:
- ChatResponseFormat.cs
Skapar en ChatResponseFormatJson som representerar strukturerade JSON-data med ett schema baserat på 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 ChatResponseFormatJsonTypparametrar
- T
Den typ som ett schema ska exporteras för och användas som svarsschema.
Parametrar
- serializerOptions
- JsonSerializerOptions
De JSON-serialiseringsalternativ som ska användas.
- schemaName
- String
Ett valfritt namn på schemat. Som standard kommer detta att härledas från T.
- schemaDescription
- String
En valfri beskrivning av schemat. Som standard kommer detta att härledas från T.
Returer
Instansen ChatResponseFormatJson .
Kommentarer
Många AI-tjänster som stöder strukturerade utdata kräver att JSON-schemat har ett "type=object" på toppnivå. Om T är en primitiv typ som String, Int32eller Boolean, eller om det är en typ som serialiseras som en JSON-matris, kan försök att använda det resulterande schemat med sådana tjänster misslyckas. I sådana fall bör du i stället överväga att använda en T som omsluter den faktiska typen i en klass eller struct så att den serialiseras som ett JSON-objekt med den ursprungliga typen som egenskap för objektet.
