AIFunctionDeclaration.ReturnJsonSchema Eigenschap
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Hiermee haalt u een JSON-schema op waarin de retourwaarde van de functie wordt beschreven.
public:
virtual property Nullable<System::Text::Json::JsonElement> ReturnJsonSchema { Nullable<System::Text::Json::JsonElement> get(); };
public virtual System.Text.Json.JsonElement? ReturnJsonSchema { get; }
member this.ReturnJsonSchema : Nullable<System.Text.Json.JsonElement>
Public Overridable ReadOnly Property ReturnJsonSchema As Nullable(Of JsonElement)
Waarde van eigenschap
Opmerkingen
Wanneer een AIFunction wordt gemaakt via AIFunctionFactory, wordt dit schema automatisch afgeleid van het retourtype van de methode met behulp van de geconfigureerde JsonSerializerOptions en AIJsonSchemaCreateOptions. Voor methoden die worden geretourneerd Task<TResult> of ValueTask<TResult>, is het schema gebaseerd op het uitgepakte resultaattype. Het genereren van een retourschema kan worden uitgesloten door de instelling in te stellen ExcludeResultSchema op true.
Een null waarde weerspiegelt doorgaans een functie die geen retourschema opgeeft, een functie die retourneert Void, Taskof ValueTaskeen functie waarvoor ExcludeResultSchema is ingesteld true.