Integrar Google Dialogflow ES

Antes de concluir as tarefas desta página, certifique-se de que os pré-requisitos da integração tenham sido atendidos.

Criar um Script

Permissões necessárias: Visualizar, criar/editar scripts do Studio

É necessário pelo menos um script do Studio para direcionar as interações para o seu agente virtual. Siga as diretrizes e os requisitos de script. O script deve conter o tipo de mídia Uma mídia, como voz, e-mail e chat, por meio da qual um contato se conecta a um destinatário pretendido. telefônica para um agente virtual de voz ou o tipo de mídia digital para um agente virtual de texto. As ações de agente virtual suportadas para este provedor são:

• VoiceBot Exchange
• TextBot Exchange

Você pode saber mais sobre scripts do Studio nas seções Fundamentos e Guia de referência técnica da ajuda online.

Quando o seu agente virtual estiver pronto para ser colocado em produção, atribua o script a um ou mais pontos de contato.

Práticas recomendadas de carga útil personalizada

Siga estas práticas recomendadas ao integrar dados de carga útil personalizados Google Dialogflow ES em CXone :

• CustomPayload é usado para passar contexto para uma 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.. 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 enunciado O que um contato diz ou digita. a uma intenção.
• Em uma ação Snippet em seu script, crie um objeto customPayload que segue o formato descrito na documentação do Google Dialogflow ES para o recurso REST: 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 rastreios do Studio e logs do aplicativo.
• O objeto dinâmico customPayload é passado como um parâmetro de agente virtual como JSON, conforme mostrado no script de exemplo.

• Dicas de contexto de fala pode ser passadas com carga útil personalizada no parâmetro speechContexts. O valor de speechContexts.phrases deve ser um token da classe Google para a dica que você quer dar. O token deve corresponder ao idioma e à localidade dos seus contatos. Por exemplo:

  DYNAMIC customPayload
  customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
  customPayload.speechContexts.boost=10		

Adicionar um aplicativo a Virtual Agent Hub

Permissões necessárias: Automação e IA > Iniciar Automação e IA

Adicionar um aplicativo de configuração ao Virtual Agent Hub estabelece a conexão entre o CXone e o seu provedor de agente virtual.

1. No CXone, clique no seletor de aplicativos e selecioneOutra > Automação e IA e clique em Virtual Agent Hub. Você também pode clicar duas vezes na ação do agente virtual no seu script do Studio para iniciar o Virtual Agent Hub.
2. Clique Adicionar bot.

3. Digite um Nome de agente virtual (bot) e clique em Google Dialogflow ES na lista de provedores de agentes virtuais.

4. Clique em Avançar.

5. Preencha os campos no formulário de configuração e clique em Avançar. Você pode encontrar detalhes sobre esse formulário na seção Detalhes da página de configurações nesta página.

6. Clique em Avançar.

7. Se estiver configurando um agente virtual de texto, selecione Somente texto (sem suporte para voz) na página Voz. Se estiver configurando um agente virtual de voz, consulte a seção Configurar opções de integração de voz nesta página.

8. Clique em Avançar.

9. Na página Transcrição, selecione se você quer a transcrição da conversa e as informações de intenção capturadas.

   Saiba mais sobre os campos nesta etapa

   Opção	Detalhes
   Não capturar ou arquivar transcrição ou informações de intenção	Selecione esta opção se não quiser capturar transcrições de conversas ou informações 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..
   Capturar e arquivar somente informações de intenção	Selecione esta opção se quiser capturar somente informações de intenção. Os dados capturados são armazenados apenas durante a interação por padrão. Esta opção exige script personalizado.
   Capturar ou arquivar transcrição e informações de intenção	Selecione esta opção se quiser capturar transcrições e dados de intenção. Os dados capturados são armazenados apenas durante a interação por padrão. Esta opção exige script personalizado.

10. Clique em Avançar.

11. Na página Test + Add, você pode testar a conexão do seu bot enviando prompts de voz ou texto. Se suas mensagens de teste não funcionarem, clique em Voltar para retornar à página Configuração e verificar as configurações. Você também pode precisar verificar as configurações no console de gerenciamento do seu provedor de agente virtual.

12. Clique em Adicionar.

Detalhes da página de configurações do Google Dialogflow ES

Use as informações na tabela a seguir ao preencher a página de configurações. Você verá essa página quando adicionar um aplicativo no Virtual Agent Hub

