Container V1

Esta página contém a documentação da API para o método de contentor de implementação de módulos da IU. Seguem-se as funcionalidades do Agent Assist que pode implementar como componentes no seu contentor.

Atributos

Nome de propriedade Tipo Comentário
funcionalidades de string Lista separada por vírgulas das chaves de funcionalidades de sugestões do Assistente do agente a renderizar. Exemplo: "SMART_REPLY, CONVERSATION_SUMMARIZATION"
api-headers de string Cabeçalhos adicionais a incluir nas chamadas da API Dialogflow. Exemplo: "Content-Type:application/json, Accept:application/json"
conversation-profile de string Nome do perfil de conversa a usar.
agent-desktop AgentDesktop Software de computador do agente para integração.
auth-token de string Token de autenticação a usar para chamadas à API.
api-key de string Chave da API opcional a usar para chamadas da API.
canal CommunicationChannel Canal de comunicação usado para esta aplicação (chat, voz ou omnicanal).
custom-api-endpoint de string Ponto final da API personalizado opcional a usar (se os módulos da IU estiverem configurados com um servidor proxy).
tema 'dark' | 'light' Tema de cores a usar.
show-header BooleanString Se o cabeçalho de sugestões do Agent Assist deve ser apresentado.
dark-mode-background de string Cor de fundo a usar para o modo escuro. Se não for especificado nenhum, são fornecidas predefinições para os computadores dos agentes suportados principais.
notifier-server-endpoint de string Ponto final do servidor de notificação a usar para conversas baseadas em eventos.
event-based-transport EventBasedTransport Protocolo de transporte a usar para conversas baseadas em eventos.
event-based-library EventBasedLibrary Biblioteca a usar para conversas baseadas em eventos.
oauth-client-id de string ID de cliente OAuth opcional para autenticação implícita, usado em algumas configurações do ambiente de trabalho do agente (Genesys Cloud).
redirect-uri de string URI de redirecionamento opcional para navegar após a autenticação, usado em algumas configurações de computador de agente (Genesys Cloud).
genesys-cloud-region de string Região opcional para o Genesys Cloud, predefinida como mypurecloud.com.

Utilização

Os atributos são propriedades de componentes baseadas em strings que podem ser definidas das seguintes formas:

HTML

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

JavaScript

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

Entradas

Nome de propriedade Tipo Comentário
socketIoConnectOpts SocketIoConnectOpts Opções de ligação adicionais do Socket.io.
config UiModuleContainerConfig Objeto de configuração para definir configurações específicas do módulo.

Utilização

Normalmente, as entradas são objetos JavaScript ou outros tipos de propriedades complexas que têm de ser atribuídos diretamente na instância do elemento:

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

Tipos

Consulte a secção seguinte para ver os tipos personalizados usados pelo 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";
  };
}