Recursos para integrações de agente virtual personalizadas

Esta página fornece informações de referência e recursos para ajudar durante o planejamento e a implementação de sua de integração de agente virtual personalizada.

Arquitetura

Ao projetar sua integração de agente virtual personalizada, há algumas considerações importantes a serem feitas em relação à latência. A prática recomenda é fazer com que o terminal personalizado interaja com apenas um componente na arquitetura. Quanto mais componentes o terminal interagir durante uma única solicitação, maiores serão as chances de ocorrência de latência. Um componente é um processo como uma conversão de fala em texto ou um mecanismo de entendimento de linguagem natural.

O exemplo a seguir mostra uma arquitetura propensa à latência. Isso ocorre porque várias interações de API são necessárias para gerar uma resposta para uma única solicitação.

Uma arquitetura mais eficiente faz apenas uma interação por requisição. Isso minimiza as chances de ocorrência de latência durante uma conversa com um contato.

Design do túnel proxy e webhook

O túnel proxy é o middleware entre CXone e o terminal do serviço de agente virtual. Todas as solicitações e respostam passam por ele. Além disso, converte as solicitações e respostas no formato necessário para o sistema de destino. O diagrama a seguir ilustra esse processo:

O diagrama mostra que o túnel proxy recebe uma solicitação do CXone (mostrado com uma linha sólida) e a converte no formato que o agente virtual pode entender (mostrado com uma linha tracejada). Em seguida, ele recebe uma resposta do agente virtual (linha tracejada) e a converte no formato que o CXone entende (linha sólida).

É importante entender os esquemas do CXone e do seu agente virtual, bem como os requisitos do seu plano de integração específico. Os esquemas e parâmetros devem ser mapeados e convertidos corretamente. Isso garante que as informações esperadas sejam transmitidas entre o CXone e o agente virtual. Além disso, sua integração pode não precisar de todos os parâmetros contidos nos esquemas. Uma compreensão completa da sua integração garante que apenas os parâmetros necessários sejam convertidos.

Requisitos do túnel proxy

O túnel proxy também é um webhook. Deve ser um URL público. Ele recebe as solicitações de conversação dos scripts do Studio. O terminal do webhook deve:

• Suportar uma solicitação POST com um corpo de solicitação serializado no formato ExternalIntegrationBotExchangeRequest.
• Converter a ExternalIntegrationBotExchangeRequest no formato exigido pelo agente virtual.
• Converter a resposta no formato CustomExchangeResponseV1 que o CXone exige.

O terminal do túnel proxy pode ser local ou hospedado em um serviço de nuvem, como Google Cloud, Microsoft Azure ou Amazon Web Services. Use HTTPS no seu terminal.

Se você quiser usar a autenticação mTLS entre CXone e o webhook, você deve ativá-la no webhook.

Atualizações para os esquemas de solicitação e resposta

Os esquemas de solicitação e resposta podem mudar à medida que a NICE CXone lança atualizações. Isso pode afetar o funcionamento da sua integração de agente virtual personalizada. O Hub de Agente Virtual permite que você escolha quando mudar para uma nova versão da integração. Isso permite que você atualize o túnel proxy, seus scripts e seu serviço de agente virtual para lidar com as alterações nos esquemas.

Quando estiver pronto para mudar para a nova versão, selecione-a no campo Versão de integração no aplicativo Custom Exchange Endpoint no Hub de Agente Virtual.

Casos de Uso

O diagrama de sequência a seguir mostra um caso de uso de uma consulta de status de pedido em um canal de voz. Este exemplo mostra as solicitações e respostas durante a interação. Ele inclui conversão de texto em fala e fala em texto conforme as solicitações verbais do contato são convertidas em texto e as respostas do agente virtual são convertidas em fala sintetizada. O exemplo também mostra o contato usando DTMF Tons de sinalização gerados quando um usuário pressiona ou toca em uma tecla do teclado do telefone. para inserir o número do pedido.

Ao projetar o túnel proxy, você deve documentar os esquemas de solicitação e resposta. Um exemplo disso é fornecido no exemplo documento de design técnico (TDD). Exemplos adicionais de integrações de agentes virtuais personalizadas estão disponíveis. Esses designs mostram outras possibilidades do túnel proxy em diferentes arquiteturas de rede.

