容器

此页面包含实现界面模块的容器方法的 API 文档。以下是您可以在容器中作为组件实现的 Agent Assist 功能。

用法

使用以下代码在 HTML 页面中导入该模块：

<script src="https://www.gstatic.com/agent-assist-ui-modules/v1/container.js"></script>

使用以下代码嵌入模块：

<agent-assist-ui-modules>

属性

属性名称 类型 评论
功能 字符串 要呈现的 Agent Assist 建议功能键的逗号分隔列表。示例：“SMART_REPLY, CONVERSATION_SUMMARIZATION”
api-headers 字符串 要添加到 Dialogflow API 调用中的其他标头。示例：“Content-Type:application/json, Accept:application/json”
conversation-profile 字符串 要使用的对话个人资料的名称。
agent-desktop AgentDesktop 要集成的客服人员桌面软件。
auth-token 字符串 用于 API 调用的身份验证令牌。
api-key 字符串 用于 API 调用的可选 API 密钥。
channel CommunicationChannel 此应用使用的通信渠道（聊天、语音或全渠道）。
custom-api-endpoint 字符串 要使用的可选自定义 API 端点（如果界面模块配置了代理服务器）。
主题 'dark' | 'light' 要使用的颜色主题。
show-header BooleanString 是否显示 Agent Assist 建议标题。
dark-mode-background 字符串 用于深色模式的背景颜色。如果未指定任何值，系统会为主要受支持的代理桌面提供默认值。
notifier-server-endpoint 字符串 用于基于事件的对话的通知器服务器端点。
event-based-transport EventBasedTransport 用于基于事件的对话的传输协议。
event-based-library EventBasedLibrary 用于基于事件的对话的库。
oauth-client-id 字符串 用于隐式身份验证的可选 OAuth 客户端 ID，在某些代理桌面配置 (Genesys Cloud) 中使用。
redirect-uri 字符串 可选的重定向 URI，用于在身份验证后转到，在某些代理桌面配置 (Genesys Cloud) 中使用。
genesys-cloud-区域 字符串 Genesys Cloud 的可选区域，默认为 mypurecloud.com。

用法

属性是基于字符串的组件属性，可通过以下方式设置：

直接在 HTML 模板中：

<element-selector property-name="value">

在 JavaScript 代码中：

var el = document.querySelector('element-selector');
el.setAttribute('property-name', 'value');

输入

属性名称 类型 评论
socketIoConnectOpts SocketIoConnectOpts 其他 Socket.io 连接选项。
config UiModuleContainerConfig 用于定义特定于模块的配置的配置对象。

用法

输入通常是 JavaScript 对象或其他复杂的属性类型，必须直接在元素实例上进行分配：

const el = document.querySelector('element-selector');
el.propertyName = value;

类型

如需了解该组件使用的自定义类型，请参阅下一部分。

AgentDesktop

"LivePerson" | "GenesysCloud" | "SalesForce" | "Custom"

CommunicationChannel

"chat" | "voice" | "omnichannel"

BooleanString

"true" | "false"

EventBasedTransport

"websocket" | "polling"

EventBasedLibrary

"SocketIo"

SocketIoConnectOpts

interface SocketIoConnectOpts extends SocketIOClient.ConnectOpts {
  auth: {
    token: string;
  };
  withCredentials?: boolean;
}

UiModuleContainerConfig

interface UiModuleContainerConfig {
  knowledgeAssistConfig?: {
    articleLinkConfig: {
      /**
       * Whether to open the article in a new tab or as a dialog. Defaults to new
       * tab.
       */
      target?: "blank" | "popup";
      /**
       * Options to configure the popup's size and location. See
       * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
       */
      popupWindowOptions?: string;
      /**
       * The field name on the document metadata if a separate article link source
       * is provided.
       */
      linkMetadataKey?: string;
    };
  };
  knowledgeAssistV2Config?: {
    articleLinkConfig?: {
      /**
       * Whether to open the article in a new tab or as a dialog. Defaults to new
       * tab.
       */
      target?: "blank" | "popup";
      /**
       * Options to configure the popup's size and location. See
       * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
       */
      popupWindowOptions?: string;
      /**
       * The field name on the document metadata if a separate article link source
       * is provided.
       */
      linkMetadataKey?: string;
    };
    showCopyAnswer: boolean;
    showPasteAnswer: boolean;
  };
  summarizationConfig?: {
    /**
     * Optional callback that can be used to save the generated summary to an
     * external source.
     */
    onSaveSummary?: (
      summary: {
        summary: string;
        conversationDetails: ConversationDetails;
      },
      saveCallbacks: {
        setLoading: () => void;
        setSuccess: (message: string) => void;
        setError: (message: string) => void;
      }
    ) => void;

    /** Whether to show the 'Generate summary' button. */
    showGenerateSummaryButton?: "true" | "false";
  };
}