Język

AIFunctionDeclaration.ReturnJsonSchema Właściwość

Definicja

Pobiera schemat JSON opisujący wartość zwracaną funkcji.

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)

Wartość właściwości

Uwagi

Po utworzeniu elementu AIFunction za pomocą AIFunctionFactorymetody ten schemat jest automatycznie uzyskiwany z zwracanego typu metody przy użyciu skonfigurowanych JsonSerializerOptions metod i AIJsonSchemaCreateOptions. W przypadku metod zwracanych Task<TResult> lub ValueTask<TResult>schemat jest oparty na niezapisanym typie wyników. Generowanie schematu zwracanego można wykluczyć, ustawiając wartość ExcludeResultSchema .true

null Wartość zwykle odzwierciedla funkcję, która nie określa schematu zwracanego, funkcji zwracającej Voidwartość , Tasklub ValueTaskfunkcji, dla której ExcludeResultSchema ustawiono truewartość .

Dotyczy