AIFunctionFactory.CreateDeclaration Método

Definición

Crea un AIFunctionDeclaration utilizando los parámetros especificados como la implementación de sus propiedades correspondientes.

public static Microsoft.Extensions.AI.AIFunctionDeclaration CreateDeclaration(string name, string? description, System.Text.Json.JsonElement jsonSchema, System.Text.Json.JsonElement? returnJsonSchema = default);
static member CreateDeclaration : string * string * System.Text.Json.JsonElement * Nullable<System.Text.Json.JsonElement> -> Microsoft.Extensions.AI.AIFunctionDeclaration
Public Shared Function CreateDeclaration (name As String, description As String, jsonSchema As JsonElement, Optional returnJsonSchema As Nullable(Of JsonElement) = Nothing) As AIFunctionDeclaration

Parámetros

name
String

Nombre de la función.

description
String

Descripción de la función, adecuada para su uso en la descripción del propósito de un modelo.

jsonSchema
JsonElement

Esquema JSON que describe la función y sus parámetros de entrada.

returnJsonSchema
Nullable<JsonElement>

Esquema JSON que describe el valor devuelto de la función.

Devoluciones

Objeto creado AIFunctionDeclaration que describe una función.

Excepciones

name es null.

Comentarios

CreateDeclaration(String, String, JsonElement, Nullable<JsonElement>) crea un AIFunctionDeclaration objeto que se puede usar para describir una función, pero no invocarla. Para crear una invocación AIFunction, use Crear. También se puede crear un elemento no invocable AIFunctionDeclaration a partir de un invocable AIFunction mediante el método de esa AsDeclarationOnly() función.

Se aplica a