Assistência de conhecimento

Esta página contém a documentação da API do módulo UI do Assistente de Conhecimento Generativo, também chamado de Knowledge Assist V2. Esse módulo é usado por agentes para consultar as bases de conhecimento da empresa e receber respostas com tecnologia de IA generativa.

Uso

Importe o módulo na sua página HTML usando o código a seguir:

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

Incorpore o módulo usando a tag a seguir:

<agent-assist-knowledge-assist-v2>

Atributos

Nome da propriedade Tipo Comentário
session-id string ID de sessão opcional para uso não baseado em conversas.
primária string Nome do local do projeto pai a ser usado para uso não baseado em conversas. Exemplo: "projects/foo/locations/global"

Uso

Os atributos são propriedades de componentes baseadas em strings que podem ser definidas das seguintes maneiras:

Diretamente do modelo HTML:

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

Do código JavaScript:

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

Entradas

Nome da propriedade Tipo Comentário
config KnowledgeAssistV2Config Configurações opcionais para o módulo Knowledge Assist V2.

Uso

As entradas geralmente são objetos JavaScript ou outros tipos de propriedades complexas que precisam ser atribuídas diretamente à instância do elemento:

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

Tipos

Consulte a seção a seguir para ver os tipos personalizados usados pelo componente.

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