构建一个扩展 Google Chat 的 Dialogflow CX 加购项,该加购项能够理解并以自然语言做出响应

本页介绍了如何构建 Google Chat 应用,使其能够使用 Dialogflow 理解自然语言并以自然语言做出回应。本指南使用 Dialogflow CX,该平台可直接与 Google Chat 集成。您还可以按照 Dialogflow ES Google Chat 指南,使用 Dialogflow ES 构建 Dialogflow ES Google Chat 应用。

例如,假设某个聊天应用可帮助用户租车。用户可能会写“I'd like to rent a car”。聊天应用可能会回答“您想在哪个地点取车?”之类的问题,从而开始与用户进行类似人类的对话,在此过程中,聊天应用在预订租车服务的同时,还能理解并以人类语音进行回答。

这只是其中一个示例。Dialogflow Chat 应用适用于各种互动场景。如果需要自然的人类语音,则需要 Dialogflow Chat 应用。预建代理可帮助您快速入门,并展示 Dialogflow 的功能,例如:

  • 预订航班
  • 安排医生预约
  • 订购外卖
  • 回答有关零售产品目录的问题,例如商品是否有其他颜色
  • 预建 Dialogflow 代理选择页面。
    图 1. 为 Dialogflow Chat 应用选择预建代理。
  • 在 Dialogflow CX 中测试代理。
    图 2. 在 Dialogflow CX 中测试代理,以确保代理的逻辑和配置按预期运行。该图表显示了一组按顺序排列的主题页面,这些页面涉及对话中的特定步骤,例如设置租车的取车和还车地点,并配置连接这些页面的逻辑。对话在模拟器中进行测试。
  • 配置 Dialogflow Chat 应用。
    图 3. 在 Google Cloud 控制台的 Chat API 配置页面中,配置 Chat 应用以使用 Dialogflow CX 代理处理响应。
  • 测试 Dialogflow CX Chat 应用
    图 4. 在 Google Chat 中与 Dialogflow Chat 应用就预订租车事宜进行对话。

目标

  • 设置环境。
  • 创建并部署 Dialogflow CX 代理。
  • 创建并部署由 Dialogflow CX 代理提供支持的 Chat 应用。
  • 测试 Chat 应用。

前提条件

架构

下图展示了使用 Dialogflow 构建的聊天应用的架构:

使用 Dialogflow 实现的 Chat 应用的架构。

在上图中,与 Dialogflow Chat 应用互动的用户的信息流如下:

  1. 用户通过私信或 Chat 聊天室在 Chat 中向 Chat 应用发送消息。
  2. Dialogflow 虚拟代理位于 Google Cloud 中,负责接收和处理消息以生成回答。
  3. (可选)使用 Dialogflow Webhook,Dialogflow 代理可以与外部第三方服务(例如项目管理系统或工单工具)进行互动。
  4. Dialogflow 代理会向 Chat 中的 Chat 应用服务发送响应。
  5. 回答会发送到 Chat 聊天室。

设置环境

在使用 Google API 之前,您需要在 Google Cloud 项目中将其开启。 您可以在单个 Google Cloud 项目中启用一个或多个 API。
  1. 在 Google Cloud 控制台中,启用 Google Chat API 和 Dialogflow API。

    启用 API

  2. 确认您要在正确的 Cloud 项目中启用 API,然后点击下一步

  3. 确认您要启用正确的 API,然后点击启用

创建 Dialogflow CX 客服

Dialogflow CX 代理是负责与最终用户同时对话的虚拟客服。它是一种自然语言理解模块,能够理解人类语言的细微差别。Dialogflow 可以在对话过程中将最终用户输入的文字转换为应用和服务可以理解的结构化数据。您可以设计并构建 Dialogflow 代理来负责您的系统所需的各种对话。

Dialogflow 代理类似于人类呼叫中心的客服人员。二者都需要经过训练,以处理预期的对话场景,并且内容不必过于明确。