Diagramas de sequência

Os diagramas de sequência mostram como várias partes de uma integração de agente virtual personalizada interagem e a ordem em que essas interações ocorrem. Eles mostram a linha do tempo de uma interação, começando no canto superior esquerdo, depois vai e volta até o final da página.

Os diagramas de sequência são uma parte importante do planejamento de sua integração de agente virtual personalizada. Você pode usá-los para mapear o fluxo de solicitações e respostas entre o CXone, o Hub de Agente Virtual, o túnel proxy e seu agente virtual. Eles também podem ser úteis para determinar o fluxo que seu script do Studio deve seguir.

Você pode criar diagramas diferentes para os vários casos de uso que sua integração pode ter. Um exemplo detalhado de um caso de uso é mostrado na seção sobre design de túnel proxy nesta página.

Requisitos de configuração do CXone

Um ponto de contato O ponto de entrada que um contato de entrada usa para iniciar uma interação, como um número de telefone ou endereço de e-mail. é necessário para vincular o canal Uma maneira de os contatos interagirem com agentes ou bots. Um canal pode ser voz, e-mail, chat, mídia social e assim por diante. que os contatos usam ao script do Studio que lida com essas interações. Se as interações puderem vir de mais de um canal, você precisará de um ponto de contato para cada canal. Mais de um canal pode chamar o mesmo script, desde que o tipo de mídia seja o mesmo.

Você deve escolher uma competência ACD Usado para automatizar a entrega de interações com base nas competências, habilidades e conhecimento do agente. ao criar pontos de contato. Nas interações com agentes virtuais, as competências ACD atribuídas aos pontos de contato não são usadas para rotear contatos. No entanto, eles afetam os relatórios. Dependendo dos relatórios que sua organização usa, pode ser necessário criar novas competências ACD para usar com sua integração personalizada. Se você tiver vários pontos de contato para sua integração personalizada, talvez queira competências ACD separadas para cada um para fins de relatório. Se você criar competências ACD separadas, também precisará de uma campanha para cada competência ACD.

Consulte estas páginas na ajuda online do CXone para obter informações sobre cada tarefa:

• Crie uma campanha para canais de voz e chat do CXone.
• Crie uma competência ACD para canais de voz ou chat do CXone. Você não precisa adicionar usuários à competência ACD atribuída ao ponto de contato. As competências ACD não são usadas para encaminhar interações para agentes virtuais. No entanto, se seu script permitir que os contatos sejam transferidos para um agente ativo, você precisará de uma ou mais competências ACD para usar em seu script quando um agente for solicitado.
• Crie um ponto de contato para canais de voz e chat do CXone. O ponto de contato deve ser configurado com o nome da competência ACD que o utiliza e o script que você quer executar quando um contato é encaminhado para a competência ACD nomeada.

Além das competências ACD necessárias para os pontos de contato, você pode precisar de outras competências ACD para concluir os scripts exigidos por sua integração de agente virtual personalizado. Por exemplo, você pode precisar de competências ACD para encaminhar contatos para agentes ativos se o agente virtual determinar que um agente real é necessário. Você pode usar competências ACD existentes ou criar novas.

Requisitos e diretrizes de script

As integrações de agente virtual personalizadas requerem pelo menos um script do Studio que inclua uma ação do agente virtual. Muitas vezes, as integrações requerem vários scripts. As ações do agente virtual conectam o CXone ao seu provedor de agente virtual.

Scripts de amostra são fornecidos para você usar como referência.

• Baixar um script de agente virtual de texto de amostra (arquivo ZIP).
• Baixar um script de agente virtual de voz de amostra (arquivo ZIP).

Tipo de mídia

Crie seus scripts com o tipo de mídia correto para o canal Uma maneira de os contatos interagirem com agentes ou bots. Um canal pode ser voz, e-mail, chat, mídia social e assim por diante. que você quer que ele ofereça suporte. Para suportar interações telefônicas, o script deve ter o tipo de mídia voz. Para suportar interações baseadas em texto, o script deve ter o tipo de mídia chat.

Tipos de scripts

Você pode precisar de mais de um script para integrar seu agente virtual. Cada um dos seguintes cenários requer seu próprio script:

