VoiceBot Exchange

Esta página de ajuda é para Desktop Studio. Estas informações também estão disponíveis para Studio.

Icon of VoiceBot Exchange: robot head above sound waves

Integra um agente virtualClosed Um aplicativo de software que gerencia as interações com clientes no lugar de um agente humano ao vivo. de autoatendimento a scripts de voz. Esta ação é usada em um loop no script. Um script deve conter pelo menos duas VoiceBot Exchange actions. O seu agente virtual deve ser compatível com esta ação.

Voicebot Exchange ação é para agentes virtuais complexos ou quando você precisa personalizar o comportamento DO agente virtual de turno a turno. Monitora a conversa entre o contato e o agente virtual, turno a turno. Ele envia cada enunciadoClosed O que um contato diz ou digita. transcrito para o agente virtual. O agente virtual analisa o enunciado para verificar a intençãoClosed O significado ou a finalidade por trás do que um contato diz/digita; o que o contato deseja comunicar ou realizar. e o contexto e determina a resposta a ser dada. A ação passa a resposta do agente virtual para o contato. Quando a conversa for concluída, a ação continua o script.

Se você quiser configurar interrupção ou nenhuma entrada, é necessário script adicional.

Clicar duas vezes nesta ação abre o Virtual Agent Hub, onde você pode gerenciar todos os seus agentes virtuais.

Dependências

  • Um script deve conter pelo menos duas ações VoiceBot Exchange conectadas em um loop.
  • Para usar esta ação, o seu agente virtual deve suportar personalização de conversas turno a turno.
  • Um turno de conversação é definido como:

    1. O enunciado do contato que está sendo enviado ao agente virtual.
    2. O agente virtual processando o enunciado e definindo qualquer informação de carga útil customizada.
    3. A resposta retornando ao contato.
    4. Quaisquer ações adicionais a serem executadas (como uma chamada de banco de dados ou de API Externa) que são determinadas na propriedade nextPromptBehaviors. Você também pode configurar o loop de conversação para ser encerrado quando a interação for concluída ou se o contato for transferido para um agente ativo.
  • Caso esteja incluindo carga útil personalizada com agentes virtuais Google Dialogflow ES ou Google Dialogflow CX, siga as boas práticas e diretrizes da carga útil personalizada.As diretrizes para CX e ES são fornecidas nesta página.

Tipos de script suportados

O ícone do tipo de script Telefone - um fone de telefone de estilo antigo com linhas curvas indicando som saindo dele.

Telefone

Comparação de ações semelhantes

As ações a seguir têm funções semelhantes, mas com algumas diferenças chave:

  • Textbot Exchange: Esta ação é usada para interações complexas de agente virtual. Ela permite incluir parâmetros de troca e personalizar vários aspectos da conversa entre contato e agente virtual.
  • Voicebot Exchange: Esta ação é usada para interações complexas de agente virtual. Ela permite incluir parâmetros de troca e personalizar vários aspectos da conversa entre contato e agente virtual.
  • VOICEBOT STREAM: Esta ação oferece suporte a streaming de áudio em tempo real entre NiCE CXone e o provedor de agente virtual. Ela não oferece suporte à personalização da conversa entre turnos. Atualmente, o agente virtual aceito é somente Google Dialogflow CX VoiceStream.

Agentes virtuais suportados

Esta ação é compatível com os seguintes agentes virtuais:

Antes de atribuir um bot de agente virtual a essa ação, você deve adicionar e configurar um app para o agente virtual no Virtual Agent Hub. Você precisa de apenas um app para cada agente virtual que usa. Você pode atribuir o mesmo aplicativo a múltiplas ações de agente virtual em seus Scripts. Consulte a página de ajuda do provedor de agente virtual que você está usando para obter detalhes de configuração.

Outros provedores de agente virtual podem ser compatíveis, mas exigem integrações personalizadas. Isso inclui integrações DEVone e endpoints personalizados. As integrações personalizadas não são configuradas usando Virtual Agent Hub.

Propriedades de entrada

Estas propriedades definem dados que a ação usa durante a execução.

Uma ou mais propriedades desta ação exigem uma ação Snippet com código personalizado.

Propriedade

Descrição

Legenda

Insira uma frase curta que identifique exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação. O padrão é o nome da ação.

virtualAgentID O nome do agente virtual selecionado no Virtual Agent Hub. Quando você atribui um aplicativo de agente virtual a uma ação Studio no Virtual Agent Hub, ele preenche automaticamente esta propriedade. O nome é o valor usado no campo Virtual Agent (Bot) Name no aplicativo Virtual Agent Hub. Você pode usar substituição de variável nesta propriedade.
customPayload