以下是创建 Dialogflow CX 代理的步骤:

  1. 在 Dialogflow CX 控制台中,打开 Dialogflow CX 控制台。依次点击菜单 > Dialogflow CX

    前往 Dialogflow CX 控制台

  2. 选择 Google Cloud 项目。您可能需要点击全部,然后搜索您的项目。

  3. 现在,您可以选择预建代理,也可以创建自己的代理。如果您希望稍后详细了解代理自定义,请选择一个预建代理,这也有助于了解代理可以执行哪些操作。

    如需选择预建代理,请按以下步骤操作:

    1. 点击使用预建代理
    2. 选择一个预建代理。在本指南中,选择旅游:租车

      代理的等级分为初级、中级或高级,具体取决于代理使用的功能数量及其对话逻辑的复杂程度。选择中级或高级代理可能需要进行特定于代理的自定义和设置,包括在 Google Cloud 控制台中启用功能和 API。

    3. 点击以代理形式导入

    如需创建自己的代理,请按以下步骤操作:

    1. 点击创建代理
    2. 选择自动生成以创建数据存储区代理,或选择自行构建以创建其他类型的代理。

    如需详细了解代理构建流程,请参阅创建 Dialogflow CX 代理

  4. 配置基本代理设置:

    1. 显示名称中,输入显示名称。
    2. 选择您的首选位置。如果您想要更改高级位置设置,请点击修改
    3. 选择您的首选时区。
    4. 选择代理的默认语言。 代理创建后,便无法更改其默认语言。
  5. 点击创建。Dialogflow CX 开始创建代理,然后显示代理的默认初始流。

  6. 您可以选择自定义代理。如需详细了解代理自定义流程,请参阅创建 Dialogflow CX 代理

  7. 最佳实践是测试代理:

    1. 点击 Test agent
    2. 选择在环境中测试代理
    3. 在“环境”中,选择草稿
    4. 在“流”中,选择默认初始流
    5. 在“页面”中,选择初始页
    6. 与客服人员对话撰写栏中,输入 Hello,然后按 Enter 键。 代理会通过自我介绍来做出响应。
    7. 通过进行示例测试对话来完成测试。
  8. 系统会创建 Dialogflow CX 代理。返回 Dialogflow CX 控制台。 依次点击菜单 > Dialogflow CX

    前往 Dialogflow CX 控制台

  9. 代理下,依次点击 > 复制名称。请保存此名称,因为您在配置 Chat 应用时会用到它。

创建聊天应用并将其与 Dialogflow 代理相关联

创建 Dialogflow CX 代理后,请按以下步骤将其转换为聊天应用:

  1. 在 Google Cloud 控制台中,前往 Google Chat API。搜索“Google Chat API”,然后点击 Google Chat API,再点击管理

    前往 Chat API

  2. 点击配置并设置 Chat 应用:

    1. 应用名称中,输入 Dialogflow App
    2. 头像网址中,输入 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
    3. 说明中,输入 Responds to real human conversation
    4. 功能下,选择加入聊天室和群组对话
    5. 连接设置下,选择 Dialogflow
    6. Dialogflow 设置下,选择 Dialogflow CX
    7. 代理或环境资源名称中,粘贴您在创建 Dialogflow CX 代理末尾复制的 Dialogflow CX 代理名称。
    8. 面向网域中的特定人员和群组提供此 Chat 扩展应用,然后输入您的电子邮件地址。
    9. 日志下,选择将错误记录到 Logging
  3. 点击保存

Chat 应用已准备就绪,可以接收和回复 Chat 中的消息。

测试 Chat 应用

在 Google Chat 中向 Dialogflow CX Chat 应用发送消息,以测试该应用。

  1. 使用您在添加自己为可信测试人员时提供的 Google Workspace 账号打开 Google Chat。

    前往 Google Chat

  2. 点击 发起新聊天
  3. 添加 1 位或多位用户字段中,输入 Chat 应用的名称。
  4. 从结果中选择您的 Chat 应用。系统会打开一条私信。

  5. 在与应用来往的新私信中,输入 Hello 并按 enter

    Dialogflow Chat 应用会通过自我介绍来做出响应。

  6. 通过进行测试对话示例来完成测试。

