知识辅助

本页包含 Knowledge Assist 界面模块的 API 文档。此模块用于在对话过程中向客服显示实用文章和常见问题解答建议。

用法

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

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

使用以下标记嵌入模块：

<agent-assist-knowledge-assist>

属性

属性名称	类型	评论
功能	字符串	应呈现的知识辅助功能的英文逗号分隔列表（ARTICLE_SUGGESTION、FAQ 和 ARTICLE_SEARCH）。

用法

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

直接从 HTML 模板中：

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

在 JavaScript 代码中：

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

输入

属性名称	类型	评论
config	KnowledgeAssistConfig	知识辅助模块的可选配置。

用法

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

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

类型

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

KnowledgeAssistConfig

interface KnowledgeAssistConfig {
  articleLinkConfig: {
    /**
     * Whether to open the article in a new tab, or as a popup. 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;
  };
}