関数

Cognigy関数は、Cognigy.AIのインストール内で実行可能なコードブロックで、HTTP APIを介した他社システムとの連携など、長時間の非同期処理をサポートします。

関数はFlowから独立していますが、Flowからトリガーすることができ、Inject & Notify APIを使用して結果をFlowに送り返すこともできます。

関数を実行する際、追加のパラメータを指定することができ、そのパラメータは関数コードで使用できます。

左側メニューの「Build > Functions」から、関数の使用を開始できます。

制限

Cognigy関数のインスタンスの最大実行時間は15分に制限されています。オンプレミス環境の場合、この制限を変更することができます。

設定とモニタリング

関数エディタでは、JavaScriptやTypeScript言語でコードスニペットを定義することができます。

関数の引数からパラメータやapiオブジェクトにアクセスできます。

他社システムとの連携

HTTPリクエストを使って、他社システムと連携することができます。

const response = await api.httpRequest({
    method: "get",
    url: "https://example.com/api/v2",
    headers: {
        "Accept": "application/json"
    }
});

Flowとの連携

関数を使用することで、Inject & Notify API を使ってFlow連携できます。

以下の例では、関数のパラメータに userId と sessionId 送信することを想定しています。

const { userId, sessionId } = parameters;

api.inject({
    userId,
    sessionId,
    text: "This text was injected through a Function"
});

Notify(通知)コールの実行

const { userId, sessionId } = parameters;

api.notify({
    userId,
    sessionId,
    text: "This text was injected through a Function"
});

モニタリング

[Instances(インスタンス)]タブに切り替えると、現在編集中の関数の実行履歴を見ることができます。各実行には、現在の実行ステータス、トリガーソース、開始時間、終了時間が表示されます。

項目にカーソルを合わせると、その個々の実行に提供されたパラメータを見ることもできます。

関数のトリガー

Cognigy関数は3つの異なる方法でトリガーすることができます：

UIの使用

関数エディタページで、ページの左上隅にある実行ボタンをクリックします。この操作により、パラメータなしで関数が実行されます。

パラメータ付きで関数を実行するには、実行ボタンの隣にある矢印ボタンをクリックします。この操作でダイアログが開き、追加のパラメータをJSONオブジェクトとして定義できます。

REST APIの使用

REST APIを使用して、関数をトリガーすることができます。詳細は[OpenAPI]のドキュメントをご覧ください。

Nodeの使用

Flowから関数をトリガーするには、[Trigger Function Node]を使用します。

詳細はこちら

このページは役に立ちましたか？