测试对话示例

如需在 Dialogflow CX 控制台或 Google Chat 中测试 Dialogflow CX Chat 应用,请进行以下对话。 此说明有助于您了解 Dialogflow CX 代理如何在对话的每个步骤中解读用户的自然语言并生成自己的自然语言回答。此示例对话基于名为 Travel: car rental预构建代理

Dialog 说明
最终用户:你好
代理:你好!我是虚拟租车代理。我可以帮您开始新的租车预订。今天需要我做些什么?
  1. 系统调用默认初始流中的默认欢迎意图路由。
  2. 此状态处理程序的 fulfillment(“你好!I'm...") 已添加到响应队列中。
  3. 代理将响应队列发送给最终用户。
最终用户:我想租车。
代理:您想在哪里取车?
  1. 系统会匹配起始页中的 car_rental.reservation_create 意图路由。
  2. 会话转换到上车地点页面。
  3. “取货地点”页面表单未填写完整,因此代理会使用 pickup_location 参数提示用户(“您想在什么地方取货...”),并添加到响应队列中。
  4. 代理将响应队列发送给最终用户。
最终用户:拉斯维加斯
代理:好的,您的取货地点是拉斯维加斯。
代理:您的下车地点是否与上车地点不同?
  1. 最终用户输入填充了代理在上一轮对话中请求的 pickup_location 参数。
  2. 系统会匹配默认初始流中的 car_rental.return_different_location 意图路由。
  3. 系统会评估并调用取货地点页面中的表单完成路由。它具有一个 fulfillment(即“好的,您的取货...”),它会添加到响应队列中,其参数引用解析为最终用户提供的实际值。
  4. 会话会转换到确认位置页面。
  5. 确认地点页面包含一个 fulfillment 条目(“您的下车地点是否与上车地点不同…”)并添加到响应队列中。
  6. 代理将响应队列发送给最终用户。
最终用户:可以。我会在洛杉矶还车。
客服人员:好的,您的还车地点是洛杉矶。
客服人员:您想在什么日期和时间取车?
  1. 系统会匹配默认初始流中的 car_rental.return_different_location 意图路由。
  2. 会话转换到送达地点页面。
  3. 最终用户输入填充了代理在上一轮对话中请求的 drop_off_location 参数。
  4. 系统会评估并调用送达地点页面中的表单完成路由。它具有一个 fulfillment(即“好的,您的送货...”),它会添加到响应队列中。
  5. 会话转换到租借时长页面。
  6. “租车时长”页面上的表单值不完整,因此系统会提示用户提供 pickup_date_time 参数(“您想在什么日期和时间取车...”),并添加到响应队列中。
  7. 代理将响应队列发送给最终用户。
最终用户:我想在 3 月 5 日中午取车。
代理:您想在什么日期和时间送来车辆?
  1. 最终用户输入填充了代理在上一轮对话中请求的 pickup_date_time 参数。
  2. 租车时长页面还有另一个缺失的表单值,因此系统会提示用户输入 drop_off_date_time 参数(“您想在什么日期和时间还车?”),并添加到响应队列中。
  3. 代理将响应队列发送给最终用户。
最终用户:3 月 15 日中午。
客服人员:确认一下:

您将于 2024 年 3 月 5 日 12:00:00 在拉斯维加斯取车, 并于 2024 年 3 月 15 日 12:00:00 在洛杉矶还车

是这样吗?
  1. 最终用户输入填充了代理在上一轮对话中请求的drop_off_date_time 参数。
  2. 会话会转换到确认租期页面。
  3. 确认租赁时长页面包含一个 fulfillment 条目(“好的,请确认...”),并添加到响应队列中。
  4. 代理将响应队列发送给最终用户。
最终用户:好的,谢谢。
客服人员:太棒了!现在,我们来选择车辆。
代理:您想要经济型车辆还是豪华型车辆?
  1. 系统会匹配确认租期页面中的 small_talk.confirmation.yes intent 路由。
  2. 代理会发送一条消息(“太棒了!现在,我们来选择…"), 并添加到响应队列中。
  3. 会话转换到车辆消除歧义页面。
  4. “车辆消歧”页面表单未填写完整,因此代理会使用 vehicle_type 参数提示用户(“您想要经济型还是豪华型...”),并添加到响应队列中。
  5. 代理将响应队列发送给最终用户。
最终用户:请选择经济配送。
代理:Would you like the Cymbal Car or the Cymbal Truck?
  1. 匹配 $session.params.vehicle_type="economy_vehicle" 意图路由。
  2. 会话转换到经济舱选项页面。
  3. 经济实惠的选项页面包含一个 fulfillment 条目(“您想选择...”),并添加到响应队列中。
  4. 代理将响应队列发送给最终用户。
最终用户:Cymbal Truck。
代理:Cymbal 卡车的费用为每天 50.33 美元。 可容纳 4 人,并配备 AM/FM 收音机。 要继续付款吗?
最终用户:好的,请继续。
  1. $session.params.vehicle_type="Cymbal Truck" 意图路由匹配,并填充 vehicle_model 参数。
  2. 会话转换到确认 Cymbal Truck 页面。
  3. 确认 Cymbal Truck 页面包含一个 fulfillment 条目(“Cymbal Truck 的价格为每天 50.33 美元…”),并添加到响应队列中。
  4. 代理将响应队列发送给最终用户。
  5. 用户的回答与 small_talk.confirmation.yes 路线匹配。
代理:What card type will you be using?
最终用户:Altostrat
代理:请输入卡号。
最终用户:1234 1234 1234 1234
代理:What is the name on the card?
最终用户:Charlie
代理:账单邮寄地址是什么?
最终用户:1800 Amphibious Blvd. Mountain View, CA
代理:账单邮政编码是什么?
最终用户:94045
代理:您将于 2024-03-05 12:00:00 在拉斯维加斯取走 Cymbal Car,并于 2024-03-15 12:00:00 还车。此行程的总费用为 175.38 美元。
客服人员:感谢您选择我们,祝您度过愉快的一天!
  1. 会话转换到付款页面。
  2. 付款表单未填写完整,因此代理会提示用户提供 card_typecard_numberbilling_namebilling_street_addressbilling_zip_code 参数(“您要使用哪种类型的卡...”), 这些消息会依次添加到响应队列中,并在用户做出回答时发送。用户的回答会设置每个参数值。
  3. 会话转换到租车确认页面。
  4. 租车确认页面包含一个 fulfillment 条目(“好的,您的取车时间是…”)并添加到响应队列中。
  5. 代理将响应队列发送给最终用户。
  6. 会话转换到结束会话页面。

从 Dialogflow 发送卡片消息

Dialogflow 可以通过文本卡片消息进行回答。如需使用卡片消息进行响应,请在履行中将其指定为自定义载荷

以下 JSON 展示了如何在履单中以自定义载荷的形式发送卡片消息:

json

{ "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
  "message": { "cardsV2": [{
    "cardId": "createCardMessage",
    "card": {
      "header": {
        "title": "A card message!",
        "subtitle": "Sent from Dialogflow",
        "imageUrl": "https://developers.google.com/chat/images/chat-product-icon.png",
        "imageType": "CIRCLE"
      },
      "sections": [{ "widgets": [{ "buttonList": { "buttons": [{
        "text": "Read the docs!",
        "onClick": { "openLink": {
          "url": "https://developers.google.com/workspace/chat"
        }}
      }]}}]}]
    }
  }]}
}}}}

