語言

AIFunctionDeclaration.ReturnJsonSchema 屬性

定義

會取得一個描述函式回傳值的 JSON Schema。

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)

屬性值

備註

當 AIFunction 透過 建立 AIFunctionFactory時,此結構會自動從方法的回傳類型中透過配置 JsonSerializerOptions 與 AIJsonSchemaCreateOptions推導出。 對於回 Task<TResult> 傳 或 ValueTask<TResult>的方法,結構是基於未展開的結果型別。 可透過將 設定 ExcludeResultSchema 為 true來排除回傳結構產生。

一個null值通常反映不指定回傳結構的函數、回傳 Void、 Task或 ValueTask,或是設定為 ExcludeResultSchema的函數true。

適用於