Wissensassistent

Diese Seite enthält die API-Dokumentation für das UI-Modul „Generative knowledge assist“ (Generative Wissensunterstützung), auch Knowledge Assist V2 genannt. Dieses Modul wird von Agenten verwendet, um die Knowledge Bases ihres Unternehmens abzufragen und Antworten zu erhalten, die auf generativer KI basieren.

Nutzung

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

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

Betten Sie das Modul mit dem folgenden Tag ein:

<agent-assist-knowledge-assist-v2>

Attribute

Eigenschaft	Typ	Kommentar
session-id	String	Optionale Sitzungs-ID für die nicht auf Unterhaltungen basierende Nutzung.
parent	String	Name des übergeordneten Projekts, der für die nicht auf Unterhaltungen basierende Nutzung verwendet werden soll. Beispiel: „projects/foo/locations/global“

Nutzung

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

Direkt aus Ihrer HTML-Vorlage:

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

Aus Ihrem JavaScript-Code:

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

Eingaben

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

Nutzung

Eingaben sind in der Regel JavaScript-Objekte oder andere komplexe Eigenschaftstypen, 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.

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