限制和注意事项

  • 将 Google Workspace 加载项与 Dialogflow 搭配使用时,聊天事件对象存在以下限制和注意事项:
    • 应用首页活动:目前尚不支持 APP_HOME 事件。
    • Dialogflow 查询输入:作为查询输入发送给 Dialogflow 代理的文本取决于事件类型:
      • MESSAGE:聊天消息中 argumentText 字段的值。
      • APP_COMMAND:字符串 "APP_COMMAND_PAYLOAD"
      • ADDED_TO_SPACE:字符串 "ADDED_TO_SPACE_PAYLOAD"
      • REMOVED_FROM_SPACE:字符串 "REMOVED_FROM_SPACE_PAYLOAD"
      • CARD_CLICKED:字符串 "BUTTON_CLICKED_PAYLOAD"
      • WIDGET_UPDATED:字符串 "WIDGET_UPDATED_PAYLOAD"(用于自动补全)。
    • 完整事件载荷:聊天互动事件的完整 JSON 载荷会通过 WebhookRequest.payload 字段发送到 Dialogflow。您可以在 Dialogflow webhook 中访问此信息。如需了解详情,请参阅 Dialogflow CX webhook 请求文档
  • 响应命令从卡片或对话框接收数据的注意事项:
  • 不支持链接预览
  • 如果 Dialogflow 代理只回复一条消息,则该消息会同步发送到 Google Chat。如果 Dialogflow 代理使用多条消息进行响应,则会通过在 Chat API 中对 spaces.messages 资源调用 create 方法,以异步方式将所有消息发送到 Chat,每条消息调用一次。
  • 将 Dialogflow CX 与 Chat 集成时,必须在同一 Google Cloud 项目中设置 Dialogflow 代理和 Chat 应用。如果您需要在不同的 Cloud 项目中设置 Dialogflow 和 Chat,则可以设置中间服务器来帮助建立连接。如需了解具体操作方法,请参阅 GitHub 上的适用于 Dialogflow CX 的聊天集成示例

