Assistant Knowledge

Cette page contient la documentation de l'API pour le module d'interface utilisateur Knowledge Assist. Ce module permet d'afficher des articles utiles et des suggestions de questions fréquentes aux agents au cours d'une conversation.

Utilisation

Importez le module dans votre page HTML à l'aide du code suivant:

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

Intégrez le module à l'aide de la balise suivante:

<agent-assist-knowledge-assist>

Attributs

Nom de propriété	Type	Commentaire
fonctionnalités	chaîne	Liste des fonctionnalités Knowledge Assist à afficher, séparées par des virgules (ARTICLE_SUGGESTION, FAQ et ARTICLE_SEARCH).

Utilisation

Les attributs sont des propriétés de composant basées sur des chaînes qui peuvent être définies comme suit:

Directement depuis votre modèle HTML:

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

Dans votre code JavaScript:

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

Entrées

Nom de propriété	Type	Commentaire
config	KnowledgeAssistConfig	Configurations facultatives pour le module Knowledge Assist.

Utilisation

Les entrées sont généralement des objets JavaScript ou d'autres types de propriétés complexes qui doivent être attribués directement à l'instance de l'élément:

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

Types

Consultez la section suivante pour connaître les types personnalisés utilisés par le composant.

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