• Interações de entrada: As interações de entrada acontecem quando um contato inicia a interação. Por exemplo, ligando para sua organização ou iniciando um chat no seu site.
• Interações de saída: As interações de saída acontecem quando sua organização inicia as interações. Por exemplo, ligando para um contato para lembrá-lo do próximo compromisso ou enviando uma mensagem por meio de um canal digital de mensagem direta com uma atualização de conta.

Ações do Studio de agente virtual

Há duas ações do Studio disponíveis para uso com scripts de agente virtual: Voicebot Exchange e Textbot Exchange. Utilize a que for apropriada ao tipo de interação a ser feita pelo bot.

Requisitos de script

Se você usar ações Exchange, deverá definir o fluxo da conversa entre o contato e o agente virtual Um aplicativo de software que interage com os clientes no lugar de um agente humano ao vivo. em seu script. Você pode fazer isso usando o código personalizado em ações Snippet. Os scripts de exemplo mostram como fazer isso. Consulte a seção Código de ação Snippet abaixo para saber mais. Você não precisa definir o fluxo da conversa ao usar uma ação Conversation, porque o agente virtual cuida do fluxo.

Para concluir o script do agente virtual, você também pode precisar de:

• Configure a ação do agente virtual, que inclui adicioná-la ao Hub de Agente Virtual e atribuí-la à ação em seu script. Consulte a ajuda online da ação que você está usando para obter informações sobre as propriedades da ação.
• Adicione trechos de inicialização conforme necessário ao script usando ações Snippet.  Você pode fazer isso para personalizar seu agente virtual ou enviar informações de identificação do cliente para o agente virtual.
• Reconfigure os conectores de ação para garantir o fluxo de contato adequado e corrigir possíveis erros.
• Conecte todas as ramificações de forma apropriada.

• Adicione código para lidar com a autorização. O script deve passar os cabeçalhos de autorização a cada turno da conversa. Se você estiver usando a versão de integração 1.0.0 e quiser usar a autenticação dinâmica, deverá configurar seu script para lidar com isso. Se você estiver usando a versão de integração 2.0.0 ou 3.0.0, o Hub de Agente Virtual lida com a autenticação dinâmica automaticamente depois que você configurá-la.

  As versões de integração 1.0.0 e 2.0.0 serão descontinuadas em uma versão futura. A versão 3.0.0 é a versão preferida para usar com integrações de agentes virtuais personalizados. Se você usa atualmente a versão 1.0.0 ou 2.0.0, planeje o upgrade para 3.0.0. A versão 3.0.0 é quase idêntica à versão 2.0.0. A principal diferença é que a 3.0.0 adiciona suporte para StandardBot.

• Use a ramificação OnReturnControlToScript para lidar com o desligamento ou encerramento da interação. Se você usar a ramificação Default, seu script pode não funcionar conforme o esperado.
• Conclua qualquer script adicional e teste o script.

Se você precisar de assistência com scripting no Studio, entre em contato com seu Representante de Contas do CXone, consulte a seção Guia de Scripting da ajuda online ou visite o site da Comunidade NICE CXone.

Código de ação Snippet

Os scripts para integrações de agentes virtuais requerem ações Snippet para adicionar variáveis, objetos e código personalizado no script. O código em ações Snippet deve ser escrito em Snippet, uma linguagem de programação interna desenvolvida pela NICE CXone. O material de referência para Snippet está disponível na ajuda online do CXone.

Exemplos de código snippet para integrações de agente virtual personalizadas são fornecidos para você usar. Os seguintes snippets estão disponíveis:

• Carga útil personalizada
• Comportamento do Próximo Prompt e Comportamento Padrão do Próximo Prompt
• Próxima sequência de prompts

Scripts adicionais necessários

Você também deve ter scripts que:

• Encaminhem os contatos para o script do agente virtual usando uma ou mais competências ACD Usado para automatizar a entrega de interações com base nas competências, habilidades e conhecimento do agente.. Por exemplo, você pode ter um script IVR Menu de telefone automatizado que permite que os chamadores interajam por meio de comandos de voz, entradas de teclas ou ambos para obter informações, encaminhar uma chamada de voz de entrada ou ambos. que encaminha contatos para o script do agente virtual quando eles escolhem uma determinada opção de menu.
• Lidem com qualquer roteamento necessário após a conclusão da conversa ou o agente virtual determine que o contato precisa de um agente real.
• Definam opções de roteamento DTMF Tons de sinalização gerados quando um usuário pressiona ou toca em uma tecla do teclado do telefone. para tons que não levam ao agente virtual. Isso se aplica apenas a agentes virtuais baseados em voz.

