Integração do Dialogflow com o Google Chat

Ao integrar o Dialogflow ao Google Chat, você aproveita os recursos dos dois serviços:

• Google Chat. Oferece uma plataforma de mensagens com uma interface do usuário de front-end para conversas individuais e espaços de chat. Com o Google Chat, você pode melhorar as interfaces do usuário criando cards que incorporam ícones, imagens, botões, campos de entrada de texto ou apps como o Google Maps.
• Dialogflow. Oferece uma plataforma de compreensão de linguagem natural para conversas automatizadas e respostas dinâmicas. Com o Dialogflow, é possível interpretar e atender às intenções do usuário, por exemplo, para agendar horários ou processar compras.

Embora você também possa usar o Google Chat para atender às solicitações dos usuários, o Dialogflow permite que eles expressem as solicitações em uma conversa normal.

Como funciona

Depois de criar um app do Google Chat com o Dialogflow, você pode disponibilizar o app para:

• Público em geral. Os usuários licenciados do Google Workspace podem fazer o download do seu app pelo Google Workspace Marketplace.
• Domínio do Google Workspace. Um administrador do Google Workspace pode especificar quais apps os usuários podem adicionar ao Google Chat.
• Testadores de apps. Ao testar o app, você pode restringir o acesso a ele.

No Google Chat, um usuário pode ter uma conversa direta com seu app ou invocar o app em um espaço. O seguinte acontece:

1. Um usuário envia uma mensagem para um app de chat.
2. O Google Chat envia uma solicitação JSON para o app Chat, que pode ser hospedado no Cloud Functions.
3. O app de chat recebe a solicitação JSON e a analisa. Durante essa análise, o app do Chat invoca o Dialogflow.
4. O app de chat envia uma solicitação para o Dialogflow que inclui o texto da mensagem em linguagem natural do usuário.
5. O Dialogflow interpreta o texto do usuário e envia uma resposta para o app de chat.
6. O app de chat analisa a resposta do Dialogflow e envia uma resposta JSON para o Google Chat.
7. O Google Chat recebe a resposta JSON do app Chat e renderiza uma resposta na forma de uma mensagem de texto, de card ou de caixa de diálogo na UI.
8. O Google Chat compartilha essa resposta como está ou apresenta uma resposta rica usando uma UI baseada em cards.

Esta página descreve como integrar o Dialogflow ao Google Chat e configurar respostas de chat avançadas.

Observação: o Google Chat era chamado de Hangouts Chat, e os apps do Chat eram chamados de bots do Chat. Embora o Google Chat e o console do Google Cloud usem o termo apps, o console do Dialogflow ainda usa o termo bots.

Limitações

Com as integrações do Google Chat, um agente do Dialogflow só pode usar o idioma padrão do agente.

Antes de começar

Somente usuários licenciados do Google Workspace podem usar os apps do Google Chat. O administrador do Google Workspace precisa fazer o seguinte:

• Adicione uma conta do Google Workspace para você.
• Permitir que os usuários instalem apps do Chat

Criar um agente do Dialogflow

Se você ainda não criou um agente do Dialogflow, mas quer saber como ele interage com o Google Chat, siga este guia de início rápido para criar um agente simples. No entanto, não exclua o agente. Em seguida, configuramos o agente com uma interface do Google Chat.

Configurar o Google Chat

Para configurar seu agente do Dialogflow com o Google Chat, use uma destas opções:

• Console do Dialogflow
• Console do Google Cloud

Configurar o Google Chat usando o console do Dialogflow

Para integrar o Google Chat usando o console do Dialogflow, siga estas etapas:

1. Acesse o console do Dialogflow ES.
2. No menu à esquerda, selecione um projeto do Dialogflow.
3. Clique em Integrations.
4. Clique em Google Chat. Se o Google Chat não for uma das opções, consulte Resolver problemas.
5. Selecione quem pode acessar o app.
6. [Opcional] Selecione um ambiente para executar o agente.
7. Clique em Iniciar.

O app Google Chat está ativo e disponível para as pessoas que você selecionou.

Para configurar o app, clique novamente em Google Chat e em CONFIGURAR DETALHES DO BOT. Isso mostra a página do console do Google Cloud para a API Google Chat, em que você pode configurar parâmetros do app, como o avatar do app.

Configurar o Google Chat usando o console do Google Cloud

Para integrar o Google Chat usando o console do Google Cloud, siga estas etapas:

1. Selecione o projeto do Dialogflow.

   Acessar o seletor de projetos

2. Clique em .

3. Clique em APIs e serviços e em Biblioteca.

4. Pesquise e clique em API Google Chat.

5. Clique em Ativar.

6. Clique na guia Configuração.

7. Configure o app.

8. No painel Visibilidade, selecione quem pode acessar o app:

   • Testadores de apps. Selecione Disponibilizar esse chat para pessoas específicas e digite os endereços de e-mail delas.
   • Domínio público geral ou do Google Workspace Enterprise. Publicar o app.

9. Clique em Salvar. O app Google Chat está ativo e disponível para as pessoas que você selecionou.

Teste

Antes de testar o app do Chat, verifique se ele foi iniciado, conforme descrito em Configurar o Google Chat.

É possível testar o app usando um destes métodos:

