Crie seu primeiro agente

Pré-requisitos

Criar o agente

Este guia mostra como criar um agente usando um aplicativo de exemplo. O exemplo oferece uma maneira rápida de conhecer a funcionalidade de um agente e pode servir como ponto de partida para o desenvolvimento do seu 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:

  • Inscrever-se como parceiro
  • Criar uma marca e um agente
  • Opcional: conhecer os recursos em uma conversa com o bot de ajuda do Business Messages
  • Configurar o agente para enviar e receber mensagens

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

Inscrever-se como parceiro

  1. Abra o console do desenvolvedor do Business Communications.
  2. Em Business Messages, clique em Criar conta de parceiro.

  3. Insira as informações do 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.

Agora você está registrado como parceiro do Business Messages. Um novo projeto na nuvem do Google Cloud foi criado para você com as APIs Business Messages e Business Communications ativadas. Você não tem acesso a esse projeto, e ele não vai interferir em nenhum dos seus projetos atuais do Google Cloud.

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

Criar uma conta de serviço

  1. Na página inicial do Business Communications Developer Console, 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 fará o download da chave da conta de serviço. Armazene-a em um local seguro. Você vai precisar dessa chave 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. Você cria uma marca para representar a empresa e um agente para que os consumidores possam se conectar a ela de forma conversacional.

  1. Abra o console do desenvolvedor do Business Communications e faça login com sua conta do Google Business Messages.
  2. Clique em Criar agente.
  3. Em Tipo de agente, selecione Business Messages.
  4. Insira valores para Nome da marca e Nome do agente.
  5. Realize uma das seguintes ações:
    • Para ter uma conversa com seu agente em que você possa conhecer os recursos disponíveis, selecione Ativar o bot de ajuda do Business Messages.
    • Para personalizar seu 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, continue a configurar seu agente para o processamento de 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ê pode aproveitar os recursos disponíveis. Ativar o bot de ajuda é opcional, mas altamente recomendado ao criar seu primeiro agente.

O bot de ajuda permite que você:

  • Conheça recursos avançados
  • Aprenda a implementar recursos
  • Encontre recursos para a configuração do agente

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

Iniciar uma conversa com o bot de ajuda

Depois de ativar o bot de ajuda do Business Messages, você pode iniciar uma conversa. Uma caixa de diálogo é aberta imediatamente após a criação do agente para ajudar você a começar.

Para interagir com o bot de ajuda, siga estas etapas na 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. Em seguida, leia o QR code com o dispositivo móvel correspondente e clique em Iniciar. Como alternativa, 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 Google Maps app.)

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 console do desenvolvedor do Business Communications.
  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 mais mensagens do seu agente. Agora você pode configurar o agente para processar o fluxo de mensagens.

Configurar o agente para o processamento de mensagens

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

O bot de eco é um aplicativo de exemplo que repete mensagens para o usuário. Ele permite que você experimente recursos avançados, como ações sugeridas e rich cards, em uma conversa com seu agente. Você também pode usar o bot de eco como ponto de partida para desenvolver seu agente.

Você vai concluir as seguintes etapas:

  • Implantar o exemplo do bot de eco no GCP
  • Configurar o URL do webhook para sua conta de parceiro do Business Messages
  • Fornecer informações básicas sobre o agente

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

Implantar o aplicativo da Web no GCP

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

Criar um ambiente de nuvem

Você precisa de um ambiente de nuvem para implantar o exemplo do bot de eco.

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á necessário aceitar os Termos de Serviço.

  2. Clique em Criar projeto.

  3. Insira 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 Navegar para mostrar os locais possíveis para o projeto. Se você não encontrar sua organização do Google Workspace, é porque não fez login em uma conta do Google Workspace. Você pode criar um projeto sem uma organização, mas alguns recursos são limitados. Consulte Benefícios do recurso de organização para mais informações.

  4. Clique em Criar.

  5. Clique no Menu.

  6. Clique em Faturamento.

  7. Clique em Vincular uma conta de faturamento.

  8. Crie uma nova conta de faturamento ou adicione uma conta de faturamento atual ao projeto. Consulte Recursos do Programa do Google Cloud sem custo financeiro para entender as opções de pagamento.

Implantar o exemplo do bot de eco

  1. Instale a CLI gcloud. Você vai usá-la para implantar o código de exemplo no Google Cloud.

  2. Faça o download e extraia o exemplo do bot de eco (Node.js, Java, Python).

  3. Copie o arquivo de credenciais JSON que você fez o download em Criar uma conta de serviço na pasta de recursos de exemplo e renomeie as credenciais para "bm-agent-service-account-credentials.json". O caminho para esse arquivo de credenciais depende do exemplo que você fez o 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 do exemplo.

  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 de nuvem. O ID do projeto está 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 de nuvem. O ID do projeto está 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 de nuvem. O ID do projeto está listado no painel do projeto no Google Cloud.

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

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

Definir o webhook

Agora que o bot de eco está implantado, especifique um URL de webhook (que você opera) 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 URL do endpoint do webhook, insira o URL do aplicativo + "/callback".

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

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

  5. No console do desenvolvedor, clique em Verificar.

    Quando o Business Messages verifica o 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 a estrutura de teste do Business Messages para testar se o webhook responde corretamente aos payloads do Business Messages.

Inserir informações do agente

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

  1. Abra o console do desenvolvedor do Business Communications.
  2. Na navegação à esquerda, clique em Informações do agente.

  3. Atualize os valores como quiser ou use as seguintes sugestões:

    Campo Valor
    Mensagem de boas-vindas Bem-vindo à conversa do bot de eco!
    Política de Privacidade https://policies.google.com/privacy

  4. Clique em Salvar.

Inicie a conversa

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

  1. Abra o console do desenvolvedor do Business Communications.
  2. Na 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 QR code 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 Google Maps app.)

A mensagem de boas-vindas do agente aparece. Nesse momento, você pode interagir com o bot de eco. Ele repete as mensagens que você envia. Além disso, você pode invocar recursos avançados enviando strings específicas: "carousel", "card", "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.