REST

Cognigy.AIプラットフォームでは、Rest Endpointとの統合を使用することで、CognigyリソースをRestクライアントに接続することができます。

基本Endpoint設定

アプリケーションに接続する

REST Endpointを作成すると、Endpoint URLPOSTリクエストを送信できるようになります。リクエストのボディ(本文)は以下の形式でなければなりません:

{
  "userId":"userId",
  "sessionId": "someUniqueId",
  "text":"message text",
  "data": {
    "key": "value"
  }
}

パラメータ  userId – 文字列形式のエンドユーザーのユーザー ID sessionId – 文字列形式の現在のトークを追跡するために使用される一意の ID text – 文字列形式の割り当てられたフローによって処理されるべきメッセージテキスト data – オブジェクト形式の割り当てられたフローによって処理されるべきメッセージデータ

テキストとデータの送信

デフォルトでは、REST Endpointを使用して、テキストまたはデータのいずれかをFlowに送信できます。両方を送信することもできますが、少なくとも1つは必要です。無効なテキストと無効なデータが指定された場合、REST Endpointはエラーを発生させます。

セッションID

sessionIdは、トークの状態を保持するために使用される一意の識別子です。つまり、新しいトークが始まるたびに新しい固有のIDを生成する必要があり、メッセージごとに生成する必要はありません。テスト目的であれば、好きな文字列値をsessionIdとして使用し、新しいトークを開始するたびに変更することができます。

応答には、出力テキスト、出力データ、およびすべてのFlow出力の配列であるoutputStackが含まれます。Rest EndpointはすべてのFlow Output(すべてのSay Nodesなど)を1つのテキスト/データ出力に連結するので、デバッグ目的でoutputStackを使用できます。

{
    "text": "output2",
    "data": {
        "output": 2
    },
    "outputStack": [
        {
            "text": "output 1",
            "data": {
                "output": 1
            }
        },
        {
            "text": "output 2",
            "data": {
                "output": 2
            }
        }
    ]
}

AIデフォルトチャネル形式

デフォルトチャネルの形式について、詳しくはこちらをご覧ください。