• Conversar diretamente com o app
• Invocar o app de um espaço

Conversar diretamente com o app

1. Abra o Google Chat.
2. No painel Chat, clique em + e selecione Encontrar apps.
3. Pesquise e selecione seu app. Se o Google Chat não mostrar seu app, consulte Solução de problemas.
4. Clique em Chat.
5. No campo de entrada do chat, digite uma frase em linguagem natural para testar o app.

Invocar o app em um espaço

1. Abra o Google Chat.
2. No painel Espaços, clique em + e selecione Criar um espaço.
3. Digite o nome do espaço Teste.
4. Clique em Criar.
5. No campo de entrada de chat, digite @ e selecione seu app para concluir o nome automaticamente.
6. Depois do nome do app preenchido automaticamente, insira uma frase em linguagem natural para testar o app.

Resolver problemas

Erro	Solução
A página Console do Dialogflow ES > Integrações não mostra o Google Chat como uma opção.	Tente atualizar a página: no menu à esquerda, clique em Intents e em Integrations.
O Google Chat não lista seu app como disponível.	Verifique se o administrador do Google Workspace adicionou uma conta do Google Workspace para você e permitiu que os usuários instalassem apps do Chat. Em seguida, verifique se você iniciou o app Chat, conforme descrito em Configurar o Google Chat.

Mensagens de resposta avançadas

Essa integração traduz algumas mensagens de resposta ricas para os formatos de mensagem do Google Chat.

Respostas de texto

As respostas de texto são enviadas ao Google Chat como mensagens de texto. Com essa formatação, você pode deixar o texto em negrito ou em itálico ao encapsular o texto em determinados símbolos (Markdown leve).

A resposta de mensagem de texto parece visualmente igual à resposta de texto padrão no console do Dialogflow. No entanto, a resposta bruta da API será um pouco diferente. Ele também define a configuração da plataforma como GOOGLE_HANGOUTS, o que pode ser interessante ao criar agentes para várias integrações.

"fulfillmentMessages": [
{
   "text": {
   "text": [
        "This is a test."
   ]
},
  "platform": "GOOGLE_HANGOUTS"
},

Cartões

As respostas de cards são enviadas ao Google Chat como mensagens de cards.

Imagens

As respostas de imagem são enviadas ao Google Chat como widgets de imagem do Google Chat.

Payload personalizado

Observação: essa integração não oferece suporte a ações de cartão.

Para enviar outros tipos de mensagens do Google Chat, use um payload personalizado.

Com o payload personalizado do Google Chat, você pode criar cards mais avançados. Um card pode ter uma ou várias seções. Cada seção pode ter um cabeçalho. Confira o guia de referência de cards de mensagens de formato do Google Chat para ver algumas das combinações que você pode criar com isso. No entanto, se você usa payloads personalizados, será necessário fornecer o formato JSON.

Observação: ao copiar e colar os exemplos do guia de referência na caixa de payload personalizado no Dialogflow, verifique se o editor não contém erros de linting. Não é possível testar os resultados no simulador do Dialogflow, mas é possível testá-los diretamente no Google Chat.

Confira um exemplo de payload personalizado usando o formato Cards v1:

{
  "hangouts": {
    "header": {
      "title": "Pizza Delivery Customer Support",
      "subtitle": "[e-mail]",
      "imageUrl": "https://goo.gl/aeDtrS"
    },
    "sections": [{
      "widgets": [{
        "keyValue": {
          "icon": "TRAIN",
          "topLabel": "Order No.",
          "content": "12345"
        }
      },
      {
        "keyValue": {
          "topLabel": "Status",
          "content": "In Delivery"
        }
      }]
    },
    {
      "header": "Location",
      "widgets": [{
        "image": {
          "imageUrl": "https://dummyimage.com/600x400/000/fff"
        }
      }]
    },
    {
      "header": "Buttons - I could leave the header out",
      "widgets": [{
        "buttons": [{
          "textButton": {
            "text": "OPEN ORDER",
            "onClick": {
              "openLink": {
                "url": "https://example.com/orders/..."
              }
            }
          }
        }]
      }]
    }]
  }
}

Parar o app Chat

Para impedir que o app Google Chat fique disponível, use uma destas opções:

• Console do Dialogflow

• Console do Google Cloud

Parar o app Chat usando o console do Dialogflow

1. Acesse o console do Dialogflow ES.
2. No menu à esquerda, selecione um projeto do Dialogflow.
3. Clique em Integrations.
4. Clique em Google Chat. Se o Google Chat não for uma das opções, consulte Resolver problemas.
5. Clique em Interromper.

Parar o app de chat usando o console do Google Cloud

1. Selecione o projeto do Dialogflow no console do Google Cloud.

   Acessar o seletor de projetos

2. Clique em .

3. Clique em APIs e serviços e em Biblioteca.

4. Pesquise e clique em API Google Chat.

5. Clique em Gerenciar.

6. Clique na guia Configuração.

7. No campo Status do app, selecione DESATIVADO.

Mais informações

Para mais informações sobre como usar o Google Chat, consulte:

• Documentação para desenvolvedores do Google Chat
• Criar um app do Chat
• Vídeo: integrar o Dialogflow ao Google Chat
• Codelab: como integrar o Dialogflow ao Google Chat