Configure essa propriedade somente se você precisar passar dados de carga útil personalizada para o agente virtual. O objeto de carga útil personalizada é preenchido a partir do script Studio. Você pode usá-lo para passar informações como o nome do contato de um CRMClosed sistemas de Terceiros que gerenciam itens como contatos, informações de vendas, detalhes de suporte e históricos de casos. a ser usado em uma mensagem de Bem-vindo.

Digite o nome do objeto JSON que passa dados do script para o agente virtual. Você deve definir o objeto de carga útil personalizada em uma ação Snippet. O objeto deve ser convertido em JSON, seja no snippet ou na propriedade customPayload.

Requisitos para fornecedores de agentes virtuais específicos:

Não use essa propriedade se precisar processar dados que o agente virtual retorna ao script. Em vez disso, use a variável customPayloadVarName (out).

nextPromptSequence

A resposta recebida pelo agente virtual que será reproduzida para o contato. Configure essa propriedade com a variável especificada em nextPromptSequenceVarName (out) com a função asJSON(). Você também pode converter o conteúdo de nextPromptSequenceVarName (out) para JSON em uma ação Snippet e configurar essa propriedade com a variável que contém o JSON.

nextPromptBehaviors

Especifica a configuração e o comportamento do próximo prompt em uma conversa. Defina os comportamentos que você deseja ver usando uma Snippet ação e seguindo o exemplo de snippet Default Next Prompt Behaviors ou Next Prompt Behaviors. Este exemplo descreve propriedades que você pode usar para configurar ruído de conforto, coleta de DTMF e permitir que o contato fale durante a reprodução do áudio (interrupção).

Configure a propriedade nextPromptBehavior com o nome do objeto usado no código do Snippet. Isto passa as configurações para esta propriedade e sua ação. Por exemplo, usando o exemplo do snippet Next Prompt Comportamento, você deveria inserir {nextPromptBehaviorsOutjson} para esta propriedade. Você só precisa configurar essa propriedade se estiver usando essa ação para habilitar um agente virtual de texto a lidar com interações de voz.

botSessionState

Configure com a variável que contém o exclusivo identificador da conversa entre o contato e o agente virtual. É atribuído automaticamente pelo provedor do agente virtual. O identificador evita que uma nova sessão seja criada a cada turno da conversa e ajuda o agente virtual a manter o contexto entre os turnos.

O provedor cria o identificador quando a conversa começa e o passa para o script com a primeira resposta. O script armazena o identificador na variável nomeada na propriedade botSessionStateVarName (out) desta ação. Por fim, o script passa o identificador do turno anterior da propriedade botSessionStateVarName (out) para a propriedade botSessionState.

Seus Scripts nunca devem gravar nesta propriedade ou em sua variável. Seu script deve ser configurado corretamente para usar o identificador de estado da sessão do bot.

automatedIntent

Insira uma intenção específica pelo nome para o agente virtual responder, em vez de fazer com que o agente virtual interprete a entrada do usuário coletada. Um caso de uso comum para isso é obter a mensagem de boas-vindas inicial do agente virtual.. Bem-vindo é a string padrão para saudações iniciais

Propriedades de saída

As propriedades contêm variáveis que armazenam dados retornados pela execução da ação. Elas estão disponíveis para referência e uso quando a ação é concluída.

Propriedade

Descrição

nextPromptBehaviorsVarName (out)

Define os comportamentos para avisar o usuário no próximo turno de conversação.

nextPromptSequenceVarName (saída)

Segura a resposta do agente virtual e a passa para a propriedade nextPromptSequence.

customPayloadVarName (out)

Retorna dados JSON personalizados do agente virtual para o script. Use essa variável quando quiser que o script processe os dados fornecidos pelo agente virtual. Pode conter dados de atendimento.

Se você quiser fornecer dados para o agente virtual, use a propriedade customPayload.

errorDetailsVarName (out)

Solicita a sequência de intenção de erro; pode levar a uma transferência para um agente vivo.

intentInfoVarName (out)

Uma variável que contém detalhes do agente virtual, indicando a intenção atual do usuário.

botSessionStateVarName (out)

Contém a variável onde o script armazena o identificador de estado da sessão de bot enviiado pelo fornecedor do agente virtual. O conteúdo da variável é passado para a propriedade botSessionState.

Esta propriedade deve ser configurada corretamente para que seu agente virtual funcione adequadamente. mais informações sobre como configurá-lo está disponível na página de ajuda do Bot Session State Snippet.

Condições de Branch de resultado

As condições de ramificação de resultado permitem que você crie ramificações no seu script para tratar diferentes resultados quando uma ação é executada.

Condição

Descrição

