ChatResponseFormat.ForJsonSchema Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Sobrecargas
| Name | Description |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Cria dados ChatResponseFormatJson JSON estruturados representativos com o esquema especificado. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Cria dados ChatResponseFormatJson JSON estruturados representativos com um esquema baseado em |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Cria dados ChatResponseFormatJson JSON estruturados representativos com um esquema baseado em |
ForJsonSchema(JsonElement, String, String)
- Origem:
- ChatResponseFormat.cs
Cria dados ChatResponseFormatJson JSON estruturados representativos 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 representa uma determinada classe, este pode ser o nome da classe.
- schemaDescription
- String
Uma descrição opcional do esquema.
Devoluções
A ChatResponseFormatJson instância.
Aplica-se a
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Origem:
- ChatResponseFormat.cs
Cria dados ChatResponseFormatJson JSON estruturados representativos 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 esquema para o qual um esquema deve ser exportado e usado como esquema de resposta.
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a usar.
- schemaName
- String
Um nome opcional do esquema. Por defeito, isto será inferido a partir de schemaType.
- schemaDescription
- String
Uma descrição opcional do esquema. Por defeito, isto será inferido a partir de schemaType.
Devoluções
A ChatResponseFormatJson instância.
Exceções
schemaType é null.
Observações
Muitos serviços de IA que suportam saída estruturada requerem que o esquema JSON tenha um 'tipo=objeto' de topo. Se schemaType for um tipo primitivo como String, Int32, ou Boolean, ou se for um tipo que serializa como um array JSON, tentar usar o esquema resultante com tais serviços pode falhar. Nesses casos, considere-se antes usar um schemaType que envolva o tipo real numa classe ou struct para que se serialize como um objeto JSON com o tipo original como propriedade desse objeto.
Aplica-se a
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Origem:
- ChatResponseFormat.cs
Cria dados ChatResponseFormatJson JSON estruturados representativos 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 Genérico
- T
O tipo para o qual um esquema deve ser exportado e usado como esquema de resposta.
Parâmetros
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a usar.
- schemaName
- String
Um nome opcional do esquema. Por defeito, isto será inferido a partir de T.
- schemaDescription
- String
Uma descrição opcional do esquema. Por defeito, isto será inferido a partir de T.
Devoluções
A ChatResponseFormatJson instância.
Observações
Muitos serviços de IA que suportam saída estruturada requerem que o esquema JSON tenha um 'tipo=objeto' de topo. Se T for um tipo primitivo como String, Int32, ou Boolean, ou se for um tipo que serializa como um array JSON, tentar usar o esquema resultante com tais serviços pode falhar. Nesses casos, considere-se antes usar um T que envolva o tipo real numa classe ou struct para que se serialize como um objeto JSON com o tipo original como propriedade desse objeto.
