Dialogflow CX Messenger JavaScript

Dialogflow CX Messenger 提供了您可以调用以影响其行为的函数。

renderCustomText

此函数会呈现一条文本消息，就像它来自智能体或由用户输入一样。

参数：

  • string：短信
  • boolean：如果消息来自代理，则为 true；如果消息来自最终用户，则为 false

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.renderCustomText('Custom text', true);

renderCustomCard

此函数会呈现自定义卡片，就像它来自 Dialogflow CX 执行方式一样。

参数：

  • payload：自定义载荷响应列表，在执行部分中定义

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
const payload = [
  {
    "type": "info",
    "title": "Info item title",
    "subtitle": "Info item subtitle",
    "image": {
      "rawUrl": "https://example.com/images/logo.png"
    },
    "anchor": {
      "href": "https://example.com",
      "target": "_blank"
    }
  }
];
dfMessenger.renderCustomCard(payload);

sendQuery

此函数会向 Dialogflow CX API 发送查询并等待响应。这会模拟通常提供给代理对话框的最终用户输入。系统会像处理任何最终用户查询一样处理该回答。

参数：

  • string：文本查询

返回：

  • Promise<void>：异步操作的返回值

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendQuery('Describe shipping costs.');

sendRequest

此函数会向 Dialogflow CX API 发送请求并等待响应。

参数：

  • string：请求类型，支持 query（另请参阅sendQuery 上文）和 event（请参阅自定义事件）
  • any：与请求类型对应的载荷，对于两种受支持的请求类型，载荷都是字符串

返回：

  • Promise<void>：异步操作的返回值

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendRequest('query', 'Describe shipping costs.');

setQueryParameters

此函数会为 Dialogflow CX API detectIntent 请求的 queryParams 字段设置默认值。其他 Dialogflow CX Messenger 方法可以替换查询参数中的相应默认值。

参数：

  • object：JSON 数据。如需了解查询参数的架构，请参阅 QueryParameters。

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
const queryParameters = {
  parameters: {
  timeZone: "America/New_York"
  }
};
dfMessenger.setQueryParameters(queryParameters);

setContext

此函数会将生成式个性化信息从最终用户发送到 Dialogflow CX。此信息会在会话的剩余时间内保留。

参数：

  • object：JSON 数据，请参阅生成式个性化文档

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
const metadata = {
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {
      model: "Google Pixel 7",
    },
    {
      model: "Google Pixel Tablet",
    },
  ],
};
dfMessenger.setContext(metadata);

clearStorage

此函数会清除智能体对话框的永久性存储空间。它还会清除代理对话框的当前状态。默认情况下，它会保留用户的身份验证状态。您可以使用可选的 args 来自定义此行为。

参数：

名称 类型 说明
args object? 用于配置清除存储空间操作的可选参数。
args.clearAuthentication boolean? 用于清除身份验证状态的可选标志。如果设置为 true，则会清除身份验证状态，否则会保留。

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearStorage();

clearAuthentication

此函数会清除代理对话框的身份验证。

参数：

  • 无

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearAuthentication();

startNewSession

此函数会在代理对话框中启动一个新会话。默认情况下，它会清除消息记录，但会保留用户的身份验证状态。您可以使用可选的 args 参数自定义此行为。

参数：

名称 类型 说明
args object? 用于配置新会话创建的可选参数。
args.retainHistory boolean? 用于保留历史记录的可选标志。如果设为 true，系统会保留历史记录，否则会将其清除。
args.clearAuthentication boolean? 用于清除身份验证状态的可选标志。如果设置为 true，则会清除身份验证状态，否则会保留。

返回：

  • void

例如：

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.startNewSession({ retainHistory: true });

openChat

在 df-messenger-chat-bubble 元素上调用此函数可打开对话。 如果对话已打开，则此操作不会执行任何操作。

参数：

  • 无

返回：

  • void

例如：

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.openChat();

closeChat

此函数会关闭对话。在 df-messenger-chat-bubble 元素上调用此方法可关闭对话。如果聊天已关闭，则不执行任何操作。

参数：

  • 无

返回：

  • void

例如：

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.closeChat();

openMinChat

Dialogflow CX Messenger 最小化聊天

您可以通过在 df-messenger-chat-bubble 元素上调用此函数，以最小化版本打开聊天窗口。如果聊天窗口已最小化，则此函数不会执行任何操作。

参数：

名称 类型 说明
args object? 用于配置最小化对话的可选参数。
args.anchor string? 可选 anchor，用于配置最小化对话的打开位置。逻辑与聊天气泡元素上的 anchor 属性相同。默认值为 left-top。
args.showActorImages boolean? 用于显示演员图片的可选标志（如果在 df-messenger-chat-bubble 元素中指定）。默认值为 false。

示例：

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.openMinChat({
  anchor: 'top-left'
});

closeMinChat

在 df-messenger-chat-bubble 元素上调用此函数可关闭最小化的对话。如果对话已关闭，则此方法不会执行任何操作。

示例：

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.closeMinChat();