Neste tutorial, mostramos como criar um app do Google Chat que responde a incidentes em tempo real. Ao responder a um incidente, o app cria e preenche um espaço do Chat, facilita a resolução de incidentes com mensagens, comandos de barra e caixas de diálogo e usa IA para resumir a resposta em um documento do Documentos Google.
Um incidente é um evento que requer a atenção imediata de uma equipe de pessoas para ser resolvido. Exemplos de incidentes incluem:
- Um caso urgente é criado em uma plataforma de gestão de relacionamento com o cliente (CRM), exigindo que uma equipe de serviço colabore para uma resolução.
- Um sistema fica off-line, alertando um grupo de engenheiros de confiabilidade do site (SREs, na sigla em inglês) para que eles possam trabalhar juntos e colocá-lo novamente on-line.
- Um terremoto de grande magnitude ocorre, e os trabalhadores de emergência precisam coordenar a resposta.
Para fins deste tutorial, o alerta de incidente começa quando alguém informa o incidente com um clique em um botão em uma página da Web. A página da Web simula um incidente solicitando que os usuários insiram informações básicas sobre ele: título, descrição e endereços de e-mail dos responsáveis pela resposta.
Confira o app de chat de gerenciamento de incidentes em ação:
-
Figura 2. Notificação de que o espaço do Chat do incidente foi criado. -
Figura 3. O espaço do Chat de resposta a incidentes. -
Figura 4. Resolva o incidente com um comando de barra. -
Figura 5. Caixa de diálogo de resolução de incidentes. -
Figura 6. Documento do Google Docs de resolução de incidentes compartilhado no espaço. -
Figura 7. O documento de resumo do incidente de IA nos Documentos Google.
Pré-requisitos
Se você precisar ativar algum desses pré-requisitos na sua organização, peça ao administrador do Google Workspace para fazer isso:
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Ative o Diretório (compartilhamento de contatos) no Google Workspace. O app de incidentes usa o diretório para procurar as informações de contato dos respondentes, como nome e endereço de e-mail. Os participantes do incidente precisam ser usuários com uma conta do Google Chat na sua organização do Google Workspace.
Objetivos
- Crie um app de chat que responda a incidentes.
- Ajude os usuários a responder a incidentes fazendo o seguinte:
- Criação de espaços de resposta a incidentes.
- Postar mensagens resumindo incidentes e respostas.
- Oferecer suporte à colaboração com recursos interativos do app Chat.
- Resuma conversas e resoluções com a Vertex AI.
Arquitetura
O diagrama a seguir mostra a arquitetura dos recursos do Google Workspace e do Google Cloud usados pelo app do Google Chat para resposta a incidentes.
A arquitetura mostra como o app do Google Chat de resposta a incidentes processa um incidente e a resolução.
Um usuário inicia um incidente em um site externo hospedado no Apps Script.
O site envia uma solicitação HTTP assíncrona ao app Google Chat, também hospedado no Apps Script.
O app Google Chat de resposta a incidentes processa a solicitação:
O serviço do SDK Admin do Apps Script recebe informações de membros da equipe, como ID do usuário e endereço de e-mail.
Com um conjunto de solicitações HTTP para a API Chat usando o serviço avançado de chat do Apps Script, o app Google Chat de resposta a incidentes cria um espaço de chat de incidentes, preenche-o com membros da equipe e envia uma mensagem para o espaço.
Os membros da equipe discutem o incidente no espaço do Chat.
Um membro da equipe invoca um comando de barra para sinalizar uma resolução do incidente.
Uma chamada HTTP para a API Chat usando o serviço de chat avançado do Apps Script lista todas as mensagens do espaço do Chat.
A Vertex AI recebe as mensagens listadas e gera um resumo.
O serviço
DocumentApp
do Apps Script cria um documento do Documentos e adiciona o resumo da Vertex AI ao documento.O app de resposta a incidentes do Google Chat chama a API Chat para enviar uma mensagem compartilhando um link para o documento de resumo do Documentos Google.
Prepare o ambiente
Esta seção mostra como criar e configurar um projeto do Google Cloud para o app Chat.
Criar um projeto do Google Cloud
Console do Google Cloud
- No console do Google Cloud, acesse Menu > IAM e administrador > Criar um projeto.
-
No campo Nome do projeto, insira um nome descritivo.
Opcional: para editar o ID do projeto, clique em Editar. O ID do projeto não pode ser alterado após a criação do projeto. Portanto, escolha um ID que atenda às suas necessidades durante a vida útil do projeto.
- No campo Local, clique em Procurar para mostrar possíveis locais para o projeto. Em seguida, clique em Selecionar.
- Clique em Criar. O console do Google Cloud navega até a página "Painel", e seu projeto é criado em alguns minutos.
CLI da gcloud
Em um dos ambientes de desenvolvimento a seguir, acesse a CLI do Google Cloud (gcloud
):
-
Cloud Shell: para usar um terminal on-line com a CLI gcloud
já configurada, ative o Cloud Shell.
Ativar o Cloud Shell -
Shell local: para usar um ambiente de desenvolvimento local,
instale e
inicialize
a CLI gcloud.
Para criar um projeto do Cloud, use o comandogcloud projects create
: Substitua PROJECT_ID definindo o ID do projeto que você quer criar.gcloud projects create PROJECT_ID
Ative o faturamento para o projeto do Cloud
Console do Google Cloud
- No console do Google Cloud, acesse Faturamento. Clique em Menu > Faturamento > Meus projetos.
- Em Selecionar uma organização, escolha a organização associada ao seu projeto do Google Cloud.
- Na linha do projeto, abra o menu Ações ( ), clique em Alterar faturamento e escolha a conta do Cloud Billing.
- Clique em Definir conta.
CLI da gcloud
- Para listar as contas de faturamento disponíveis, execute:
gcloud billing accounts list
- Vincule uma conta de faturamento a um projeto do Google Cloud:
gcloud billing projects link PROJECT_ID --billing-account=BILLING_ACCOUNT_ID
Substitua:
PROJECT_ID
é o ID do projeto do projeto do Cloud para o qual você quer ativar o faturamento.BILLING_ACCOUNT_ID
é o ID da conta de faturamento a ser vinculado ao projeto do Google Cloud.
Ative as APIs
Console do Google Cloud
No console do Google Cloud, ative a API Google Chat, a API Google Docs, a API Admin SDK e a API Vertex AI.
Confirme se você está ativando as APIs no projeto do Cloud correto e clique em Next.
Confirme se você está ativando as APIs corretas e clique em Ativar.
CLI da gcloud
Se necessário, defina o projeto atual do Cloud como o que você criou com o comando
gcloud config set project
:gcloud config set project PROJECT_ID
Substitua PROJECT_ID pelo ID do projeto do projeto do Cloud que você criou.
Ative a API Google Chat, a API Google Docs, a API Admin SDK e a API Vertex AI com o comando
gcloud services enable
:gcloud services enable chat.googleapis.com docs.googleapis.com admin.googleapis.com aiplatform.googleapis.com
Configurar a autenticação e a autorização
A autenticação e a autorização permitem que o app de chat acesse recursos no Google Workspace e no Google Cloud para processar uma resposta a incidentes.
Neste tutorial, você vai publicar o app internamente, então não há problema em usar informações de marcador de posição. Antes de publicar o app externamente, substitua as informações do marcador por informações reais da tela de consentimento.
No console do Google Cloud, acesse Menu > APIs e serviços > Tela de consentimento do OAuth.
Em Tipo de usuário, selecione Interno e clique em Criar.
Em Nome do app, digite
Incident Management
.Em E-mail para suporte do usuário, selecione seu endereço de e-mail ou um Grupo do Google apropriado.
Em Dados de contato do desenvolvedor, insira seu endereço de e-mail.
Clique em Salvar e continuar.
Clique em Adicionar ou remover escopos. Um painel aparece com uma lista de escopos para cada API que você ativou no projeto do Cloud.
Em Adicionar escopos manualmente, cole os seguintes escopos:
https://www.googleapis.com/auth/chat.spaces.create
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.app
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/script.external_request
https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/cloud-platform
Clique em Adicionar à tabela.
Clique em Atualizar.
Clique em Salvar e continuar.
Revise o resumo do registro do app e clique em Voltar ao painel.
Criar e implantar o app do Chat
Na próxima seção, você vai copiar e atualizar um projeto inteiro do Apps Script que contém todo o código de aplicativo necessário para o app de chat. Assim, não é necessário copiar e colar cada arquivo.
Algumas funções incluem sublinhados no final dos nomes, como processSlashCommand_()
de ChatApp.gs
. O sublinhado oculta a função
da página da Web de inicialização do incidente quando ela está aberta em um navegador. Para mais
informações, consulte
Funções privadas.
O Apps Script oferece suporte a dois tipos de arquivos: scripts .gs
e arquivos .html
. Para respeitar esse suporte, o JavaScript do lado do cliente do app é incluído
nas tags <script />
, e o CSS dele é incluído nas tags <style />
,
em um arquivo HTML.
Outra opção é acessar o projeto inteiro no GitHub.
Esta é uma visão geral de cada arquivo:
Consts.gs
Define as constantes referenciadas por outros arquivos de código, incluindo o ID do projeto do Cloud, o ID do local da Vertex AI e o ID de comando de barra para encerrar um incidente.
Ver código do app
Consts.gs
ChatApp.gs
Processa eventos de interação do Chat, como mensagens, cliques em cards, comandos de barra e diálogos. Responde ao comando de barra
/closeIncident
abrindo uma caixa de diálogo para coletar detalhes da resolução do incidente. Lê mensagens no espaço chamando o métodospaces.messages.list
na API Chat. Extrai IDs de usuário usando o serviço de diretório do SDK Admin no Apps Script.Mostrar código
ChatApp.gs
ChatSpaceCreator.gs
Recebe os dados de formulário que os usuários inserem na página da Web de inicialização do incidente e os usa para configurar um espaço de chat, criando e preenchendo-o, e depois publica uma mensagem sobre o incidente.
Ver código do app
ChatSpaceCreator.gs
DocsApi.gs
Chama a API Documentos Google para criar um documento do Documentos Google no Google Drive de um usuário e grava um resumo das informações do incidente, criado em
VertexAiApi.gs
, no documento.Ver código do app
DocsApi.gs
VertexAiApi.gs
Resume a conversa no espaço de chat usando a Vertex AI. Esse resumo é postado em um documento criado especialmente em
DocsAPI.gs
.Mostrar código
VertexAiApi.gs
WebController.gs
Fornece o site de inicialização do incidente.
Mostrar código
WebController.gs
Index.html
O HTML que compõe o site de inicialização do incidente.
Mostrar código
Index.html
JavaScript.html
Processa o comportamento do formulário, incluindo envios, erros e exclusões, para o site de inicialização do incidente. Ele é incluído em
Index.html
pela funçãoinclude
personalizada emWebController.gs
.Ver código do app
JavaScript.html
Stylesheet.html
O CSS do site de inicialização do incidente. Ela é incluída em
Index.html
pela funçãoinclude
personalizada emWebController.gs
.Mostrar código
Stylesheet.html
Encontre o número e o ID do projeto do Cloud
No console do Google Cloud, acesse seu projeto do Cloud.
Clique em Configurações e utilitários > Configurações do projeto.
Anote os valores nos campos Número do projeto e ID do projeto. Você vai usá-los nas seções a seguir.
Criar o projeto do Apps Script
Para criar um projeto do Apps Script e conectá-lo ao seu projeto do Cloud:
- Clique no botão a seguir para abrir o projeto do Apps Script Respond to incidents with Google Chat.
Abrir o projeto - Clique em Visão geral.
- Na página de visão geral, clique em Fazer uma cópia.
Nomeie sua cópia do projeto do Apps Script:
Clique em Cópia de "Responder a incidentes com o Google Chat".
Em Título do projeto, digite
Incident Management Chat app
.Clique em Renomear.
Na sua cópia do projeto do Apps Script, acesse o arquivo
Consts.gs
e substituaYOUR_PROJECT_ID
pelo ID do projeto do Cloud.
Definir o projeto do Cloud do Apps Script
- No projeto do Apps Script, clique em Project Settings.
- Em Projeto do Google Cloud Platform (GCP), clique em Mudar projeto.
- Em Número do projeto do GCP, cole o número do seu projeto do Cloud.
- Clique em Configurar projeto. O projeto do Cloud e do Apps Script agora estão conectados.
Criar uma implantação do Apps Script
Agora que todo o código está em vigor, implante o projeto do Apps Script. Use o ID de implantação ao configurar o app do Chat no Google Cloud.
No Apps Script, abra o projeto do app de resposta a incidentes.
Clique em Implantar > Nova implantação.
Se Complemento e Aplicativo da Web ainda não estiverem selecionados, ao lado de Selecionar tipo, clique em tipos de implantação e selecione Complemento e Aplicativo da Web.
Em Descrição, insira uma descrição para essa versão, como
Complete version of incident management app
.Em Executar como, selecione Usuário acessando o app da Web.
Em Quem tem acesso, selecione Qualquer pessoa na sua organização do Workspace, em que "sua organização do Workspace" é o nome da sua organização do Google Workspace.
Clique em Implantar. O Apps Script informa a implantação bem-sucedida e fornece um ID de implantação e um URL para a página da Web de inicialização do incidente.
Anote o URL do app da Web para acessar mais tarde quando iniciar um incidente. Copie o ID da implantação. Use esse ID ao configurar o app Chat no console do Google Cloud.
Clique em Concluído.
Configurar o app do Chat no console do Google Cloud
Esta seção mostra como configurar a API Google Chat no console do Google Cloud com informações sobre seu app do Chat, incluindo o ID da implantação que você acabou de criar no projeto do Apps Script.
No console do Google Cloud, clique em Menu > Mais produtos > Google Workspace > Biblioteca de produtos > API Google Chat > Gerenciar > Configuração.
Em Nome do app, digite
Incident Management
.No URL do avatar, digite
https://developers.google.com/chat/images/quickstart-app-avatar.png
.Em Descrição, digite
Responds to incidents.
.Clique no botão Ativar recursos interativos para ativar essa opção.
Em Funcionalidade, selecione Receber mensagens individuais e Participar de espaços e conversas em grupo.
Em Configurações de conexão, selecione Apps Script.
Em Deployment ID, cole o ID de implantação do Apps Script que você copiou anteriormente da implantação do projeto do Apps Script.
Registre um comando de barra que o app de chat totalmente implementado usa:
Em Comandos de barra, clique em Adicionar um comando de barra.
Em Nome, digite
/closeIncident
.Em ID do comando, digite
1
.Em Descrição, digite
Closes the incident being discussed in the space.
Selecione Abre uma caixa de diálogo.
Clique em Concluído. O comando de barra é registrado e listado.
Em Visibilidade, selecione Disponibilizar este app do Chat para pessoas e grupos específicos no domínio do espaço de trabalho e insira seu endereço de e-mail.
Em Registros, selecione Registrar erros no Logging.
Clique em Salvar. Uma mensagem de configuração salva aparece, o que significa que o app está pronto para teste.
Teste o app do Chat
Para testar o app Chat de gerenciamento de incidentes, inicie um incidente na página da Web e verifique se o app Chat funciona conforme o esperado:
Acesse o URL do app da Web de implantação do Apps Script.
Quando o Apps Script solicitar permissão para acessar seus dados, clique em Revisar permissões, faça login com uma Conta do Google adequada no domínio do Google Workspace e clique em Permitir.
A página da Web de inicialização do incidente é aberta. Insira as informações do teste:
- Em Título do incidente, digite
The First Incident
. - Opcionalmente, em Respostas a incidentes, insira os endereços de e-mail dos outros participantes. Eles precisam ser usuários com uma conta do Google Chat na sua organização do Google Workspace. Caso contrário, a criação do espaço vai falhar. Não insira seu próprio endereço de e-mail, porque ele é incluído automaticamente.
- Em Mensagem inicial, digite
Testing the incident management Chat app.
.
- Em Título do incidente, digite
Clique em Criar espaço de chat. Uma mensagem
creating space
aparece.Depois que o espaço é criado, a mensagem
Space created!
aparece. Clique em Abrir espaço para abrir o espaço no Chat em uma nova guia.Você e os outros responsáveis pela resposta a incidentes também podem enviar mensagens no espaço. O app resume essas mensagens usando a Vertex AI e compartilha um documento de retrospectiva.
Para encerrar a resposta a incidentes e iniciar o processo de resolução, no espaço de chat, digite
/closeIncident
. Uma caixa de diálogo de gerenciamento de incidentes é aberta.Em Fechar incidente, insira uma descrição da resolução do incidente, como
Test complete
.Clique em Fechar incidente.
O app Gerenciamento de incidentes lista as mensagens no espaço, as resume com o Vertex AI, cola o resumo em um documento do Documentos Google e compartilha o documento no espaço.
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, recomendamos excluir o projeto do Cloud.
- No console do Google Cloud, acesse a página Gerenciar recursos. Clique em Menu > IAM e administrador > Gerenciar recursos.
- Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir .
- Na caixa de diálogo, digite o ID do projeto e clique em Encerrar para excluir o projeto.
Temas relacionados
- Responder a perguntas com base em conversas do Chat usando um app do Chat com IA do Gemini
- Gerenciar projetos com o Google Chat, a Vertex AI e o Firestore
- O app de resposta a incidentes se autentica com as credenciais do usuário para chamar APIs
e invocar serviços do Google Cloud, como a API Chat e a API Vertex AI.
Isso significa que o usuário que inicializa um incidente precisa ter acesso a esses
serviços. Para tornar o app mais robusto, chame a API Vertex AI
com uma conta de serviço em vez das credenciais do usuário que invoca
o comando
/closeIncident
. Se precisar de ajuda para configurar uma conta de serviço para a API Vertex AI, consulte Usar uma conta de serviço personalizada.