响应类型参考

集成渠道支持

• 某些频道集成不显示音频标题或描述。

字段

source 属性指定的 URL 可以是以下类型之一：

• URL 任何标准格式的音频文件，如 MP3 或 WAV。 在网络聊天中，链接的音频片段会显示为嵌入式音频播放器。

• 支持流媒体服务的音频片段 URL。 在网络聊天中，链接的音频片段会使用托管服务的嵌入式播放器播放。

指定用于在浏览器中访问音频文件的 URL （例如 https://soundcloud.com/ibmresearchfallen-star-amped ）。网络聊天会自动将 URL 转换为可嵌入的形式。

您可以嵌入由支持服务托管的音频：

• SoundCloud

• Mixcloud

对于电话集成， URL 必须指定一个单声道（单声道）和 PCM 编码的音频文件，采样频率为 8000 Hz，每次采样 16 位。

示例

此示例播放一段带有标题和描述性文字的音频片段。

{
  "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 助手发送响应。 您可以同时使用 和 label value 属性来配置要发送的响应。

{
  "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"
        }
      ]
    }
  ]
}

集成渠道支持

• 所列出的频道集成支持_发起_频道传输（目前，仅支持将消息传输至网页聊天集成）。

• 从电话集成启动通道传输需要同时配置短信集成。

字段

示例

此示例请求从WhatsApp转移到网络聊天。 除 "channel_transfer响应外，输出还包括 "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."
      }
    }
  ]
}

集成渠道支持

• 在网络聊天中，客户可以通过点击交互式日期选择器或在输入框中输入日期值来指定日期值。

字段

示例

此示例发送一个文本响应，要求用户指定一个日期，然后显示一个交互式日期选择器。

{
  "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"
        }
      ]
    }
  ]
}

集成渠道支持

• 短信集成支持通过使用 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"
            }
          ]
        }
      ]
    }
  ]
}

集成渠道支持

• 目前，网络聊天集成会忽略 "description和 "image_url属性。 相反，描述和预览图片是在运行时从源代码中动态获取的。

字段

不同的网站对嵌入内容有不同的限制，生成可嵌入 URL 的程序也各不相同。 可嵌入的 URL 是指可以指定为 iframe 元素的 src 属性值的。

例如，要使用Google地图嵌入交互式地图，可以使用Google地图嵌入 API。 （如需了解更多信息，请参阅 《地图嵌入式 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字段，但并非所有通道都支持下拉列表或按钮。

字段

示例

本示例提供了两个选项（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 文档。

字段

示例

此示例发送 "用户正在键入 "事件，并暂停 5 秒。

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

集成渠道支持

字段

command_info.type字段可指定以下任何受支持的命令：

• configure：动态更新 Speech to Text 配置。 配置更改只能应用于下一轮对话，或整个会话期间。

有关如何使用此命令的信息，请参阅 《对 Speech to Text 服务应用高级设置》。

示例

此示例使用 响应 speech_to_text 类型配合 命令 configure ，将 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 ，用于更改 Text to Speech 服务所使用的语音。

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

集成渠道支持

• 通过电话集成，"user_defined响应类型用于发送传统命令（例如，"vgwActForceNoInputTurn或 "vgwActSendSMS）。 如需更多信息，请参阅 “处理电话互动”。

• 通过短信集成，响应 user_defined 类型用于发送操作命令（例如 或 smsActSendMedia） terminateSession 。

字段

示例

本例展示了一个用户自定义响应的通用示例。 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 可以是以下类型之一：

• URL MPEG 或 AVI 等标准格式的视频文件。 在网络聊天中，链接的视频会渲染为嵌入式视频播放器。

不支持 HLS（.m3u8）和 DASH (MPD) 流媒体视频。

• 支持服务的视频 URL。 在网络聊天中，链接的视频会使用托管服务的可嵌入播放器播放。

指定要在浏览器中查看的视频的 URL （例如 https://www.youtube.com/watch?v=52bpMKVigGU ）。网络聊天会自动将 URL 转换为可嵌入的形式。

您可以从以下服务中嵌入视频：

• YouTube

• Facebook

• Vimeo

• Twitch

• 可流式传输

• Wistia

• 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."
    }
  ]
}