ChatResponseFormat.ForJsonSchema Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| Nombre | Description |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Crea un objeto ChatResponseFormatJson que representa datos JSON estructurados con el esquema especificado. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Crea un objeto ChatResponseFormatJson que representa datos JSON estructurados con un esquema basado en |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Crea un objeto ChatResponseFormatJson que representa datos JSON estructurados con un esquema basado en |
ForJsonSchema(JsonElement, String, String)
- Source:
- ChatResponseFormat.cs
Crea un objeto ChatResponseFormatJson que representa datos JSON estructurados con el 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
El esquema JSON.
- schemaName
- String
Nombre opcional del esquema. Por ejemplo, si el esquema representa una clase determinada, podría ser el nombre de la clase .
- schemaDescription
- String
Descripción opcional del esquema.
Devoluciones
Instancia de ChatResponseFormatJson.
Se aplica a
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Source:
- ChatResponseFormat.cs
Crea un objeto ChatResponseFormatJson que representa datos JSON estructurados con un esquema basado en 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
- serializerOptions
- JsonSerializerOptions
Las opciones de serialización JSON que se van a usar.
- schemaName
- String
Nombre opcional del esquema. De forma predeterminada, esto se deducirá de schemaType.
- schemaDescription
- String
Descripción opcional del esquema. De forma predeterminada, esto se deducirá de schemaType.
Devoluciones
Instancia de ChatResponseFormatJson.
Excepciones
schemaType es null.
Comentarios
Muchos servicios de inteligencia artificial que admiten la salida estructurada requieren que el esquema JSON tenga un "type=object" de nivel superior. Si schemaType es un tipo primitivo como String, Int32o Boolean, o si es un tipo que se serializa como una matriz JSON, se puede producir un error al intentar usar el esquema resultante con estos servicios. En tales casos, considere la posibilidad de usar en su lugar un schemaType que encapsula el tipo real en una clase o estructura para que serialice como un objeto JSON con el tipo original como una propiedad de ese objeto.
Se aplica a
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Source:
- ChatResponseFormat.cs
Crea un objeto ChatResponseFormatJson que representa datos JSON estructurados con un esquema basado en 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
Tipo para el que se debe exportar y usar un esquema como esquema de respuesta.
Parámetros
- serializerOptions
- JsonSerializerOptions
Las opciones de serialización JSON que se van a usar.
- schemaName
- String
Nombre opcional del esquema. De forma predeterminada, esto se deducirá de T.
- schemaDescription
- String
Descripción opcional del esquema. De forma predeterminada, esto se deducirá de T.
Devoluciones
Instancia de ChatResponseFormatJson.
Comentarios
Muchos servicios de inteligencia artificial que admiten la salida estructurada requieren que el esquema JSON tenga un "type=object" de nivel superior. Si T es un tipo primitivo como String, Int32o Boolean, o si es un tipo que se serializa como una matriz JSON, se puede producir un error al intentar usar el esquema resultante con estos servicios. En tales casos, considere la posibilidad de usar en su lugar un T que encapsula el tipo real en una clase o estructura para que serialice como un objeto JSON con el tipo original como una propiedad de ese objeto.
