Contenedor V1

En esta página, se incluye la documentación de la API para el método de contenedor 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.

Atributos

Nombre de la propiedad Tipo Comentario
características string Lista separada por comas de las claves de funciones de sugerencias de Agent Assist que se renderizarán. 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 Nombre del perfil de conversación que se usará.
agent-desktop AgentDesktop Software de escritorio del agente para integrar.
auth-token string Token de autenticación que se usará para las llamadas a la API.
api-key string Clave de API opcional que se usará para las llamadas a la API.
canal CommunicationChannel Canal de comunicación que se usa para esta aplicación (chat, voz o omnicanal).
custom-api-endpoint string extremo de API personalizado opcional que se usará (si los módulos de IU están configurados con un servidor proxy).
tema "oscuro" o "claro" Tema de color que se usará.
show-header BooleanString Indica si se debe mostrar el encabezado de sugerencias de Agent Assist.
dark-mode-background string Color de fondo que se usará para el modo oscuro. Si no se especifica ninguno, se proporcionan valores predeterminados para los escritorios de agentes principales compatibles.
notifier-server-endpoint string Extremo del servidor de notificaciones que se usará para las conversaciones basadas en eventos.
event-based-transport EventBasedTransport Protocolo de transporte que se usará para las conversaciones basadas en eventos.
event-based-library EventBasedLibrary Biblioteca que se usará para las 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 del agente (Genesys Cloud).
redirect-uri string URI de redireccionamiento opcional al que se navegará después de la autenticación, que se usa en algunas configuraciones de escritorio del agente (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 configurar de las siguientes maneras:

HTML

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

JavaScript

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

Entradas

Nombre de la propiedad Tipo Comentario
socketIoConnectOpts SocketIoConnectOpts Opciones de conexión de Socket.io adicionales.
config UiModuleContainerConfig Objeto de configuración para definir configuraciones específicas del módulo.

Uso

Las entradas suelen ser objetos de JavaScript o tipos de propiedades complejos 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.

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