ChatResponseFormat.ForJsonSchema Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą z określonym schematem.
Przeciążenia
| Nazwa | Opis |
|---|---|
| ForJsonSchema(JsonElement, String, String) |
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą z określonym schematem. |
| ForJsonSchema(Type, JsonSerializerOptions, String, String) |
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą ze schematem opartym na . |
| ForJsonSchema<T>(JsonSerializerOptions, String, String) |
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą ze schematem opartym na . |
ForJsonSchema(JsonElement, String, String)
- Źródło:
- ChatResponseFormat.cs
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą z określonym schematem.
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 ChatResponseFormatJsonParametry
- schema
- JsonElement
Schemat JSON.
- schemaName
- String
Opcjonalna nazwa schematu. Jeśli na przykład schemat reprezentuje określoną klasę, może to być nazwa klasy.
- schemaDescription
- String
Opcjonalny opis schematu.
Zwraca
Instancja ChatResponseFormatJson.
Dotyczy
ForJsonSchema(Type, JsonSerializerOptions, String, String)
- Źródło:
- ChatResponseFormat.cs
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą ze schematem opartym na .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 ChatResponseFormatJsonParametry
- schemaType
- Type
Element Type , dla którego należy wyeksportować schemat i użyć go jako schematu odpowiedzi.
- serializerOptions
- JsonSerializerOptions
Opcje serializacji JSON do użycia.
- schemaName
- String
Opcjonalna nazwa schematu. Domyślnie zostanie to wywnioskowane z schemaType.
- schemaDescription
- String
Opcjonalny opis schematu. Domyślnie zostanie to wywnioskowane z schemaType.
Zwraca
Instancja ChatResponseFormatJson.
Wyjątki
Parametr schemaType ma wartość null.
Uwagi
Wiele usług sztucznej inteligencji obsługujących dane wyjściowe ze strukturą wymaga, aby schemat JSON miał najwyższy poziom "type=object". Jeśli schemaType jest typem pierwotnym, takim jak String, Int32lub Boolean, lub jest to typ, który serializuje jako tablicę JSON, próba użycia wynikowego schematu z takimi usługami może zakończyć się niepowodzeniem. W takich przypadkach należy rozważyć użycie obiektu schemaType , który opakowuje rzeczywisty typ klasy lub struktury, tak aby serializuje jako obiekt JSON z oryginalnym typem jako właściwością tego obiektu.
Dotyczy
ForJsonSchema<T>(JsonSerializerOptions, String, String)
- Źródło:
- ChatResponseFormat.cs
Tworzy reprezentację ChatResponseFormatJson danych JSON ze strukturą ze schematem opartym na .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 ChatResponseFormatJsonParametry typu
- T
Typ, dla którego należy wyeksportować schemat i użyć go jako schematu odpowiedzi.
Parametry
- serializerOptions
- JsonSerializerOptions
Opcje serializacji JSON do użycia.
- schemaName
- String
Opcjonalna nazwa schematu. Domyślnie zostanie to wywnioskowane z T.
- schemaDescription
- String
Opcjonalny opis schematu. Domyślnie zostanie to wywnioskowane z T.
Zwraca
Instancja ChatResponseFormatJson.
Uwagi
Wiele usług sztucznej inteligencji obsługujących dane wyjściowe ze strukturą wymaga, aby schemat JSON miał najwyższy poziom "type=object". Jeśli T jest typem pierwotnym, takim jak String, Int32lub Boolean, lub jest to typ, który serializuje jako tablicę JSON, próba użycia wynikowego schematu z takimi usługami może zakończyć się niepowodzeniem. W takich przypadkach należy rozważyć użycie obiektu T , który opakowuje rzeczywisty typ klasy lub struktury, tak aby serializuje jako obiekt JSON z oryginalnym typem jako właściwością tego obiektu.