campo	Detalhes
Versão de integração	Selecione a versão do Virtual Agent Hub que quer usar. Esta opção permite que você use uma versão anterior do Virtual Agent Hub até que esteja pronto para mudar para uma versão recém-lançada. As versões disponíveis são: Versão 1.0.0: esta é a primeira versão do Virtual Agent Hub. O objeto de carga útil personalizada retorna como customPayload.payload.xxxx. Versão 2.0.0: Esta versão atualizou os esquemas usados com o Google Dialogflow ES. Isto impacta a estrutura do objeto customPayload. Versão 3.0.0: Esta versão introduziu o StandardBot, que padroniza como o CXone se comunica com provedores de agentes virtuais. O objeto customPayload retorna como uma matriz, como customPayloadscriptPayloads[n].xxxx. Esta versão está disponível para todos os provedores.
ID do projeto GCP do cliente	O ID do projeto do Google Cloud da sua organização. Este é o identificador do seu agente virtual. Você pode encontrá-lo no Google Dialogflow ES configurações do console. Este campo só fica visível se você estiver usando uma conta de serviço OEM.
Conta de serviço JSON	O arquivo de chave da conta de serviço que você criou e fez download do Console do Google Cloud. Copie e cole todo o conteúdo do arquivo de chave neste campo. Este campo é visível apenas se você estiver usando seu próprio Google Dialogflow ES conta. A chave da conta de serviço é um objeto JSON semelhante ao exemplo a seguir. { "type": "service_account", "project_id": "ic-demo2-aai-gcp", "private_key_id": "sdv80sdf08ssd9sdf0sdf8sdfsdf90sdf8", "private_key": "-----BEGIN PRIVATE KEY----- nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCzgrS8vp <private key has been truncated for this example> ----END PRIVATE KEY-----\n", "client_email": "your@client_email-gcp.iam.gserviceaccount.com", "client_id": "123456789", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/dialogflow-dthjop%40ic-demo2-aai-gcp.iam.gserviceaccount.com" }
Idioma	O idioma que você deseja que este agente virtual use. Esta é a linguagem que o agente virtual entende. Este é um campo obrigatório.
Região	A região onde seu Google Dialogflow ES agente virtual está localizado.
Meio Ambiente	O nome do ambiente personalizado no qual seu agente virtual é publicado. Se você deixar este campo em branco, o ambiente de rascunho será usado.
Executar TTS de Saída	Ative esta opção se você quiser usar o serviço de conversão de texto em fala do Google Dialogflow ES (TTS Permite que os usuários insiram prompts gravados como texto e usem uma voz gerada por computador para falar o conteúdo.). Defina as configurações de saída de TTS. Se você não usa o serviço TTS do Google, pode usar CXoneCloud TTS Hub. Você configura esta opção na página Voz do assistente do aplicativo de configuração.
Evento de Timeout	Nome do evento Google Dialogflow ES que você deseja acionar no tempo limite.
Padrão de quebra de DTMF	Digite os caracteres que, quando pressionados durante uma chamada, fazem com que o agente virtual pule para DTMFBreakout ramal do script do Studio. Preencha este campo apenas se for um agente virtual de voz.
Use o serializador JSON do Google Protobuf	Ativa esta opção para usar o Serializador Google Protobuf. As respostas serializadas melhoram o desempenho reduzindo o tamanho das respostas e a memória necessária para processá-las. A redução de tamanho torna menos provável que as respostas excedam 32 KB, que é o limite geral de tamanho para variáveis de script. NICE CXone recomenda que você habilite essa opção. Se você precisar desativá-lo por qualquer motivo, ele deverá ser reativado assim que o problema for resolvido. Se você configurar sua integração do Google Dialogflow ES anterior à versão da primavera de 2022 do CXone, é importante que você verifique seus scripts para análise de carga útil. Em qualquer lugar que você encontrar isso, você precisa substituí-lo pela análise do novo esquema antes de habilitar essa opção em sua integração. Por exemplo, se seu script atualmente faz referência a algo assim:  {parameters.fields.myfield.stringValue} você mudaria para: {parameters.myfield}
Limite de tempo do provedor externo	Digite o número de segundos que você quer que o script espere por uma resposta do Dialogflow ES . Quando o limite de tempo for atingido, o controle retornará ao script, assumindo a ramificação do erro.

Configurar saída TTS do Google Dialogflow ES

Permissões necessárias: Automação e IA > Iniciar Automação e IA

Conclua as etapas desta seção se quiser usar o serviço Google TTS. Os campos na imagem a seguir aparecem quando você ativa a opção Executar TTS de Saída na página Configuração do Dialogflow ES no Virtual Agent Hub.

1. No Virtual Agent Hub, adicione um novo aplicativo de configuração e configure-o de acordo com as etapas descritas na seção Adicionar um aplicativo ao Virtual Agent Hub nesta página.
2. Ative Executar TTS de Saída.

3. Para usar um modelo de voz personalizado, ative Usar voz personalizada e insira o nome do modelo AutoML que você quer usar no campo Modelo de voz personalizado.

   Ver imagem

   

   Saiba mais sobre os campos nesta etapa

   campo	Detalhes
   Usar voz personalizada	Permite usar um modelo AutoML (aprendizado de máquina automatizado) para sintetizar uma voz personalizada para seu bot. Dialogflow usa esta voz em vez de uma voz TTS. Se você usar essa opção, insira o nome do modelo do AutoML que deseja usar no campo Modelo de voz personalizado exibido. Este campo só fica visível quando Executar saída TTS está ativado.

4. Se você quiser usar um modelo de voz do Google, selecione o nome da voz TTS na lista suspensa.

5. Selecione o modelo de machine learning e a variante do modelo que você quer que os serviços Google TTS usem ao sintetizar a fala.

   Saiba mais sobre os campos nesta etapa

   campo	Detalhes
   Modelo	Selecione o modelo de machine learning que você deseja que o serviço de transcrição use ao transcrever o áudio. Esses modelos foram treinados para reconhecer a fala de tipos e fontes de áudio específicos. Configure este campo somente para agentes virtuais de voz. Nem todos os idiomas suportam todos os modelos. Consulte a documentação do Google para obter informações sobre o suporte a idiomas. Chamada telefônica é a opção recomendada para a maioria dos agentes virtuais de voz. As opções são: Comando e pesquisa: Use na transcrição de clipes de áudio mais curtos, como comandos e pesquisa de voz. Considere usar Último Curto em vez disso. Padrão: Use quando o áudio não se encaixa nos outros modelos. Ele pode transcrever qualquer tipo de áudio, mas os resultados podem ser de qualidade inferior para alguns tipos. Último longo: Use com conteúdo de formato longo, como fala espontânea ou conversas. Último curto: Use quando os enunciados têm alguns segundos de duração, como comandos. Considere usar este modelo em vez de Comando e pesquisa. Conversação médica: Use ao transcrever uma conversa entre um profissional médico e um paciente. Ditado médico: Use ao transcrever notas ditadas por um profissional médico. Chamada telefônica: Use para transcrever o áudio de uma chamada telefônica. Vídeo: Use ao transcrever áudio com vários alto-falantes, como de videoclipes ou podcasts. Se Vídeo não estiver disponível no idioma que você precisa, use Último longo.
   Variante de modelo	Selecione a variante do Modelo que você quer que o agente virtual use. Alguns modelos têm uma variante aprimorada que fornece resultados de maior qualidade. Consulte a documentação do Dialogflow para obter mais informações sobre os modelos que suportam uma variante aprimorada. Os modelos aprimorados são cobrados a uma taxa mais alta do que os modelos padrão. Para modelos de Phone Call, a variante recomendada é Enhanced. As opções disponíveis para este campo são: Best Available:  Selecione se quiser que o Dialogflow use o modelo aprimorado, caso esteja disponível. Se não estiver, o modelo padrão será usado. Enhanced: Selecione para usar o modelo aprimorado. Se um modelo aprimorado não estiver disponível para o Modelo selecionado, o Dialogflow usará o modelo padrão. Standard: Selecione para usar o modelo padrão mesmo se um modelo aprimorado estiver disponível. Unspecified: Selecione se não tiver certeza de qual variante usar. O Dialogflow padroniza para a melhor variante disponível do modelo selecionado.

6. Para adicionar silêncio ao início da resposta de áudio do agente virtual, insira o número de milissegundos de silêncio a serem adicionados no campo Adicionar silêncio inicial. O tempo de silêncio recomendado é de 500 milissegundos.

7. Insira a taxa de fala, o tom e o ganho de volume para configurar como você quer que a voz do TTS soe.

   Saiba mais sobre os campos nesta etapa

   campo	Detalhes
   Taxa de fala	Clique em + ou – para alterar a velocidade com que a voz TTS fala. A taxa pode estar entre 0,25 e 4,0. Uma taxa de fala normal é 1,0. Uma taxa de 2,0 é duas vezes mais rápida que o normal e 0,5 é metade da velocidade normal. O padrão é 0. Este campo só fica visível quando Executar saída TTS está ativado.
   Tom	Clique em + ou – para alterar o tom da voz do TTS. O tom é a voz alta ou baixa. O padrão é 0. O máximo é 20,0 e significa que a voz está 20 semitons acima do padrão. O mínimo é -20,0 e significa que a voz está 20 semitons abaixo do padrão. Este campo só fica visível quando Executar saída TTS está ativo.
   Ganho de volume	Clique em + ou – para alterar o volume da voz do TTS medida em decibéis (dB). O padrão é 0. O intervalo é de 16,0 a -96,0 . Um ganho de +6,0 é reproduzido com aproximadamente o dobro do volume do padrão. Não exceda +10 dB. Este campo só fica visível quando Executar saída TTS está ativo.

8. Volte para a seção Adicionar um aplicativo ao Virtual Agent Hub nesta página para terminar de adicionar o aplicativo de configuração.

Configurar opções de integração de voz

Permissões necessárias: Automação e IA > Iniciar Automação e IA

Se estiver configurando um agente virtual de texto, você pode pular esta seção.

1. No Virtual Agent Hub, adicione um novo aplicativo de configuração e configure-o de acordo com as etapas descritas na seção Adicionar um aplicativo ao Virtual Agent Hub nesta página.

2. Clique em Avançar na página Configuração.

3. Na página Voz, em Opções de integração de voz, selecione Controle turno a turno (CXoneVoice Bot Gateway).

4. Se o formulário não permitir que você selecione Usar CXone Cloud TTS, clique em Voltar para voltar à página Configuração. Clique no controle deslizante Executar TTS de Saída para Desativado. Agora você pode agora ativar Cloud TTS Hub na página Voz.

5. Selecione um Fornecedor TTS, se estiver usando o Cloud TTS Hub. Se você estiver usando o serviço TTS do seu provedor de agente virtual, esse campo não ficará visível e você poderá pular esta etapa.

6. Em Opções de transcrição, selecione a opção do serviço de transcrição que deseja usar.

   Saiba mais sobre os campos nesta etapa

   campo

   Detalhes

   Opções de Transcrição

   Selecione o serviço que você deseja usar para a transcrição: Usar transcrição de conta de bot: Selecione isso se quiser usar o serviço de transcrição do seu provedor de agente virtual. O áudio dos enunciados do contato é enviado ao provedor antes de ser transcrito. Usar perfil de transcrição do CXone: Selecione isso se quiser usar um perfil de transcrição do CXone. Você pode saber mais sobre essa opção na página de ajuda do CXone Turn-by-Turn Transcription.

7. Se você optar por usar um perfil de transcrição do CXone, clique em Perfil de transcrição para selecionar aquele que você quer usar. Clique em Adicionar novo perfil de transcrição turno a turno para criar um novo perfil.
8. Clique em Avançar.
9. Volte para a seção Adicionar um aplicativo ao Virtual Agent Hub nesta página para terminar de adicionar o aplicativo de configuração.

Atribuir o aplicativo Google Dialogflow ES a uma ação

Permissões necessárias: Visualizar, criar/editar scripts do Studio

Quando o aplicativo de agente virtual O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar. está definido e configurado no Virtual Agent Hub, você precisa atribuí-lo às ações de agente virtual em seu script. Isso conecta a ação e o script ao seu provedor de agente virtual.

1. Dentro Studio, abra o script que deseja modificar.

2. Caso ainda não tenha feito isso, clique na guia Ferramentas, expanda a categoria Automação e IA e adicione a ação do agente virtual que deseja usar. Certifique-se de colocá-la no local correto em seu script. Se não vir a ação esperada, verifique se o seu tipo de mídia do script está correto. Por exemplo, se estiver criando um script para um agente virtual de voz, o script deverá ser um script de telefone.

3. Clique duas vezes na ação para abrir o Virtual Agent Hub.

   Ver imagem

   
4. Na coluna da esquerda, localize o agente virtual que você quer atribuir à ação e clique na opção de seleção ao lado dele.
5. Clique em Fechar.

Alterar o perfil de transcrição

Permissões necessárias: Automação e IA > Iniciar Automação e IA

Um perfil de transcrição permite que você use um serviço de transcrição diferente daquele oferecido pelo provedor do agente virtual. Cada agente virtual pode ter um perfil de transcrição. Você só precisa seguir as etapas desta seção se estiver trabalhando com um agente virtual de voz e precisar alterar o perfil de transcrição.

1. No CXone, clique no seletor de aplicativos e selecioneOutra > Automação e IA e clique em Virtual Agent Hub. Você também pode clicar duas vezes na ação do agente virtual no seu script do Studio para iniciar o Virtual Agent Hub.
2. Na lista de aplicativos de configuração de agente virtual no painel esquerdo da página Virtual Agent Hub, clique naquele que você quer modificar.
3. No centro da página de propriedades do aplicativo de agente virtual, clique na guia Voz.

4. Em Opções de transcrição, selecione Usar CXone perfil de transcrição se já não estiver selecionado.

5. Selecione o Perfil de transcrição turno a turno que você quer que esta integração de agente virtual use. Se a opção que você deseja usar não estiver lá, você poderá adicioná-la.

6. Clique em Salvar.
7. Teste seu serviço de transcrição usando a opção de microfone na seção Teste da página de propriedades do aplicativo de agente virtual.

Teste seu agente virtual

Permissões necessárias: Automação e IA > Iniciar Automação e IA

Você pode testar vários aspectos do seu agente virtual para garantir que tudo funcione conforme o esperado. Você pode executar testes na página de propriedades do aplicativo do agente virtual no Virtual Agent Hub. Durante os testes, você pode:

• Verificar se o aplicativo do agente virtual está configurado corretamente para se comunicar com o provedor do agente virtual.
• Adicionar carga útil personalizada JSON para testar como o agente virtual lida com dados de carga útil personalizada.
• Adicionar um evento de intenção de boas-vindas para testar como o agente virtual inicia uma conversa.
• Acionar um evento de intenção personalizada para testar quaisquer eventos personalizados que você criou para seu agente virtual.
• Acionar um evento de tempo limite para testar como o agente virtual responde quando o contato expira.
• Testar como o agente virtual lida com a entrada DTMF Tons de sinalização gerados quando um usuário pressiona ou toca em uma tecla do teclado do telefone..

A imagem a seguir é um exemplo da página de propriedades de um aplicativo de agente virtual no Virtual Agent Hub. Ela mostra as guias Configuração e Voz e o painel Teste.

1. No CXone, clique no seletor de aplicativos e selecioneOutra > Automação e IA e clique em Virtual Agent Hub. Você também pode clicar duas vezes na ação do agente virtual no seu script do Studio para iniciar o Virtual Agent Hub.
2. Clique para selecionar o aplicativo de configuração para o agente virtual que deseja testar na lista à esquerda.

3. No painel Teste, insira uma mensagem de teste no campo Digite uma mensagem e pressione Enter para enviá-la. Você também pode clicar em Microfone e falar no microfone do seu computador.

4. Clique em Iniciar com intenção de boas-vindas para iniciar uma conversa de teste desde o início. O agente virtual responde com sua mensagem de boas-vindas padrão. Você pode inserir mensagens de teste.

5. Clique em Mais opções para testar outros aspectos do seu agente virtual.

   Saiba mais sobre os campos nesta etapa

   campo	Detalhes
   Adicionar JSON de carga útil personalizada.	Selecione para testar o envio de JSON de carga útil personalizada para seu agente virtual. Insira a carga útil personalizada na caixa de texto Adicionar carga útil personalizada JSON que aparece na página Testar + Adicionar. Pressione Enter após cada linha. Envie uma mensagem de teste quando estiver pronto para testar a carga útil personalizada. Quando terminar de testar a carga útil personalizada, clique em Fechar no painel Adicionar carga útil personalizada JSON.
   Acionar Evento de Intenção de Boas-vindas	Selecione testar a 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. de boas-vindas padrão. O agente virtual envia a mensagem de boas-vindas. Digite uma mensagem para responder.
   Acionar evento personalizado de intenção.	Selecione para testar um evento personalizado de intenção. Digite o Nome do evento no pop-up que aparece e clique em Acionar. O agente virtual envia a mensagem para a intenção que você inseriu. Envie uma resposta para testar a intenção.
   Acionar Evento de Tempo esgotado	Selecione para visualizar a intenção de tempo limite padrão. O agente virtual envia a mensagem de resposta de tempo limite com a qual está configurado.
   Entrada DTMF	Selecione para testar a resposta do seu agente virtual de voz para tons DTMF Tons de sinalização gerados quando um usuário pressiona ou toca em uma tecla do teclado do telefone.. Digite caracteres DTMF e clique em Entrada para ver a resposta do agente virtual para esses caracteres.

6. Clique em Redefinir para reiniciar o seu teste.

7. Se precisar fazer alterações com base nos resultados de seus testes, você pode:

   • Modificar os scripts do Studio para o agente virtual.
   • Modificar as configurações no aplicativo do agente virtual no Virtual Agent Hub.
   • Modificar as configurações do agente virtual no console do provedor. Clique no botão quadrado grande na página de propriedades do aplicativo no Virtual Agent Hub. O exemplo no início desta seção mostra o aplicativo Google Dialogflow CX com o botão do provedor. Ele tem o ícone para indicar que o link abre um site externo.
8. Teste o agente virtual após cada alteração nos scripts ou em qualquer configuração.
9. Quando terminar de testar, clique em Fechar.