Contenedor

Esta página contiene la documentación de la API para el método Container de implementación de módulos de IU. Las siguientes son las funciones de Agent Assist que puedes implementar como componentes dentro de tu contenedor.

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

Incorpora el módulo con la siguiente etiqueta:

<agent-assist-ui-modules>

Atributos

Nombre de la propiedad Tipo Comentario
características string Es una lista separada por comas de las claves de funciones de sugerencias de Agent Assist que se deben renderizar. Ejemplo: "SMART_REPLY, CONVERSATION_SUMMARIZATION"
api-headers string Encabezados adicionales para incluir en las llamadas a la API de Dialogflow. Ejemplo: "Content-Type:application/json, Accept:application/json"
conversation-profile string Es el nombre del perfil de conversación que se usará.
agent-desktop AgentDesktop Software de escritorio del agente con el que se integrará.
auth-token string Es el token de autenticación que se usará para las llamadas a la API.
api-key string Clave de API opcional para usar en las llamadas a la API.
canal CommunicationChannel Es el canal de comunicación que se usó para esta solicitud (chat, voz o varios canales).
custom-api-endpoint string Es el extremo de API personalizado opcional que se usará (si los módulos de la IU están configurados con un servidor proxy).
tema 'dark' | 'light' Es el tema de color que se usará.
show-header BooleanString Indica si se debe mostrar el encabezado de sugerencias de Asistente de agentes.
dark-mode-background string Es el color de fondo que se usará para el modo oscuro. Si no se especifica ninguno, se proporcionan valores predeterminados para los escritorios de los agentes principales admitidos.
notifier-server-endpoint string Es el extremo del servidor de notificaciones que se usará para las conversaciones basadas en eventos.
transporte basado en eventos EventBasedTransport Es el protocolo de transporte que se usa para las conversaciones basadas en eventos.
library-based-event EventBasedLibrary Biblioteca para usar en conversaciones basadas en eventos.
oauth-client-id string ID de cliente de OAuth opcional para la autenticación implícita, que se usa en algunas configuraciones de escritorio de agentes (Genesys Cloud).
redirect-uri string Es un URI de redireccionamiento opcional al que se puede navegar después de la autenticación, que se usa en algunas configuraciones de agentes de escritorio (Genesys Cloud).
genesys-cloud-region string Región opcional para Genesys Cloud. El valor predeterminado es mypurecloud.com.

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
socketIoConnectOpts SocketIoConnectOpts Opciones de conexión adicionales de Socket.io.
config UiModuleContainerConfig Objeto de configuración para definir configuraciones específicas del módulo.

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.

AgentDesktop

"LivePerson" | "GenesysCloud" | "SalesForce" | "Custom"

CommunicationChannel

"chat" | "voice" | "omnichannel"

BooleanString

"true" | "false"

EventBasedTransport

"websocket" | "polling"

EventBasedLibrary

"SocketIo"

SocketIoConnectOpts

interface SocketIoConnectOpts extends SocketIOClient.ConnectOpts {
  auth: {
    token: string;
  };
  withCredentials?: boolean;
}

UiModuleContainerConfig

interface UiModuleContainerConfig {
  knowledgeAssistConfig?: {
    articleLinkConfig: {
      /**
       * Whether to open the article in a new tab or as a dialog. 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;
    };
  };
  knowledgeAssistV2Config?: {
    articleLinkConfig?: {
      /**
       * Whether to open the article in a new tab or as a dialog. 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;
  };
  summarizationConfig?: {
    /**
     * Optional callback that can be used to save the generated summary to an
     * external source.
     */
    onSaveSummary?: (
      summary: {
        summary: string;
        conversationDetails: ConversationDetails;
      },
      saveCallbacks: {
        setLoading: () => void;
        setSuccess: (message: string) => void;
        setError: (message: string) => void;
      }
    ) => void;

    /** Whether to show the 'Generate summary' button. */
    showGenerateSummaryButton?: "true" | "false";
  };
}