Crie seu primeiro agente

Pré-requisitos

Criar seu agente

Neste guia, vamos mostrar como criar um agente usando um aplicativo de amostra. O exemplo fornece uma maneira rápida de explorar a funcionalidade de um agente e pode servir como ponto de partida para o desenvolvimento do agente. Se você quiser modificar um aplicativo atual para incluir um agente, o exemplo oferece um bom modelo para a lógica do aplicativo.

Neste guia de início rápido, você fará o seguinte:

  • Registrar como parceiro
  • Criar uma marca e um agente
  • Você também pode explorar recursos em uma conversa com o bot de ajuda do Business Messages.
  • Configure seu agente para enviar e receber mensagens

Para criar um agente sem usar o exemplo, consulte Criar seu agente.

Registrar como parceiro

  1. Abra o Business Communications Developer Console.
  2. Em Business Messages, clique em Create partner account.

  3. Insira as informações do seu parceiro:

    Campo Valor
    Seu nome Seu nome completo
    Nome do parceiro Nome da sua organização
    Site do parceiro Site da sua organização
    Região A região em que você quer hospedar o serviço do Business Messages

  4. Leia e aceite os Termos de Serviço do Business Messages.

  5. Clique em Criar.

Você está registrado como um parceiro do Business Messages. Um novo projeto do Google Cloud foi criado com as APIs Business Messages e Communications comerciais ativadas. Você não tem acesso a este projeto e ele não vai interferir nos projetos atuais do Google Cloud.

Agora você tem acesso às APIs Business Messages e Business Communications.

Crie uma conta de serviço

  1. Na página inicial do Console do desenvolvedor do Business Communications, clique em Configurações da conta de parceiro.
  2. Na navegação à esquerda, clique em Conta de serviço.

  3. Clique em Criar chave e em Criar.

    O navegador faz o download da chave da conta de serviço. Armazene-o em um local seguro. Você precisará dela mais tarde para implantar um aplicativo da Web e acessar as APIs Business Messages e Business Communications no futuro.

Criar uma marca e um agente

Um agente é uma representação conversacional de uma marca: a entidade conversacional com que os usuários interagem. Crie uma marca para representar a empresa e crie um agente para que os consumidores possam se conectar com ela.

  1. Abra o Console do desenvolvedor do Business Communications e faça login com sua Conta do Google do Business Messages.
  2. Clique em Criar agente.
  3. Em Tipo de agente, selecione Mensagens comerciais.
  4. Digite valores para Nome da marca e Nome do agente.
  5. Realize uma das seguintes ações:
    • Para conversar com seu agente em que você pode explorar os recursos disponíveis, selecione Ativar o bot de ajuda do Business Messages.
    • Para personalizar o agente e prepará-lo para o processamento de mensagens, desmarque Ativar o bot de ajuda do Business Messages.
  6. Clique em Criar agente.

Se você ativou o bot de ajuda do Business Messages, pode iniciar uma conversa imediatamente. Caso contrário, configure o agente para processar as mensagens.

Conhecer os recursos com o bot de ajuda do Business Messages

O bot de ajuda do Business Messages ajuda você a iniciar uma conversa, de maneira rápida, usando seu agente. Assim, você aproveita o que a plataforma tem a oferecer. Ativar o bot de ajuda é opcional, mas altamente recomendado ao criar seu primeiro agente.

O bot de ajuda permite que você

  • Conheça os recursos avançados
  • Saiba como implementar recursos
  • Encontre recursos para configurar o agente

Quando o bot de ajuda está ativado, ele envia e recebe mensagens do seu agente sem a necessidade de um webhook. É necessário desativar o bot de ajuda antes de definir um webhook ou ativar o Dialogflow para processar mensagens de usuário.

Iniciar uma conversa com o bot de ajuda

Depois de ativar o bot de ajuda do Business Messages, você poderá iniciar uma conversa. Uma caixa de diálogo aparece logo após a criação do agente.

Para interagir com o bot de ajuda, siga as etapas abaixo nesta caixa de diálogo:

  1. Acesse os URLs de teste do agente. Há algumas maneiras de fazer isso:

    • Clique no botão Android ou iOS. Depois, leia o código QR com o dispositivo móvel correspondente e clique em Iniciar. Se preferir, clique em Copiar URL do Android ou Copiar URL do iOS para copiar o URL de teste do agente.
    • Clique em Enviar para enviar os URLs ao seu endereço de e-mail.

  2. Abra o URL no seu dispositivo móvel. Os dispositivos iOS exigem o app Google Maps.

Desativar o bot de ajuda

Antes de personalizar seu agente e prepará-lo para o lançamento, desative o bot de ajuda do Business Messages.

Para desativar o bot de ajuda,

  1. Abra o Business Communications Developer Console.
  2. Selecione seu agente.
  3. Na navegação à esquerda, clique em Integrações.
  4. Em Bot de ajuda, clique em Desativar.

Quando o bot de ajuda está desativado, ele não envia nem recebe mensagens do agente. Agora é possível configurar seu agente para processar o fluxo de mensagens.

Configurar o agente para processar mensagens

Neste guia, você vai implantar um bot de eco no Google Cloud Platform (GCP) com um webhook criado para processar mensagens do usuário.

O bot de eco é um exemplo de aplicativo que transmite as mensagens de volta ao usuário. Com ele, é possível testar recursos avançados, como ações sugeridas e rich cards, em uma conversa com o agente. Também é possível usar o bot de eco como ponto de partida para desenvolver seu agente.

Siga estas etapas:

  • Implantar a amostra do Echo Bot no GCP
  • Configurar o URL do webhook para sua conta de parceiro do Business Messages
  • Forneça informações básicas sobre seu agente

