Knowledge Assist

Esta página contiene la documentación de la API para el módulo de IU de Generative knowledge assist, también llamado Knowledge Assist V2. Los agentes usan este módulo para consultar las bases de conocimiento de su empresa y recibir respuestas potenciadas por IA generativa.

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

Incorpora el módulo con la siguiente etiqueta:

<agent-assist-knowledge-assist-v2>

Atributos

Nombre de la propiedad Tipo Comentario
session-id string Es el ID de sesión opcional para el uso que no se basa en conversaciones.
elemento superior string Es el nombre de la ubicación del proyecto superior que se usará para el uso que no se basa en conversaciones. Ejemplo: "projects/foo/locations/global"

Uso

Los atributos son propiedades de componentes basadas en cadenas que se pueden configurar 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 KnowledgeAssistV2Config Son las configuraciones opcionales para el módulo Knowledge Assist V2.

Uso

Las entradas suelen ser objetos de JavaScript o tipos de propiedades complejas que se deben 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.

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