AIFunctionDeclaration.JsonSchema Свойство

Определение

Пространство имен:
Microsoft.Extensions.AI
Сборка:
Microsoft.Extensions.AI.Abstractions.dll
Пакет:
Microsoft.Extensions.AI.Abstractions v10.7.0
Исходный код:
AIFunctionDeclaration.cs

Возвращает схему JSON, описывающую функцию и входные параметры.

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

Значение свойства

JsonElement

Комментарии

При указании объявляет автономный документ схемы JSON, описывающий функцию и входные параметры. Ниже показан простой пример схемы JSON для функции, которая добавляет два числа вместе:

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

Метаданные, представленные в документе схемы, играют важную роль в вызове функции ИИ.

AIFunction При создании AIFunctionFactoryчерез эту схему автоматически извлекается из параметров метода с помощью настроенных JsonSerializerOptions иAIJsonSchemaCreateOptions.

Если схема не указана, использование клиентов чата должно принимать схему "" или "{}true", указывая, что входные данные JSON являются недопустимыми.

Применяется к