Assistenza per le conoscenze

Questa pagina contiene la documentazione dell'API per il modulo dell'interfaccia utente Generative knowledge assist, chiamato anche Knowledge Assist V2. Questo modulo viene utilizzato dagli agenti per eseguire query nelle knowledge base della loro azienda e ricevere risposte basate sull'AI generativa.

Utilizzo

Importa il modulo nella pagina HTML utilizzando il seguente codice:

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

Incorpora il modulo utilizzando il seguente tag:

<agent-assist-knowledge-assist-v2>

Attributi

Nome proprietà Tipo Commento
session-id string ID sessione facoltativo per l'utilizzo non basato su conversazione.
principale string Nome della località del progetto padre da utilizzare per l'utilizzo non basato su conversazione. Esempio: "projects/foo/locations/global"

Utilizzo

Gli attributi sono proprietà dei componenti basate su stringhe che possono essere impostate nei seguenti modi:

Direttamente dal modello HTML:

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

Dal codice JavaScript:

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

Input

Nome proprietà Tipo Commento
config KnowledgeAssistV2Config Configurazioni facoltative per il modulo Knowledge Assist V2.

Utilizzo

Gli input sono in genere oggetti JavaScript o altri tipi di proprietà complessi che devono essere assegnati direttamente all'istanza dell'elemento:

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

Tipi

Per i tipi personalizzati utilizzati dal componente, consulta la sezione seguente.

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