Esta página contém a documentação da API do módulo de IU Assistente de conhecimentos generativo, também denominado Assistente de conhecimentos V2. Este módulo é usado pelos agentes para consultar as bases de conhecimentos da respetiva empresa e receber respostas com tecnologia de IA generativa.
Utilização
Importe o módulo na sua página HTML através do seguinte código:
<script src="https://www.gstatic.com/agent-assist-ui-modules/v2/knowledge_assist.js"></script>
Incorpore o módulo com a seguinte etiqueta:
<agent-assist-knowledge-assist-v2>
Atributos
Nome de propriedade | Tipo | Comentário |
---|---|---|
session-id | de string | ID da sessão opcional para utilização não baseada em conversas. |
pai ou mãe | de string | Nome da localização do projeto principal a usar para a utilização não baseada em conversas. Exemplo: "projects/foo/locations/global" |
Utilização
Os atributos são propriedades de componentes baseadas em strings que podem ser definidas das seguintes formas:
Diretamente a partir do modelo HTML:
<element-selector property-name="value">
A partir do código JavaScript:
var el = document.querySelector('element-selector');
el.setAttribute('property-name', 'value');
Entradas
Nome de propriedade | Tipo | Comentário |
---|---|---|
config | KnowledgeAssistV2Config | Configurações opcionais para o módulo Knowledge Assist V2. |
Utilização
Normalmente, as entradas são objetos JavaScript ou outros tipos de propriedades complexas que têm de ser atribuídos diretamente na instância do elemento:
const el = document.querySelector('element-selector');
el.propertyName = value;
Tipos
Consulte a secção seguinte 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;
}