Knowledge Assist

Esta página contém a documentação da API para o módulo de IU Knowledge Assist. Este módulo é usado para mostrar artigos úteis e sugestões de Perguntas frequentes aos agentes durante uma conversa.

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/v1/knowledge_assist.js"></script>

Incorpore o módulo com a seguinte etiqueta:

<agent-assist-knowledge-assist>

Atributos

Nome de propriedade	Tipo	Comentário
funcionalidades	de string	Lista separada por vírgulas de funcionalidades do Knowledge Assist que devem ser renderizadas (ARTICLE_SUGGESTION, FAQ e ARTICLE_SEARCH).

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	KnowledgeAssistConfig	Configurações opcionais para o módulo de assistência de conhecimentos.

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.

KnowledgeAssistConfig

interface KnowledgeAssistConfig {
  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;
  };
}