ChatResponseFormat.ForJsonSchema Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| Nome | Description |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Cria uma ChatResponseFormatJson representação de dados JSON estruturados com o esquema especificado. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Cria uma ChatResponseFormatJson representação de dados JSON estruturados com um esquema baseado em |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Cria uma ChatResponseFormatJson representação de dados JSON estruturados com um esquema baseado em |
ForJsonSchema(JsonElement, String, String)
- Origem:
- ChatResponseFormat.cs
Cria uma ChatResponseFormatJson representação de dados JSON estruturados com o esquema especificado.
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 ChatResponseFormatJsonParâmetros
- schema
- JsonElement
O esquema JSON.
- schemaName
- String
Um nome opcional do esquema. Por exemplo, se o esquema representar uma classe específica, esse poderá ser o nome da classe.
- schemaDescription
- String
Uma descrição opcional do esquema.
Retornos
A instância ChatResponseFormatJson.
Aplica-se a
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Origem:
- ChatResponseFormat.cs
Cria uma ChatResponseFormatJson representação de dados JSON estruturados com um esquema baseado em 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 ChatResponseFormatJsonParâmetros
- schemaType
- Type
O Type para o qual um esquema deve ser exportado e usado como o esquema de resposta.
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a serem usadas.
- schemaName
- String
Um nome opcional do esquema. Por padrão, isso será inferido de schemaType.
- schemaDescription
- String
Uma descrição opcional do esquema. Por padrão, isso será inferido de schemaType.
Retornos
A instância ChatResponseFormatJson.
Exceções
schemaType é null.
Comentários
Muitos serviços de IA que dão suporte à saída estruturada exigem que o esquema JSON tenha um 'type=object' de nível superior. Se schemaType for um tipo primitivo como String, Int32ou Boolean, ou se for um tipo serializado como uma matriz JSON, a tentativa de usar o esquema resultante com esses serviços poderá falhar. Nesses casos, considere usar um schemaType que encapsula o tipo real em uma classe ou struct para que ele seja serializado como um objeto JSON com o tipo original como uma propriedade desse objeto.
Aplica-se a
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Origem:
- ChatResponseFormat.cs
Cria uma ChatResponseFormatJson representação de dados JSON estruturados com um esquema baseado em 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 ChatResponseFormatJsonParâmetros de tipo
- T
O tipo para o qual um esquema deve ser exportado e usado como o esquema de resposta.
Parâmetros
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a serem usadas.
- schemaName
- String
Um nome opcional do esquema. Por padrão, isso será inferido de T.
- schemaDescription
- String
Uma descrição opcional do esquema. Por padrão, isso será inferido de T.
Retornos
A instância ChatResponseFormatJson.
Comentários
Muitos serviços de IA que dão suporte à saída estruturada exigem que o esquema JSON tenha um 'type=object' de nível superior. Se T for um tipo primitivo como String, Int32ou Boolean, ou se for um tipo serializado como uma matriz JSON, a tentativa de usar o esquema resultante com esses serviços poderá falhar. Nesses casos, considere usar um T que encapsula o tipo real em uma classe ou struct para que ele seja serializado como um objeto JSON com o tipo original como uma propriedade desse objeto.
