Crie seu primeiro agente

Pré-requisitos

Criar seu agente

Neste guia, orientamos você em como criar um agente usando um aplicativo de exemplo. A amostra oferece 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 seu aplicativo.

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

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

Para criar um agente sem usar a amostra, consulte Criar seu agente.

Registrar-se como parceiro

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

  3. Insira as informações do parceiro:

    Field Valor
    Your name 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 para você com as APIs Business Messages e Business Communications ativadas. Você não tem acesso a este projeto, e ele não interferirá nos seus 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 Business Communications Developer Console, clique em Configurações da conta do parceiro.
  2. No painel de 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-o 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.

Criar uma marca e um agente

Um agente é uma representação conversacional de uma marca, ou seja, a entidade de conversa com que os usuários interagem. Você cria uma marca para representar a empresa e um agente para que os consumidores possam interagir com ela.

  1. Abra o Business Communications Developer Console (em inglês) e faça login com sua Conta do Google do 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. Escolha uma destas opções:
    • Para iniciar uma conversa com seu agente e conhecer os recursos disponíveis, selecione Ativar 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, prossiga e configure o agente para o processamento de mensagens.

Conhecer recursos com o bot de ajuda do Business Messages

Com o bot de ajuda do Business Messages, você pode iniciar rapidamente uma conversa com seu agente para conhecer o que a plataforma tem a oferecer. Ativar o bot de ajuda é opcional, mas altamente recomendado ao criar seu primeiro agente.

Com o bot de ajuda, você pode:

  • Conheça os recursos avançados
  • Saiba como implementar recursos
  • Encontre recursos para a configuração do agente

Quando o bot de ajuda está ativado, ele envia e recebe mensagens para seu agente. Nenhum webhook é necessário. É necessário desativar o bot de ajuda antes de definir um webhook ou ativar o Dialogflow para processar as mensagens dos usuários.

Iniciar uma conversa com o bot de ajuda

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

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

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

    • Clique no botão do Android ou do 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 app Google Maps.

Desativar o bot de ajuda

Antes de personalizar seu agente e prepará-lo para o lançamento, é necessário desativar 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. No painel de navegação à esquerda, clique em Integrações.
  4. Em Bot de ajuda, clique em Desativar.

Quando o bot de ajuda é desativado, ele não envia nem recebe mais mensagens para seu agente. Agora configure seu agente para processar o fluxo de mensagens.

Configurar seu agente para o gerenciamento de mensagens

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

O Echo Bot é um aplicativo de exemplo que envia mensagens de volta para o usuário. Ele permite testar recursos avançados, como ações sugeridas e rich cards, em uma conversa com seu agente. Também é possível usar o Echo Bot como ponto de partida para o desenvolvimento do agente.

Você concluirá as seguintes etapas:

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

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

implante o aplicativo da Web no GCP

O Business Messages encaminha mensagens dos usuários para um webhook na sua 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 o recebimento de mensagens, crie um novo webhook nesse serviço da Web. No entanto, você precisará configurar a lógica por conta própria. Consulte Definir seu webhook no nível do parceiro para mais detalhes.

Crie um ambiente em 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, precisa Aceitar os Termos e Serviços.

  2. Clique em Criar projeto.

  3. Digite um nome e local para seu novo projeto

    • O ID do projeto é gerado automaticamente e aparece abaixo do nome dele.
    • No campo Local, clique em Procurar para mostrar possíveis locais para seu projeto. Se não encontrar sua organização do Google Workspace, isso significa que você não fez login em uma conta do Google Workspace. É possível 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 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. Acesse os Recursos do programa sem custo financeiro do Google Cloud para entender as opções de pagamento.

Implante a amostra do Echo Bot

  1. Instale a CLI gcloud. Ele será usado 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 salvo em Criar uma conta de serviço para a pasta de recursos da amostra e renomeie as credenciais como "bm-agent-service-account-credentials.json". O caminho para esse arquivo de credenciais depende da amostra que você baixou.

    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, navegue até o diretório full_sample da amostra.

  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 aparece 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 aparece 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 aparece no painel do projeto no Google Cloud.

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

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

Defina seu webhook

Agora que o Echo Bot foi implantado, especifique um URL do webhook (operado) para começar a receber mensagens.

  1. Abra as Configurações da conta no console para desenvolvedores do Business Communications.
  2. Verifique se a conta do 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".

    Seu endpoint 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 recurso 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.

Use o framework de teste do Business Messages para testar se o webhook responde corretamente aos payloads do Business Messages.

Insira as informações do agente

Forneça algumas 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 como quiser ou use as seguintes sugestões:

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

  4. Clique em Salvar.

Inicie a conversa

Para interagir com o Echo Bot, 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 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.

    Se preferir, clique em Enviar para encaminhar 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 boas-vindas do seu agente é uma saudação. Agora é possível interagir com o Echo Bot. Ele transmite as mensagens que você envia de volta para você. Além disso, você pode invocar recursos avançados enviando strings específicas: "carrossel", "cartão", "ícones".

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.