AIFunctionFactory.CreateDeclaration メソッド

定義

指定したパラメーターを対応するプロパティの実装として使用して、 AIFunctionDeclaration を作成します。

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

パラメーター

name
String

関数の名前です。

description
String

関数の説明。モデルに対する目的の記述に適しています。

jsonSchema
JsonElement

関数とその入力パラメーターを記述する JSON スキーマ。

returnJsonSchema
Nullable<JsonElement>

関数の戻り値を記述する JSON スキーマ。

返品

関数を記述する作成された AIFunctionDeclaration

例外

namenullです。

注釈

CreateDeclaration(String, String, JsonElement, Nullable<JsonElement>) は、関数を記述するために使用できる AIFunctionDeclaration を作成しますが、呼び出しは行いません。 使用できない AIFunctionを作成するには、作成を使用します。 その関数のAsDeclarationOnly() メソッドを使用して、呼び出し不可能なAIFunctionから、呼び出し不可能なAIFunctionDeclarationを作成することもできます。

適用対象