Socket.io

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

基本Endpoint設定

このEndpointで使用可能な基本Endpoint設定については、以下のページをご覧ください：

• Endpoints Overview（エンドポイントの概要）
• Data Protection & Analytics（データ保護と分析）
• Transformer Functions（トランスフォーマー関数）
• NLU Connectors（NLUコネクタ）
• Session Management（セッション管理）
• Handover Settings（ハンドオーバー設定）
• Real Time Translation Settings（リアルタイム翻訳設定）

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

URLトークン

URL トークンとは、表示される Endpoint URL の最後の部分です：

この例では、https://endpoint-trial.cognigy.ai に接続します。

メッセージの送信

メッセージは、以下の形式のペイロードを持つprocessInputイベントを使用して送信されます：

{
    "URLToken": "urlToken",
    "sessionId": "sessionId",
    "userId": "user@cognigy.com",
    "passthroughIP": "127.0.0.1",
    "resetFlow": "false",  // Resets the flow and starts a new one from the beginning
    "text": "Example text",  // Can be skipped with "resetFlow": true
    "data": {
        "key": "value"
    }
}

resetFlowフラグがtrueに設定されると、新しいフローが最初から開始されます。このペイロードは、メッセージを持っている場合もあれば、持っていない場合もあります。メッセージがある場合は、このメッセージが新しいフローの最初のメッセージになります。次のメッセージを送信するときは、resetFlowフラグをfalseに設定するのを忘れないようにしましょう。そうでない場合は、そのようなメッセージのそれぞれが新しいフローを開始することになります。

メッセージの受信

メッセージは出力イベントを聞くことで受け取ることができます。応答は以下の形式です：

{
  "type":"output",
  "data":
  {
    "text":"responseText",
    "data":
    {
      "key":"value"
    }
  }
}

Cognigy Socketクライアント

Cognigyでは、Cognigy Socket Endpointに接続するためのソケットクライアントを提供しています。このクライアントのドキュメントとオープンソースコードはCognigy GitHubページで入手可能です。