AIFunctionDeclaration.ReturnJsonSchema Egenskap

Definition

Hämtar ett JSON-schema som beskriver funktionens returvärde.

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)

Egenskapsvärde

Kommentarer

När en AIFunction skapas via AIFunctionFactoryhärleds det här schemat automatiskt från metodens returtyp med hjälp av konfigurerade JsonSerializerOptions och AIJsonSchemaCreateOptions. För metoder som returnerar Task<TResult> eller ValueTask<TResult>baseras schemat på den oöppnade resultattypen. Generering av returscheman kan undantas genom att ställa in ExcludeResultSchematrue.

Ett null värde återspeglar vanligtvis en funktion som inte anger ett returschema, en funktion som returnerar Void, Taskeller ValueTaskeller en funktion som ExcludeResultSchema har angetts till true.

Gäller för