Compartilhar via


AIFunctionDeclaration.JsonSchema Propriedade

Definição

Obtém um esquema JSON que descreve a função e seus parâmetros de entrada.

public:
 virtual property System::Text::Json::JsonElement JsonSchema { System::Text::Json::JsonElement get(); };
public virtual System.Text.Json.JsonElement JsonSchema { get; }
member this.JsonSchema : System.Text.Json.JsonElement
Public Overridable ReadOnly Property JsonSchema As JsonElement

Valor da propriedade

Comentários

Quando especificado, declara um documento de esquema JSON autocontido que descreve a função e seus parâmetros de entrada. Um exemplo simples de um esquema JSON para uma função que adiciona dois números juntos é mostrado abaixo:

{
  "type": "object",
  "properties": {
    "a" : { "type": "number" },
    "b" : { "type": ["number","null"], "default": 1 }
  },
  "required" : ["a"]
}

Os metadados presentes no documento de esquema desempenham um papel importante na invocação da função de IA.

Quando um AIFunction é criado por meio AIFunctionFactory, esse esquema é derivado automaticamente dos parâmetros do método usando o configurado JsonSerializerOptions e AIJsonSchemaCreateOptions.

Quando nenhum esquema é especificado, o consumo de clientes de chat deve assumir o esquema "{}" ou "true", indicando que qualquer entrada JSON é admissível.

Aplica-se a