Esses requisitos podem ser atendidos em um ou vários scripts. A prática recomendada de script é usar vários scripts menores. Isso facilita o gerenciamento de cada peça separadamente. Você pode usar a ação RunSub ou a ação Runscript para vincular scripts.

Autorização e autenticação

A autorização e a autenticação são importantes para a segurança da comunicação entre o CXone, o servidor proxy e o provedor do agente virtual. Os serviços geralmente requerem autorização, autenticação ou ambas para permitirem a transmissão de solicitações. Integrações de agentes virtuais personalizadas com o CXone suportam opções de autenticação e autorização:

• Autorização com cabeçalhos: Você pode usar autorização com cabeçalhos com qualquer versão de integração.
• Autenticação dinâmica com tokens: Você pode usar a autenticação dinâmica a partir da versão de integração 2.0.
• Autenticação entre o cliente e o servidor com mTLS: Você pode usar a autenticação mTLS a partir da versão de integração 3.0.0. Atualmente, ela é compatível apenas com integrações de agentes virtuais personalizadas.

Cabeçalhos

Cabeçalhos são pares de chave-valor enviados com cada solicitação feita ao agente virtual. Eles contêm credenciais que permitem que o serviço de agente virtual autentique a solicitação. Você deve gerar as credenciais no serviço de agente virtual. Quando você usa cabeçalhos para autenticação em sua integração de agente virtual personalizada, seu script deve ser configurado para enviar as informações do cabeçalho com cada solicitação.

Todas as versões do terminal de troca personalizado suportam cabeçalhos:

• Na versão 1.0.0, você pode enviar apenas um cabeçalho e o nome da chave é codificado como Autenticação.
• As versões 2.0.0 e 3.0.0 suportam vários cabeçalhos. Você pode usar qualquer par de chave-valor. Nenhum dos nomes de chave é codificado. Você precisa usar os pares de chave-valor que seu agente virtual espera. Obtenha as informações de cabeçalho necessárias com seu provedor de agente virtual.

Este exemplo mostra uma solicitação de cabeçalho de autorização que usa apenas cabeçalhos:

{
	"accessKeyId": "12998c017066eb0d2a70b94e6ed3192985855ce390f321bbdb832022888bd251===", 
	"accessKeySecret": "e97deac957f87d18ef0058a07dfa52501b312382691f5a1de5a712871fef69ee==="
}

Mais informações sobre o uso de cabeçalhos nas versões de integração 1.0.0 e 2.0.0 e 3.0.0 estão disponíveis nas seções a seguir.

Autenticação dinâmica

A autenticação dinâmica usa tokens em vez de cabeçalhos. Você deve ter um servidor de autorização separado. Um token é obtido do servidor de autorização e armazenado em cache. Ele dura um tempo definido antes de expirar e outro token deve ser obtido.

Você pode usar a autenticação dinâmica em ambas as versões do terminal de troca personalizado. No entanto, há diferenças entre as versões:

• Na versão 1.0.0, você deve configurar seu script para gerenciar todos os aspectos do gerenciamento de token.
• Na versão 2.0.0 e 3.0.0, o aplicativo Custom Exchange Endpoint no Hub de Agente Virtual gerencia os tokens usando as informações que você fornece no aplicativo.

O exemplo a seguir mostra um cabeçalho de autorização que usa tokens. Os pares de chave-valor em cabeçalhos e respostas de solicitação de autorização podem variar com base em como o serviço de autorização está configurado. O token de acesso no exemplo a seguir foi reduzido para economizar espaço.

{
	"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni",

	"expires_in": 3600,

	"token_type": "Bearer"

}		

Mais informações sobre como usar a autenticação baseada em token nas versões 1.0.0 e 2.0.0 e 3.0.0 estão disponíveis nas seções a seguir.

Autorização na versão 1.0.0