Padrão Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnPromptAndCollectNextResponse

Caminho tomado se o agente virtual tiver determinado que a interação deve continuar e está pronta para mais entrada humana do contato. Solicita a próxima curva na conversa.

OnError Path taken when there is an unexpected problem (for example, poor connectivity, syntax errors, and so forth). The _ERR variable should be populated with a condensed explanation of the problem.
OnReturnControlToScript Caminho seguido se o agente virtual indicou que a conversa foi finalizada e devolve o controle ao script Studio para transferir ou encerrar a chamada. Pode haver dados de cumprimento a serem processados no resultado customPayload.
OnDTMFBreakout

Caminho tomado quando uma regra DTMFClosed Tons de sinalização gerados quando um contato pressiona uma tecla do teclado do telefone. no script foi cumprida.

OnUserInputTimeout

Caminho percorrido quando não há resposta do usuário no tempo especificado no snippet de Comportamento do Prompt Default ou Next.

Para Google Dialogflow, você pode configurar o evento que deseja que ocorra no app Virtual Agent Hub Dialogflow. Para ES Dialogflow , configure o campo Evento de tempo limite. Para Dialogflow CX, configure o Manipulador de eventos de tempo limite. Caso nenhum Evento esteja configurado, o padrão é usar a intenção padrão de fallback conforme configurada no console do Dialogflow.

Se desejar, você pode configurar esta ramificação para usar eventos diferentes em diferentes pontos do seu script.

OnUserInputNotUnderstood

Caminho tomado quando o agente virtual não entende a resposta do contato ou quando o contato expira.

Código de Ação de SNIPPET necessário

Uma ou mais propriedades desta ação exigem uma ação Snippet action com o seguinte código personalizado:

Práticas recomendadas para Carga útil personalizada com Google Dialogflow CX

Quando utilizar esta ação com Google Dialogflow CX, siga as práticas recomendadas para integrar cargas úteis personalizadas:

  • O Dialogflow CX não usa contextos para passar dados paraDialogflow intençõesClosed O significado ou a finalidade por trás do que um contato diz/digita; o que o contato deseja comunicar ou realizar. do Dialogflow como o Dialogflow ES faz.
  • Você pode passar dados personalizados para Dialogflow CX usando pares de chave-valor JSON. Em uma Snippet ação no seu script, crie um objeto dinâmico customPayload e adicione os pares de chave-valor a ele. Por exemplo:

    DYNAMIC customPayload
    customPayload.ani = ani
    customPayload.contactID = contactId
    customPayload.masterContactId = masterId
    customPayloadJSON = "{customPayload.asJSON()}"	
  • Na ação Exchange em seu script, configure a propriedade customPayload com uma variável que tenha a função asJSON() em seu valor. Você pode encontrar essa variável no objeto customPayload.
  • Na ação VoiceBOT STREAM ação do seu script, configure a propriedade customPayload com uma variável que tenha a função asJSON() em seu valor. Você pode encontrar essa variável no objeto customPayload.
  • Transmita a customPayload JSON para o agente virtual usando a propriedade Payload de QueryParameters. Consulte a documentação de Google sobre QueryParameters A square with an arrow pointing from the center out from the top right corner. para Google Dialogflow CX.
  • Dados transmitidos por meio de QueryParameters são recebidos por um webhook em Dialogflow CX.Você pode escrever código no console CX Dialogflowpara manipular os dados passados.
  • Não aninhe um objeto dentro do objeto customPayload. Os objetos são enviados como strings literais.
  • Para transmitir dados personalizados do seu agente virtual Dialogflow CX de volta ao script, use o campo Carga útil personalizada no console Dialogflow CX.Verifique se você está no console do agente virtual que está usando NiCE CXone. Mapeie isso para o seu script usando a variável customPayloadVarName (out) na ação Studio VOICEBOT EXCHANGE ou TEXTBOT EXCHANGE Studiono seu script. Por exemplo, você pode usar isso para definir os comportamentos do próximo prompt.
  • Para passar dados personalizados do seu agente virtual Dialogflow CX de volta para o script, use o campo Carga útil personalizada no console Dialogflow CX.Verifique se você está no console do agente virtual que está usando NiCE CXone. Mapeie isso para seu script usando a variável customPayloadVarName (out) na ação VOICEBOT STREAM em seu script.
  • Para passar dados personalizados para o Dialogflow CX a partir do script, use session_params no objeto customPayload em uma ação Snippet. Por exemplo:

    DYNAMIC customPayload
    customPayload.session_params.name = "Winnie le Pooh" 
    customPayload.session_params.job = "Food critic" 
    customPayload.session_params.location = "Hundred Acre Wood"	

    Acesse os parâmetros de sessão no intent do agente CX Dialogflow usando a seguinte sintaxe:

    $session.params.name = Winnie Le Pooh
    $session.params.job = Food critic
    $session.params.location = 100 Acre Wood 

    Os parâmetros de sessão são usados apenas com agentes virtuais Dialogflow CX. Para obter um resultado semelhante com Dialogflow ES, use contextos.

  • Configurar dicas de contexto de fala e um ID de conversa personalizado para transferir a conversa para um agente virtual Dialogflow CX diferente no snippet Carga útil personalizada .

  • Para configurar por quanto tempo o agente virtual aguarda quando o contato faz uma pausa ao falar, adicione o maxPostEnergySilenceMS parâmetro à Next Prompt Behaviorsou Default Next Prompt Behaviors Snippet ação.

