応答タイプ・リファレンス

統合チャネル・サポート

• 一部のチャネル統合では、音声のタイトルや説明が表示されません。

フィールド

source プロパティで指定される URL は、以下のいずれかのタイプである：

• 任意の標準フォーマットの音声ファイル (MP3 や WAV など) の URL。 ウェブチャットでは、リンクされたオーディオクリップは埋め込まれたオーディオプレーヤーとしてレンダリングされます。

• サポートされるストリーミング・サービス上の音声クリップの URL。 ウェブチャットでは、リンクされたオーディオクリップは、ホスティングサービスの埋め込み可能なプレーヤーを使ってレンダリングされます。

ブラウザで音声ファイルにアクセスする際に使用する URL を指定します（例： https://soundcloud.com/ibmresearchfallen-star-amped ）。ウェブチャットは自動的に URL を埋め込み可能な形式に変換します。

サポートされているサービスでホストされているオーディオを埋め込むことができます：

• SoundCloud

• Mixcloud

電話統合の場合は、PCM エンコードされたシングル・チャネル (モノラル) の音声ファイルを指定しなければなりません。この音声ファイルは、サンプルあたり 16 ビットで、8,000 Hz でサンプリングされたものでなければなりません。

例

この例では、タイトルと説明テキストを使用してオーディオ・クリップを再生します。

{
  "generic":[
    {
      "response_type": "audio",
      "source": "https://example.com/audio/example-file.mp3",
      "title": "Example audio file",
      "description": "An example audio clip returned as part of a multimedia response."
    }
  ]
}

統合チャネル・サポート

フィールド

post_back ボタンの種類

ユーザーが post_back ボタンをクリックすると、 AI アシスタントに応答が送信されます。 送信するレスポンスを設定するには、`` プロパティ value と `` label プロパティの両方を使用できます。

{
  "response_type": "button",
  "button_type": "post_back",
  "label": "Send message",
  "value": {
    "input": {
      "text": "[Message to send]"
    }
  }
}

custom_event ボタンの種類

ユーザーが'custom_eventボタンをクリックすると、ユーザー定義データと一緒に設定したカスタムイベントがトリガーされます。 カスタムコードを使用して、希望する動作を実現するイベントを作成する必要があります。 ウェブチャットでは、'messageItemCustomイベントを使用して、ユーザーがボタンをクリックしたときに希望の動作を適用することができます。

{
  "response_type": "button",
  "button_type": "custom_event",
  "label": "Alert",
  "kind": "danger",
  "custom_event_name": "trigger_alert",
  "user_defined": {
    "message": "[Alert message]"
  }
}

show_panel ボタンの種類

ユーザーがボタンを show_panel クリックすると、 AIアシスタントがパネルを開き、ユーザーはそのパネルを使って追加情報を確認したり、タスクを完了したりすることができます。

{
  "response_type": "button",
  "button_type": "show_panel",
  "label": "See details",
  "kind": "secondary",
  "panel": {
    "title": "[Product name]",
    "show_animations": true,
    "body": [
      {
        "response_type": "image",
        "source": "https://example.com/image.jpg"
      },
      {
        "response_type": "text",
        "text": "[Product details]"
      }
    ]
  }
}

url ボタンの種類

ユーザーが'urlボタンをクリックすると、urlフィールドに移動し、目的地のurlを追加します。

{
  "response_type": "button",
  "button_type": "url",
  "label": "Visit ibm.com",
  "url": "https://www.ibm.com"
}

統合チャネル・サポート

フィールド

cardはパネルにレンダリングできるが、ボタンを持つことはできない。

例

次の例は、「card応答タイプを構築するための基本構造を示している：

{
  "response_type": "card",
  "body": [
    {
      "response_type": "text",
      "text": "# Heading"
    },
    {
      "response_type": "text",
      "text": "body"
    }
  ]
}

統合チャネル・サポート

フィールド

例

次の例は、「carousel応答タイプを構築するための基本構造を示している：

{
  "response_type": "carousel",
  "items": [
    {
      "response_type": "card",
      "body": [
        {
          "response_type": "text",
          "text": "# Heading"
        },
        {
          "response_type": "text",
          "text": "body"
        }
      ]
    },
    {
      "response_type": "card",
      "body": [
        {
          "response_type": "text",
          "text": "# Heading"
        },
        {
          "response_type": "text",
          "text": "body"
        }
      ]
    }
  ]
}

統合チャネル・サポート

• 記載されているチャネル連携機能は、チャネルへの転送の「開始」をサポートしています（現時点では、Webチャット連携のみが転送先としてサポートされています）。

• 電話統合からチャネル転送を開始するには、SMS統合も設定されている必要があります。