No terminal de troca personalizado versão 1.0.0, você pode enviar um cabeçalho com cada solicitação. Adicione os detalhes do cabeçalho no campo Cabeçalho de Autorização no aplicativo Custom Exchange Endpoint no Hub de Agente Virtual. A solicitação enviada ao terminal do agente virtual contém um par de chave-valor em que a chave é denominada Autorização e o valor é o cabeçalho que você coloca em Cabeçalho de Autorização. Você deve gerar o valor do cabeçalho em seu serviço de agente virtual. Seu script deve ser configurado para incluir o cabeçalho em cada solicitação.

Se você quiser usar a autenticação dinâmica com o ponto de extremidade de troca personalizado versão 1.0.0, precisará configurar seu script para lidar com isso. Isso não tem suporte por padrão. Use a ação REST API do Studio para se comunicar com o servidor de autenticação. O script deve lidar com a expiração do token e ser capaz de solicitar um novo token, se necessário. Você pode usar a Carga útil personalizada ou o snippet de Estado da sessão do bot para enviar o token de acesso. Você pode adicionar parâmetros a qualquer snippet para incluir o token de acesso durante um determinado turno de conversação. O snippet Estado da sessão do bot é o método preferido. O exemplo a seguir mostra uma arquitetura em que o script solicita tokens de autenticação:

Autorização com cabeçalhos na versão 2.0.0 e 3.0.0

No terminal de troca personalizado versão 2.0.0 e 3.0.0, você pode enviar mais de um cabeçalho com cada solicitação. Adicione os detalhes do cabeçalho nos campos Cabeçalhos Personalizados no aplicativo Custom Exchange Endpoint no Hub de Agente Virtual.

Os cabeçalhos podem ser quaisquer pares de chave-valor, mas os nomes das chaves devem corresponder ao que seu agente virtual espera. Isso é diferente da versão 1.0.0, em que a chave é denominada Autorização e não pode ser alterada.

Seu script deve ser configurado para incluir os cabeçalhos em cada solicitação.

Autenticação dinâmica com tokens na versão 2.0.0 e 3.0.0

No terminal de troca personalizado versão 2.0.0 e 3.0.0, o Hub de Agente Virtual gerencia tokens de autenticação dinâmica. Isso significa que você não precisa configurar seu script para lidar com eles, como faz com a versão 1.0.0.

Configure o aplicativo Custom Exchange Endpoint no Hub de Agente Virtual com as seguintes informações:

• URL do servidor de autorização.
• Pares de valor-chave para o corpo da solicitação de autenticação. Isso pode ser coisas como segredos de API ou credenciais de clientes.
• Pares de valor-chave para o cabeçalho na solicitação de autenticação.

Os tempos de expiração dos tokens podem existir em três lugares: no servidor OAuth, no aplicativo Custom Exchange Endpoints no Hub de Agente Virtual e na configuração padrão. O sistema os usa nesta ordem:

1. Se um tempo de expiração for enviado na resposta OAuth do servidor OAuth, esse tempo será usado para determinar quando o token de autorização expira.
2. Se a resposta OAuth não incluir um tempo de expiração, será usado o tempo configurado no aplicativo Custom Exchange Endpoints no Hub de Agente Virtual.
3. Se o aplicativo não tiver um tempo de expiração definido, o padrão será usado. O padrão é 3.600 segundos (uma hora).

Além disso, se você usar autenticação dinâmica, poderá personalizar os pares de chave-valor enviados com cabeçalhos de autorização para o provedor de agente virtual. Por padrão, o nome do cabeçalho de autorização é Autorização. Você também pode alterar o prefixo adicionado ao valor do cabeçalho. O padrão é Portador.

Autenticação com certificados de cliente e mTLS

Integrações de agentes virtuais personalizadas no Hub de Agente Virtual suportam mTLS (Mutual Transport Layer Security). mTLS é um protocolo de camada de transporte que autentica clientes e servidores. Ele fornece segurança adicional à comunicação entre cliente e servidor. Com a autenticação TLS, há validação de um certificado entre dois servidores. O mTLS valida um certificado entre um cliente e o servidor. O cliente pode ser um navegador da Web ou uma chamada de API.

Para usar a autenticação mTLS com sua integração de agente virtual personalizado, seu webhook deve ter o mTLS ativado. Você pode adicionar um certificado de cliente e uma chave ao aplicativo Pontos de Extremidade Personalizados do Exchange no Hub de Agente Virtual. O CXone usa essa informação ao negociar o handshake com o webhook.

