Container V1

Esta página contém a documentação da API para o método de contêiner de implementação de módulos UI. Confira a seguir os recursos do Assistente de IA que podem ser implementados como componentes no seu contêiner.

Atributos

Nome da propriedade Tipo Comentário
recursos string Lista separada por vírgulas de chaves de recursos de sugestão do Assistente do agente a serem renderizadas. Exemplo: "SMART_REPLY, CONVERSATION_SUMMARIZATION"
api-headers string Cabeçalhos extras a serem incluídos nas chamadas da API Dialogflow. Exemplo: "Content-Type:application/json, Accept:application/json"
conversation-profile string Nome do perfil de conversa a ser usado.
agent-desktop AgentDesktop Software de área de trabalho do agente para integração.
auth-token string Token de autenticação a ser usado para chamadas de API.
api-key string Chave de API opcional a ser usada para chamadas de API.
canal CommunicationChannel Canal de comunicação usado para este aplicativo (chat, voz ou omnicanal).
custom-api-endpoint string Endpoint de API personalizado opcional a ser usado (se os módulos da UI forem configurados com um servidor proxy).
tema 'dark' | 'light' Tema de cores a ser usado.
show-header BooleanString Indica se o cabeçalho de sugestões do Assistente do agente será mostrado.
dark-mode-background string Cor de plano de fundo a ser usada no modo escuro. Se nenhum for especificado, os padrões serão fornecidos para as principais áreas de trabalho de agentes compatíveis.
notifier-server-endpoint string Endpoint do servidor de notificação a ser usado para conversas baseadas em eventos.
event-based-transport EventBasedTransport Protocolo de transporte a ser usado para conversas baseadas em eventos.
event-based-library EventBasedLibrary Biblioteca a ser usada para conversas baseadas em eventos.
oauth-client-id string ID do cliente OAuth opcional para autenticação implícita, usado em algumas configurações de área de trabalho do agente (Genesys Cloud).
redirect-uri string URI de redirecionamento opcional para navegar após a autenticação, usado em algumas configurações de área de trabalho do agente (Genesys Cloud).
genesys-cloud-region string Região opcional para o Genesys Cloud, o padrão é mypurecloud.com.

Uso

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

HTML

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

JavaScript

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

Entradas

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

Uso

As entradas geralmente são objetos JavaScript ou outros tipos de propriedades complexas que precisam ser atribuídas diretamente na instância do elemento:

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

Tipos

Consulte a seção a seguir 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";
  };
}