Knowledge Assist

Esta página contiene la documentación de la API del módulo de IU de Knowledge Assist. Este módulo se usa para mostrarles artículos útiles y sugerencias de preguntas frecuentes a los agentes durante una conversación.

Uso

Importa el módulo en tu página HTML con el siguiente código:

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

Incorpora el módulo con la siguiente etiqueta:

<agent-assist-knowledge-assist>

Atributos

Nombre de la propiedad	Tipo	Comentario
características	string	Es una lista de funciones de Knowledge Assist separadas por comas que se deben renderizar (ARTICLE_SUGGESTION, FAQ y ARTICLE_SEARCH).

Uso

Los atributos son propiedades de componentes basadas en cadenas que se pueden establecer de las siguientes maneras:

Directamente desde tu plantilla HTML:

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

Desde tu código JavaScript:

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

Entradas

Nombre de la propiedad	Tipo	Comentario
config	KnowledgeAssistConfig	Configuraciones opcionales para el módulo Knowledge Assist.

Uso

Por lo general, las entradas son objetos JavaScript o algún otro tipo de propiedad compleja que se debe asignar directamente en la instancia del elemento:

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

Tipos

Consulta la siguiente sección para conocer los tipos personalizados que usa el 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;
  };
}