Assistance par le biais de connaissances

Cette page contient la documentation de l'API pour le module d'interface utilisateur Assistance pour les connaissances génératives, également appelé Knowledge Assist V2. Ce module permet aux agents d'interroger les bases de connaissances de leur entreprise et de recevoir des réponses optimisées par l'IA générative.

Utilisation

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

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

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

<agent-assist-knowledge-assist-v2>

Attributs

Nom de propriété	Type	Commentaire
session-id	chaîne	ID de session facultatif pour une utilisation non basée sur une conversation.
parent	chaîne	Nom de l'emplacement du projet parent à utiliser pour les utilisations non basées sur les conversations. Exemple : "projects/foo/locations/global"

Utilisation

Les attributs sont des propriétés de composant basées sur des chaînes qui peuvent être définies de différentes manières :

Directement depuis votre modèle HTML :

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

Depuis votre code JavaScript :

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

Entrées

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

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 d'é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.

KnowledgeAssistV2Config

interface KnowledgeAssistV2Config {
  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;
  };
  showCopyAnswer: boolean;
  showPasteAnswer: boolean;
}