Esta página contém a documentação da API para o módulo UI Assistente de conhecimento generativo, também chamado de Assistente de conhecimento V2. Os agentes usam esse módulo para consultar as bases de conhecimento da empresa e receber respostas com IA generativa.
Uso
Importe o módulo na página HTML usando o seguinte código:
<script src="https://www.gstatic.com/agent-assist-ui-modules/v2/knowledge_assist.js"></script>
Incorpore o módulo usando a seguinte tag:
<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 conversa. |
primária | string | Nome do local do projeto pai a ser usado para uso não baseado em conversa. Exemplo: "projects/foo/locations/global" |
Uso
Os atributos são propriedades de componentes baseadas em string que podem ser definidos das seguintes maneiras:
No modelo HTML:
<element-selector property-name="value">
No 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 do Knowledge Assist V2. |
Uso
Os inputs geralmente são objetos JavaScript ou outros tipos de propriedade complexos que precisam ser atribuídos diretamente à instância do elemento:
const el = document.querySelector('element-selector');
el.propertyName = value;
Tipos
Consulte a seção a seguir para saber mais sobre 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;
}