AIFunctionDeclaration.ReturnJsonSchema Propriedade
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém um esquema JSON que descreve o valor retornado da função.
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)
Valor da propriedade
Comentários
Quando um AIFunction é criado por meio AIFunctionFactory, esse esquema é derivado automaticamente do tipo de retorno do método usando o configurado JsonSerializerOptions e AIJsonSchemaCreateOptions. Para métodos que retornam Task<TResult> ou ValueTask<TResult>, o esquema é baseado no tipo de resultado desembrulhado. A geração de esquema de retorno pode ser excluída definindo ExcludeResultSchema como true.
Um null valor normalmente reflete uma função que não especifica um esquema de retorno, uma função que retornaVoid, Taskou ValueTaskuma função para a truequal ExcludeResultSchema foi definida como .