问题排查

如需调试 Chat 应用,请先查看错误日志。由于此应用使用 Dialogflow,因此您可以使用多种日志记录和问题排查资源:

  • Google Workspace 插件日志:查询日志,详细了解插件的行为,包括其与 Chat 的互动。请参阅查询 Google Workspace 加购项的日志

  • Google Chat 应用错误:如需了解常规 Chat 应用错误消息和修复方法,请参阅排查和修复 Chat 应用错误

  • Dialogflow CX Cloud Logging:确保在 Dialogflow 代理设置中启用 Cloud Logging,以捕获详细的执行日志,包括来自代理和 Webhook 互动的错误。如需了解如何启用和配置此功能,请参阅 Dialogflow CX 代理设置文档。您可以在 Google Cloud 控制台的日志浏览器中查看这些日志。

  • Dialogflow CX 对话历史记录:查看过往互动,了解对话流程并确定问题发生的位置。请参阅对话记录

  • Dialogflow 一般问题排查:如需排查更广泛的 Dialogflow 问题,请参阅 Dialogflow CX 问题排查指南

清理

为避免系统因本教程中使用的资源向您的 Google Cloud 账号收取费用,我们建议您删除 Cloud 项目。

  1. 在 Google Cloud 控制台中,前往管理资源页面。依次点击 菜单 > IAM 和管理 > 管理资源

    前往资源管理器

  2. 在项目列表中,选择要删除的项目,然后点击删除
  3. 在对话框中输入项目 ID,然后点击关停以删除项目。
  • Dialogflow CX 采用状态机方法进行 Dialogflow 代理设计,这样您就可以拥有清晰而明确的对话控制、更出色的最终用户体验以及更好的开发工作流。构建 Dialogflow Chat 应用时,我们建议使用 Dialogflow CX。
  • Dialogflow ES 是将 Dialogflow 与 Chat 扩展应用搭配使用的另一种方式。