Intenções do agente virtual

Seu agente virtual deve ser capaz de identificar o que o contato deseja. Ele faz isso usando as intenções que você o configura para reconhecer. As intenções necessárias dependem dos casos de uso do agente virtual. Depois de conhecer as intenções necessárias, você deve configurar o agente virtual no console de gerenciamento do provedor. A terminologia que alguns provedores usam para o conceito de intenção pode variar.

O CXone requer que seu agente virtual tenha respostas para determinadas intenções. Todas as outras intenções dependem dos planos da sua organização para o agente virtual. No mínimo, você deve definir:

• Uma intenção de saudação/boas-vindas: Essa é a mensagem padrão com a qual o agente virtual começa quando um contato inicia uma conversa.
• Uma intenção de fallback: Isso é o que o agente virtual diz quando nenhuma de suas outras respostas se aplica.
• Uma intenção de limite de tempo/silêncio: Isso é o que o agente virtual diz quando o contato fica em silêncio por muito tempo.
• Uma intenção de término/conclusão: É assim que o agente virtual encerra a conversa.

Casos de uso do agente virtual

Ao planejar seu agente virtual, você precisa considerar os tipos de situações com os quais ele lidará. Crie casos de uso para essas situações, incluindo os fluxos de conversa que ele deve seguir para cada um. Para cada caso de uso, crie um diagrama de sequência que mapeie as solicitações e respostas ao longo da interação.

Por exemplo, um caso de uso pode ser responder a perguntas sobre o status do pedido. O fluxo da conversa pode ser assim:

Agente virtual: "Em que posso ajudar?"

Contato: "Quero verificar o status do meu pedido."

Agente virtual: "Diga ou digite o número do seu pedido de treze dígitos agora."

Contato: "Vamos ver, o número do pedido é 2390294837290."

Agente virtual: "Infelizmente, seu pedido está atrasado três dias."

Contato: "Ah, isso não é bom. Eu realmente preciso dele antes. Há alguém com quem eu possa falar sobre isso?"

Agente virtual: "Sim, vou transferir você para um agente que pode ajudar."

Um diagrama de sequência para este caso de uso pode ser semelhante ao do exemplo a seguir:

Transcrições de conversas

O CXone pode coletar as transcrições e os dados de intenção O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar. das conversas do agente virtual de voz e chat. Você pode usar as informações da maneira que atender melhor às necessidades da sua organização. Por exemplo, você poderia salvá-los em um banco de dados externo. Você também poderia enviá-los para o o aplicativo de agente para interações escaladas para agentes humanos reais. Este recurso deve estar ativado no aplicativo de configuração do seu agente virtual no Hub de Agente Virtual. Por padrão, as transcrições e intenções não são coletadas.

Os dados exatos coletados dependem de como o recurso está configurado. Você pode ter apenas transcrições coletadas, apenas intenções ou tanto transcrições quanto intenções. Se você tiver mais de um agente virtual, poderá configurar cada um separadamente.

O que você faz com os dados coletados é uma decisão sua. Se você quiser salvá-los para manutenção de registros, o script do Studio do agente virtual deverá ser configurado para isso. Por padrão, quando a coleta de transcrição da conversa está ativada, os dados coletados são armazenados até que a interação seja concluída.

Usar esse recurso requer script personalizado no script do Studio do agente virtual. Também deve ser ativado na página Transcrição do aplicativo de configuração do agente virtual no Hub de Agente Virtual.

Terminais de API e esquemas do CXone

Os terminais de API e esquemas que o CXone usa são definidos na documentação do Swagger . Você pode usar essas informações ao mapear as solicitações e respostas entre o CXone e seu provedor de agente virtual como parte da criação do webhook do túnel proxy.

• ExternalIntegrationBotExchangeRequest: Esse é o terminal para solicitações que vão do CXone para o seu agente virtual por meio do túnel proxy.
• CustomExchangeResponse: Esse é o terminal para as respostas vindas do agente virtual para o CXone.

Os esquemas são definidos na página Esquemas. No entanto, sempre verifique a página do Swagger para garantir que você esteja usando a versão mais atualizada dos esquemas.