Knowledge Assist

Diese Seite enthält die API-Dokumentation für das UI-Modul Knowledge Assist. Mit diesem Modul werden Kundenservicemitarbeitern während einer Unterhaltung hilfreiche Artikel und FAQ-Vorschläge angezeigt.

Nutzung

Importieren Sie das Modul mit dem folgenden Code in Ihre HTML-Seite:

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

Fügen Sie das Modul mit dem folgenden Tag ein:

<agent-assist-knowledge-assist>

Attribute

Eigenschaft	Typ	Kommentar
Features	String	Durch Kommas getrennte Liste der Knowledge Assist-Funktionen, die gerendert werden sollen (ARTICLE_SUGGESTION, FAQ und ARTICLE_SEARCH).

Nutzung

Attribute sind stringbasierte Komponenteneigenschaften, die auf folgende Arten festgelegt werden können:

Direkt über Ihre HTML-Vorlage:

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

Über den JavaScript-Code:

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

Eingaben

Eigenschaft	Typ	Kommentar
config	KnowledgeAssistConfig	Optionale Konfigurationen für das Knowledge Assist-Modul.

Nutzung

Eingaben sind in der Regel JavaScript-Objekte oder andere komplexe Property-Typen, die direkt der Elementinstanz zugewiesen werden müssen:

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

Typen

Im folgenden Abschnitt finden Sie die benutzerdefinierten Typen, die von der Komponente verwendet werden.

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;
  };
}