フィールド

例

この例ではWhatsAppからウェブチャットへの転送をリクエストします。 channel_transfer 応答に加えて、転送後に Web チャット統合によって表示される text 応答も出力に含まれます。 channels配列を使用することで、'channel_transferレスポンスはWhatsAppインテグレーション(転送前)のみで処理され、'connect_to_agentレスポンスはウェブチャットインテグレーション(転送後)のみで処理される。

{
  "generic": [
    {
      "response_type": "channel_transfer",
      "channels": [
        {
          "channel": "whatsapp"
        }
      ],
      "message_to_user": "Click the link to connect with an agent using our website.",
      "transfer_info": {
        "target": {
          "chat": {
            "url": "https://example.com/webchat"
          }
        }
      }
    },
    {
      "response_type": "connect_to_agent",
      "channels": [
        {
          "channel": "chat"
        }
      ],
      "message_to_human_agent": "User asked to speak to an agent.",
      "agent_available": {
        "message": "Please wait while I connect you to an agent."
      },
      "agent_unavailable": {
        "message": "I'm sorry, but no agents are online at the moment. Please try again later."
      },
      "transfer_info": {
        "target": {
          "zendesk": {
            "department": "Payments department"
          }
        }
      }
    }
  ]
}

統合チャネル・サポート

電話統合にサービス・デスク・サポートを追加することについては、バックアップのコール・センター・サポートの構成を参照してください。

フィールド

例

この例では、ライブエージェントへの転送を要求し、転送時にユーザーとエージェントの両方に表示されるメッセージを指定する。

{
  "generic": [
    {
      "response_type": "connect_to_agent",
      "message_to_human_agent": "User asked to speak to an agent.",
      "agent_available": {
        "message": "Please wait while I connect you to an agent."
      },
      "agent_unavailable": {
        "message": "I'm sorry, but no agents are online at the moment. Please try again later."
      }
    }
  ]
}

統合チャネル・サポート

• Web チャットでは、顧客は、対話式日付ピッカーをクリックするか、または入力フィールドに日付値を入力することにより、日付値を指定できます。

フィールド

例

この例では、ユーザーに日付を指定するよう求めるテキスト応答を送信し、対話型の日付ピッカーを表示します。

{
  "generic": [
    {
      "response_type": "text",
      "text": "What day will you be checking in?"
    },
    {
      "response_type": "date"
    }
  ]
}

統合チャネル・サポート

フィールド

command_info.type フィールドには、以下のサポートされるコマンドのいずれかを指定できます。

• collect: DTMF キーパッド入力を収集します。

• disable_barge_in: DTMF バージインを無効にして、お客様がキーを押したときに電話統合からの再生が中断されないようにします。

• enable_barge_in: DTMF バージインを有効にして、お客様がキーを押して電話統合からの再生を中断できるようにします。

• send: DTMF シグナルを送信します。

これらの各コマンドの使用方法について詳しくは、電話対話の処理を参照してください。

例

この例は、DTMF 入力を収集するために使用される、collect コマンドによる dtmf 応答タイプを示しています。 詳細については、電話でのやり取りの処理を参照してください。

{
  "generic": [
    {
      "response_type": "dtmf",
      "command_info": {
        "type": "collect",
        "parameters": {
          "termination_key": "#",
          "count": 16,
          "ignore_speech": true
        }
      },
      "channels": [
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

統合チャネル・サポート

• SMS連携では、action terminateSession コマンドを使用してセッションを終了することができます。

フィールド

電話統合の場合、channel_options オブジェクトを使用して、生成される SIP BYE 要求にカスタム・ヘッダーを組み込むことができます。 詳しくは、呼び出しを終了する を参照してください。

例

この例では、end_session 応答タイプを使用して会話を終了します。

{
  "generic": [
    {
      "response_type": "end_session"
    }
  ]
}

統合チャネル・サポート

フィールド

例

次の例は、「grid応答タイプを構築するための基本構造を示している：

{
  "response_type": "grid",
  "columns": [
    {
      "width": "1"
    },
    {
      "width": "1"
    }
  ],
  "rows": [
    {
      "cells": [
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 1 cell 1"
            }
          ]
        },
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 1 cell 2"
            }
          ]
        }
      ]
    },
    {
      "cells": [
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 2 cell 1"
            }
          ]
        },
        {
          "items": [
            {
              "response_type": "text",
              "text": "row 2 cell 2"
            }
          ]
        }
      ]
    }
  ]
}

統合チャネル・サポート

• 現在、Web チャット統合は description プロパティーと image_url プロパティーを無視します。 代わりに、説明とプレビューの画像が実行時にソースから動的に取得されます。

