Contêiner

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

Uso

Importe o módulo na página HTML usando o seguinte código:

<script src="https://www.gstatic.com/agent-assist-ui-modules/v1/container.js"></script>

Incorpore o módulo usando a seguinte tag:

<agent-assist-ui-modules>

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 adicionais 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 agente para computador para integração.
auth-token string Token de autenticação a ser usado para chamadas de API.
chave-da-api string Chave de API opcional para usar nas chamadas de API.
canal CommunicationChannel Canal de comunicação usado para este aplicativo (chat, voz ou omnichannel).
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 do plano de fundo a ser usada no modo escuro. Se nenhum for especificado, os padrões serão fornecidos para os computadores de mesa com agentes principais compatíveis.
notifier-server-endpoint string Endpoint do servidor do Notifier a ser usado para conversas baseadas em eventos.
transporte-baseado-em-eventos EventBasedTransport Protocolo de transporte a ser usado para conversas baseadas em eventos.
biblioteca-baseada-em-eventos EventBasedLibrary Biblioteca 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 agentes para computador (Genesys Cloud).
redirect-uri string URI de redirecionamento opcional para navegar após a autenticação, usado em algumas configurações de agentes para computador (Genesys Cloud).
genesys-cloud-region string Região opcional para a Genesys Cloud, padrão mypurecloud.com.

Uso

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

No modelo HTML:

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

No código JavaScript:

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

Entradas

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

Uso

Os inputs geralmente são objetos JavaScript ou outros tipos de propriedade complexos que precisam ser atribuídos diretamente à instância do elemento:

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

Tipos

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