Esta página contiene la documentación de la API del módulo de interfaz de usuario Asistencia con conocimientos generativos, también llamado Asistencia con conocimientos V2. Los agentes usan este módulo para consultar las bases de conocimientos de su empresa y recibir respuestas basadas en 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>
Inserta el módulo con la siguiente etiqueta:
<agent-assist-knowledge-assist-v2>
Atributos
Nombre de la propiedad | Tipo | Comentario |
---|---|---|
session-id | cadena | ID de sesión opcional para el uso no basado en conversaciones. |
parent | cadena | Nombre de la ubicación del proyecto principal que se va a usar para el uso no basado en conversaciones. Ejemplo: "projects/foo/locations/global" |
Uso
Los atributos son propiedades de componentes basadas en cadenas que se pueden definir de las siguientes formas:
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 | Configuraciones opcionales del módulo Asistencia con conocimientos (versión 2). |
Uso
Las entradas suelen ser objetos de JavaScript u otros tipos de propiedades complejas que deben asignarse directamente en la instancia del elemento:
const el = document.querySelector('element-selector');
el.propertyName = value;
Tipos
En la siguiente sección se indican los tipos personalizados que utiliza 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;
}