フィールド

サイトによって、コンテンツの組み込みに関する制限が異なります。また、組み込み可能 URL を生成するためのプロセスも異なります。 組み込み可能 URL とは、src 属性 (iframe エレメント) の値として指定できる URL のことです。

例えば、GoogleMapsでインタラクティブマップを埋め込むには、GoogleMaps Embed APIを使います。 （詳細については、 「Maps Embed API の概要」 を参照してください。） 他のサイトには、組み込み可能コンテンツを作成するためのさまざまなプロセスがあります。

ウェブサイトのコンテンツを埋め込めるように Content-Security-Policy: frame-src するための技術的な詳細については、「 CSP: frame-src」 を参照してください。

例

次の例では、タイトルと説明を含むiframeを埋め込んでいます。

{
  "generic":[
    {
      "response_type": "iframe",
      "source": "https://example.com/embeddable/example",
      "title": "Example iframe",
      "description": "An example of embeddable content returned as an iframe response.",
      "channel_options": {
        "chat": {
          "display": "inline",
          "base_height": 180
        }
      }
    }
  ]
}

統合チャネル・サポート

• 一部のチャネル統合では、画像のタイトルや説明が表示されません。

フィールド

例

次の例は、イメージとタイトルおよび説明テキストを表示します。

{
  "generic":[
    {
      "response_type": "image",
      "source": "https://example.com/image.jpg",
      "title": "Example image",
      "description": "An example image returned as part of a multimedia response."
    }
  ]
}

統合チャネル・サポート

• 選択肢の提示方法は、チャネル統合によって異なる。 preference フィールドは可能であればサポートされますが、すべてのチャネルがドロップダウン・リストやボタンをサポートするわけではありません。

フィールド

例

この例では、2 つのオプション (Buy something と Exit) が示されています。

{
  "generic":[
    {
      "response_type": "option",
      "title": "Choose from the following options:",
      "preference": "button",
      "options": [
        {
          "label": "Buy something",
          "value": {
            "input": {
              "text": "Place order"
            }
          }
        },
        {
          "label": "Exit",
          "value": {
            "input": {
              "text": "Exit"
            }
          }
        }
      ]
    }
  ]
}

統合チャネル・サポート

• 電話連携機能を利用すれば、 AIアシスタントの出力にSSML break 要素を含めることで、一時停止を追加することができます。 詳細については、 『 Text to Speech 』のドキュメントを参照してください。

フィールド

例

この例では、"user is typing "イベントを送信し、5秒間休止する。

{
    "generic":[
      {
        "response_type": "pause",
        "time": 5000,
        "typing": true
      }
    ]
}

統合チャネル・サポート

フィールド

command_info.type フィールドには、以下のサポートされるコマンドのいずれかを指定できます。

• configure: ` Speech to Text `の設定を動的に更新します。 構成変更は、次の会話ターンにのみ適用することも、セッションの残りの部分にのみ適用することもできます。

このコマンドの使用方法については、 「 Speech to Text サービスへの詳細設定の適用」 を参照してください。

例

この例では、` configure command` とともに ` speech_to_text response` タイプを使用し、 Speech to Text サービスの言語モデルをスペイン語に変更し、スマートフォーマットを有効にします。