Práticas recomendadas para Carga útil personalizada com Google Dialogflow ES

Quando utilizar esta ação com Google Dialogflow ES, siga as práticas recomendadas para integrar cargas úteis personalizadas:

  • CustomPayload é usado para passar contexto para uma intençãoClosed O significado ou a finalidade por trás do que um contato diz/digita; o que o contato deseja comunicar ou realizar.. O Contexto ajuda o agente virtual a entender a intenção do usuário. Os Contextos não são obrigatórios, mas ajudam o agente virtual corresponder um enunciadoClosed O que um contato diz ou digita. a uma intenção.
  • Em uma ação de Snippet no seu script, crie um objeto customPayload que segue o formato descrito na documentação do Google Dialogflow ES Ícone indicando que o link leva a um site externo para REST Resource: projects.agent.sessions.context. A ajuda online do Studio fornece informações adicionais sobre objetos de dados dinâmicos.
  • Você também pode passar dados personalizados com customPayload sem contextos. Para fazer isso, inclua pares de chave-valor JSON padrão em um objeto de dados dinâmicos.
  • Os contextos de fala são passados na carga útil personalizada no parâmetro speech_contact. Você pode ver o conteúdo desse parâmetro em rastreamentos de Studio e logs de aplicativo.
  • O objeto dinâmico customPayload é passado como um parâmetro de agente virtual como JSON, conforme mostrado no script de exemplo.
  • Configure as dicas de contexto de fala no snippet Carga útil personalizada .

Dicas e truques

Se o áudio de voz não puder ser ouvido entre o Virtual Agent Hub e o agente virtual, verifique o trace de script para ver se há uma transcrição. Caso haja uma, o agente virtual do Google Dialogflow precisa ser ajustado.

Exemplo de script

Este é um exemplo para mostrar como essa ação pode ser usada em Scripts. Ele não é voltado para um script inteiro. Pode ser necessário um script adicional.

As ações VoiceBot Exchange devem ser usadas em um loop. Isso significa que você deve usar pelo menos duas em um script. A primeira ação inicia a chamada para a API do agente virtual e deve ser precedida pela ação Snippet Default Next Prompt Behavior. A primeira ação é a Welcome Default, que inicia o primeiro loop roteirizado, ou um 'turno' de conversação.

Um exemplo de script que usa a ação VoicebotExchange.

Baixar este script.

Exemplo de script para CustomPayload com Google Dialogflow ES

Este é um exemplo para mostrar como essa ação pode ser usada em Scripts. Ele não é voltado para um script inteiro. Pode ser necessário um script adicional.

Este script é um exemplo de como integrar cargas úteis personalizadas com agentes virtuais do Google Dialogflow ES. Este script usa a ação Voicebot Exchange, mas também funcionará se você usar TEXTBOT EXCHaNGE em vez disso.

Um exemplo de script mostrando como lidar com a carga útil personalizada com Google Dialogflow CX.

Baixar este script.

Exemplo de script para Eventos DE limite DE tempo alternativos

Este é um exemplo para mostrar como essa ação pode ser usada em Scripts. Ele não é voltado para um script inteiro. Pode ser necessário um script adicional.

Você pode usar eventos DE limite DE tempo diferentes em pontos diferentes do seu script. Por exemplo, você pode querer usar eventos de tempo limite diferentes na primeira e na segunda vez que a propriedade UserInputTimeout for acionada. Este script de exemplo mostra uma maneira possível de fazer isso acontecer.

Neste script, as ações de Snippet são usadas para criar e incrementar um contador de limite de tempo. Após o segundo limite de tempo, uma ação de Snippet é usada para definir um evento DE limite DE tempo diferente. O evento DE limite DE tempo alternativo é passado da ação Snippet para a ação de voicebot por meio da propriedade AutomatedIntent .

Example script handling a voicebot action on user input timeout

Baixar este script.