Assistência de conhecimento

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

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

Incorpore o módulo usando a tag a seguir:

<agent-assist-knowledge-assist>

Atributos

Nome da propriedade	Tipo	Comentário
recursos	string	Lista separada por vírgulas dos recursos do Knowledge Assist que precisam ser renderizados (ARTICLE_SUGGESTION, FAQ e ARTICLE_SEARCH).

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	KnowledgeAssistConfig	Configurações opcionais para o módulo do Knowledge Assist.

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