{
  "generic": [
    {
      "response_type": "speech_to_text",
      "command_info": {
        "type": "configure",
        "parameters": {
          "narrowband_recognize": {
            "model": "es-ES_NarrowbandModel",
            "smart_formatting": true
          }
        }
      },
      "channels":[
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

統合チャネル・サポート

フィールド

現在、電話統合の以下のアクティビティーを開始できます。

• speech_to_text_recognition ：音声を認識します。 Speech to Text サービスへのオーディオストリーミングが再開されました。

• dtmf_collection: 受信DTMF信号を処理する。

例

この例では、start_activities 応答タイプを使用して、音声認識を再開します。 このコマンドは電話統合に固有であるため、channels プロパティーは voice_telephony のみを指定します。

{
  "generic": [
    {
      "response_type": "start_activities",
      "activities": [
        {
          "type": "speech_to_text_recognition"
        }
      ],
      "channels":[
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

統合チャネル・サポート

フィールド

現在、電話統合の以下のアクティビティーを停止できます。

• speech_to_text_recognition: 音声認識を停止します。 Speech to Text サービスへのすべてのオーディオストリーミングが停止されました。

• dtmf_collection: インバウンド DTMF シグナルの処理を停止します。

例

この例では、stop_activities 応答タイプを使用して、音声認識を停止します。 このコマンドは電話統合に固有であるため、channels プロパティーは voice_telephony のみを指定します。

{
  "generic": [
    {
      "response_type": "stop_activities",
      "activities": [
        {
          "type": "speech_to_text_recognition"
        }
      ],
      "channels":[
        {
          "channel":"voice_telephony"
        }
      ]
    }
  ]
}

統合チャネル・サポート

性質と定義

各行にはヘッダーと同じ数のセルがなければならない。 セルとヘッダ間の不一致は、テーブルをレンダリングしようとしたときにウェブチャットがエラーを投げる原因となります。

例

この例では、構造化データをテーブルに表示する。

{
    "generic": [
      {
        "response_type": "table",
        "title": "Data Table",
        "description": "A table with data",
        "headers": ["Column 1", "Column 2"],
        "rows": [
          {
            "cells": ["Row 1, Column 1", "Row 1, Column 2"]
          },
          {
            "cells": ["Row 2, Column 1", "22"]
          }
        ]
      }
    ]
}

統合チャネル・サポート

フィールド

例

この例では、ユーザーに挨拶メッセージを表示する。

{
  "generic": [
    {
      "response_type": "text",
      "values": [
        {
          "text_expression": {
            "concat": [
              {
                "scalar": "Hi, "
              },
              {
                "variable": "step_472"
              },
              {
                "scalar": ". How can I help you?"
              }
            ]
          }
        }
      ],
      "selection_policy": "sequential"
    }
  ]
}  

統合チャネル・サポート

フィールド

command_info.type フィールドには、以下のサポートされるコマンドのいずれかを指定できます。

• configure: ` Text to Speech `の設定を動的に更新します。 構成変更は、次の会話ターンにのみ適用することも、セッションの残りの部分にのみ適用することもできます。

• disable_barge_in: 音声バージインを無効にして、お客様が話すときに電話統合からの再生が中断されないようにします。

• enable_barge_in: 音声バージインを有効にして、お客様が話すことによって電話統合からの再生を中断できるようにします。

これらの各コマンドの使用方法の詳細については、 「 Text to Speech サービスへの詳細設定の適用」 を参照してください。

例

この例では、 Text to Speech サービスで使用される音声を変更するために、` configure command` コマンドと ` text_to_speech response` タイプを使用しています。

{
  "generic": [
    {
      "response_type": "text_to_speech",
      "command_info": {
        "type": "configure",
        "parameters" : {
          "synthesize": {
            "voice": "en-US_LisaVoice"
          }          
        }
      },
      "channels":[
        {
          "channel": "voice_telephony"
        }
      ]
    }
  ]
}

統合チャネル・サポート

• 電話統合では、user_defined 応答タイプが、レガシー・コマンド (vgwActForceNoInputTurn や vgwActSendSMS など) の送信に使用されます。 詳しくは、電話対話の処理を参照してください。

• SMS連携では、この user_defined 応答タイプを使用してアクションコマンド（例： terminateSession または smsActSendMedia）を送信します。

フィールド

例

この例は、ユーザー定義応答の一般的な例を示している。 user_defined オブジェクトには、任意の有効な JSON データを含めることができます。

{
  "generic":[
    {
      "response_type": "user_defined",
      "user_defined": {
        "field_1": "String value",
        "array_1": [
          1,
          2
        ],
        "object_1": {
          "property_1": "Another string value"
        }
      }
    }
  ]
}

統合チャネル・サポート

• 一部のチャンネル統合では、動画のタイトルや説明が表示されません。

フィールド

source プロパティで指定される URL は、以下のいずれかのタイプである：

• 標準フォーマット (MPEG や AVI など) のビデオ・ファイルの URL。 ウェブチャットでは、リンクされたビデオは埋め込まれたビデオプレーヤーとしてレンダリングされます。

HLS (.m3u8) および DASH (MPD) ストリーミング動画はサポートされていません。

• サポートされているサービスからのビデオの URL。 ウェブチャットでは、リンクされたビデオは、ホスティングサービスの埋め込み可能なプレーヤーでレンダリングされます。

ブラウザで表示したいビデオの URL を指定します（例： https://www.youtube.com/watch?v=52bpMKVigGU ）。ウェブチャットは自動的に URL を埋め込み可能な形式に変換します。

以下のサービスの動画を埋め込むことができます：

• YouTube

• Facebook

• Vimeo

• Twitch

• ストリーム化可能

• ウィスティア

• Vidyard

例

この例では、タイトルと説明テキストを含むビデオを表示します。

{
  "generic":[
    {
      "response_type": "video",
      "source": "https://example.com/videos/example-video.mp4",
      "title": "Example video",
      "description": "An example video returned as part of a multimedia response."
    }
  ]
}