Ao final deste guia, seu agente estará pronto para enviar e receber mensagens.

Implantar o aplicativo da Web no GCP

O Business Messages encaminha mensagens de usuários para um webhook na infraestrutura. Neste guia, você implantará o código-fonte de amostra do Echo Bot em um webhook pré-configurado. Se você já tiver uma infraestrutura da Web para aproveitar mensagens, poderá criar um novo webhook nesse serviço da Web, mas precisará configurar a lógica por conta própria. Consulte Definir seu webhook no nível do parceiro para mais detalhes.

Criar um ambiente de nuvem

Você precisa de um ambiente de nuvem para implantar a amostra do Echo Bot.

Para criar um projeto do GCP como um ambiente de nuvem, siga estas etapas:

  1. Abra o seletor de projetos do Console do Google Cloud.

    Se você nunca criou um projeto do Google Cloud, será preciso Aceitar os Termos e Serviços.

  2. Clique em Criar projeto.

  3. Digite um nome e um local para o novo projeto.

    • O ID do projeto é gerado automaticamente e aparece abaixo do nome do projeto.
    • No campo Local, clique em Procurar para ver os locais em potencial do projeto. Se a organização do Google Workspace não estiver disponível, sua conta não está conectada. É possível criar um projeto sem uma organização, mas alguns recursos são limitados. Veja mais informações em Benefícios do recurso da organização.

  4. Clique em Criar.

  5. Clique em Menu.

  6. Clique em Faturamento.

  7. Clique em Vincular uma conta de faturamento.

  8. Crie uma nova conta de faturamento ou adicione uma atual ao projeto. Veja os recursos do programa Google Cloud Free para entender as opções de pagamento.

Implantar o exemplo de eco do bot

  1. Instale a CLI gcloud. Você usará isso para implantar o exemplo de código no Google Cloud.

  2. Faça o download e extraia a amostra do Echo Bot (Node.js, Java, Python).

  3. Copie o arquivo de credenciais JSON que você salvou em Criar uma conta de serviço para a pasta de recursos do exemplo e renomeie as credenciais para "bm-agent-service-account-credentials.json". O caminho para esse arquivo de credenciais depende da amostra que você transferiu por download.

    Node.js

    ./bm-nodejs-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json

    Java

    ./bm-java-echo-bot/full_sample/src/main/resources/bm-agent-service-account-credentials.json

    Python

    ./bm-python-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json

  4. Em um terminal, acesse o diretório full_sample.

  5. Execute os seguintes comandos em um terminal para implantar o exemplo:

    Node.js

    gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy

    PROJECT_ID é o ID do projeto que você criou em Criar um ambiente do Cloud. O ID do projeto é listado no painel do projeto no Google Cloud.

    Java

    gcloud config set project PROJECT_ID
gcloud app create
mvn appengine:deploy

    PROJECT_ID é o ID do projeto que você criou em Criar um ambiente do Cloud. O ID do projeto é listado no painel do projeto no Google Cloud.

    Python

    gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy

    PROJECT_ID é o ID do projeto que você criou em Criar um ambiente do Cloud. O ID do projeto é listado no painel do projeto no Google Cloud.

  6. Anote o URL do aplicativo implantado na saída do último comando. Esta é a base do seu URL do webhook:

    Deployed service [default] to [https://PROJECT_ID.appspot.com]

Defina seu webhook

Agora que o Echo Bot está implantado, você precisa especificar um URL do webhook (operado por você) para começar a receber mensagens.

  1. Abra as Configurações da conta no Console do desenvolvedor do Business Communications.
  2. Verifique se a conta de parceiro correta está selecionada.
  3. Em URL do webhook do Business Messages, clique em Configurar.

  4. Em Webhook endpoint URL, insira o URL do seu aplicativo + "/callback".

    O endpoint vai seguir o formato: "https://PROJECT_ID.appspot.com/callback".

    Esse endpoint é predefinido na lógica do aplicativo da amostra que você implantou no GCP.

  5. No Play Console, clique em Verificar.

    Quando o Business Messages verifica seu webhook, a caixa de diálogo é fechada.

Para configurar o webhook com a API Business Communications, consulte Exemplo: atualizar o URL do webhook.

Você pode usar o framework de teste do Business Messages para testar se o webhook responde com sucesso aos payloads do Business Messages.

Digite as informações do agente

Forneça informações básicas para concluir a configuração do agente.

  1. Abra o Business Communications Developer Console.
  2. No painel de navegação à esquerda, clique em Informações do agente.

  3. Atualize os valores da forma que preferir ou use as sugestões a seguir:

    Campo Valor
    Mensagem de recepção Esta é a conversa do Echo Bot.
    Política de Privacidade https://policies.google.com/privacy

  4. Clique em Salvar.

Iniciar a conversa

Para interagir com o bot de eco, siga estas etapas:

  1. Abra o Business Communications Developer Console.
  2. No painel de navegação à esquerda, clique em Informações do agente.
  3. Em URLs de teste do agente, clique no botão Android ou iOS.

  4. Leia o código QR com o dispositivo móvel correspondente ou clique em Copiar URL do Android ou Copiar URL do iOS para copiar o URL de teste do agente.

    Você também pode clicar em Enviar para enviar os URLs ao seu endereço de e-mail.

  5. Abra o URL no seu dispositivo móvel. Os dispositivos iOS exigem o app Google Maps.

A mensagem de recepção do seu agente dá as boas-vindas. Agora você pode interagir com o bot de eco. Ele retorna as mensagens enviadas para você. Além disso, você pode invocar recursos avançados enviando strings específicas: "carrossel", "cartão", "chips".

Próximas etapas

Agora que você criou seu primeiro agente, saiba mais sobre o Business Messages e o que mais você pode fazer na plataforma.