Google Chat, Vertex AI ve Apps Komut Dosyası ile olaylara yanıt verme

Bu eğitimde, Geliştirici Önizlemesi kapsamında kullanılabilen https://www.googleapis.com/auth/chat.app.* ile başlayan yetkilendirme kapsamları kullanılır. Chat uygulamanız için tek seferlik bir yönetici onayı gerekir.

Bu eğitimde, olaylara anında yanıt veren bir Google Chat uygulamasının nasıl oluşturulacağı gösterilmektedir. Uygulama, bir olaya yanıt verirken bir Chat alanı oluşturup doldurur, mesajlar, eğik çizgi komutları ve iletişim kutularıyla olayın çözüme ulaştırılmasını kolaylaştırır ve olay yanıtını bir Google Dokümanlar belgesinde özetlemek için yapay zekadan yararlanır.

Olay, çözülmesi için bir ekip tarafından hemen müdahale edilmesi gereken bir durumdur. Olaylara örnek olarak aşağıdakiler verilebilir:

• Müşteri İlişkileri Yönetimi (CRM) platformunda zamana duyarlı bir destek kaydı oluşturulur. Bu destek kaydının çözümü için hizmet ekibinin birlikte çalışması gerekir.
• Bir sistem çevrimdışı olduğunda, site güvenilirliği mühendisleri (SRE'ler) bir grup olarak uyarı alır. Bu sayede, birlikte çalışarak sistemi tekrar çevrimdışı hale getirebilirler.
• Büyük çaplı bir deprem meydana gelir ve acil durum çalışanlarının müdahalelerini koordine etmesi gerekir.

Bu eğitim kapsamında olay uyarısı, bir kullanıcı web sayfasından bir düğmeyi tıklayarak olayı bildirdiğinde başlar. Web sayfası, kullanıcılardan temel olay bilgilerini (başlık, açıklama ve müdahale edenlerin e-posta adresleri) girmelerini isteyerek bir olayı simüle eder.

Olay yönetimi Chat uygulamasının nasıl çalıştığını görün:

Ön koşullar

Kuruluşunuzda etkinleştirilmesi gereken ön koşullardan herhangi birine ihtiyacınız varsa Google Workspace yöneticinizden bunları etkinleştirmesini isteyin:

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
• Google Workspace için Dizin'in (kişi paylaşımı) etkinleştirilmesi gerekir. Olay uygulaması, olaya müdahale eden kişilerin iletişim bilgilerini (ör. ad ve e-posta adresi) aramak için dizini kullanır. Olaya müdahale edenler, Google Workspace kuruluşunuzda Google Chat hesabı olan kullanıcılar olmalıdır.

Hedefler

• Olaylara yanıt veren bir Chat uygulaması oluşturma
• Aşağıdakileri yaparak kullanıcıların olaylara yanıt vermesine yardımcı olun:
  • Olay müdahale alanları oluşturma.
  • Olayları ve yanıtları özetleyen mesajlar yayınlama
  • Etkileşimli sohbet uygulaması özellikleriyle ortak çalışmayı destekleme
• Vertex AI ile görüşmeleri ve çözümleri özetleyin.

Mimari

Aşağıdaki şemada, olay yanıtı Google Chat uygulaması tarafından kullanılan Google Workspace ve Google Cloud kaynaklarının mimarisi gösterilmektedir.

Mimari, olay yanıtı Google Chat uygulamasının bir olayı ve çözümü nasıl işlediğini gösterir.

1. Kullanıcı, Apps Script'te barındırılan harici bir web sitesinden olay başlatır.

2. Web sitesi, yine Apps Script'te barındırılan Google Chat uygulamasına eşzamansız bir HTTP isteği gönderir.

3. Olay yanıtlama Google Chat uygulaması isteği işler:

   1. Apps Script Yönetici SDK'sı hizmeti, kullanıcı kimliği ve e-posta adresi gibi ekip üyesi bilgilerini alır.

   2. Apps Script Gelişmiş Chat hizmetini kullanarak Chat API'ye bir dizi HTTP isteği gönderen olay yanıtı Google Chat uygulaması, bir olay Chat alanı oluşturur, alanı ekip üyeleriyle doldurur ve alana bir mesaj gönderir.

4. Ekip üyeleri, Chat alanında olayı tartışır.

5. Bir ekip üyesi, olayın çözüme ulaştırıldığını belirtmek için eğik çizgi komutunu kullanır.

   1. Apps Script Gelişmiş Chat hizmetini kullanarak Chat API'ye yapılan bir HTTP çağrısı, Chat alanının tüm mesajlarını listeler.

   2. Vertex AI, listelenen mesajları alır ve bir özet oluşturur.

   3. Apps Komut Dosyası DocumentApp hizmeti bir Dokümanlar belgesi oluşturur ve Vertex AI'nın özetini belgeye ekler.

   4. Olay yanıtı Google Chat uygulaması, özet Dokümanlar belgesinin bağlantısını paylaşan bir mesaj göndermek için Chat API'yi çağırır.

Ortamı hazırlama

Bu bölümde, Chat uygulaması için Google Cloud projesinin nasıl oluşturulacağı ve yapılandırılacağı gösterilmektedir.

Google Cloud projesi oluşturma

Google Cloud konsolu

1. Google Cloud Console'da Menü menu > IAM ve Yönetici > Proje Oluştur'a gidin.

   Proje Oluştur'a gidin

2. Proje Adı alanına projeniz için açıklayıcı bir ad girin.

   İsteğe bağlı: Proje kimliğini düzenlemek için Düzenle'yi tıklayın. Proje oluşturulduktan sonra proje kimliği değiştirilemez. Bu nedenle, projenin kullanım süresi boyunca ihtiyaçlarınızı karşılayacak bir kimlik seçin.

3. Projeniz için olası konumları görüntülemek üzere Konum alanında Göz at'ı tıklayın. Ardından Seç'i tıklayın.
4. Oluştur'u tıklayın. Google Cloud Console, Kontrol Paneli sayfasına gider ve projeniz birkaç dakika içinde oluşturulur.

gcloud CLI

Aşağıdaki geliştirme ortamlarından birinde Google Cloud CLI'ye (gcloud) erişin:

• Cloud Shell: gcloud CLI'si önceden ayarlanmış bir internet terminali kullanmak için Cloud Shell'i etkinleştirin.
  Cloud Shell'i etkinleştirme
• Yerel Kabuk: Yerel bir geliştirme ortamı kullanmak için gcloud CLI'yi yükleyin ve başlatın.
  Cloud projesi oluşturmak için gcloud projects create komutunu kullanın:

  gcloud projects create PROJECT_ID

  Oluşturmak istediğiniz projenin kimliğini ayarlayarak PROJECT_ID değerini değiştirin.

Cloud projesi için faturalandırmayı etkinleştirme

Google Cloud konsolu

1. Google Cloud Console'da Faturalandırma'ya gidin. Menü menu > Faturalandırma > Projelerim'i tıklayın.

   Projelerim için Faturalandırma'ya gidin

2. Kuruluş seçin bölümünde, Google Cloud projenizle ilişkili kuruluşu seçin.
3. Proje satırında İşlemler menüsünü (more_vert) açın, Faturalandırmayı değiştir'i tıklayın ve Cloud Billing hesabını seçin.
4. Hesap belirle'yi tıklayın.

gcloud CLI

1. Mevcut faturalandırma hesaplarını listelemek için şu komutu çalıştırın:

   gcloud billing accounts list

2. Bir faturalandırma hesabını Google Cloud projesine bağlama:

   gcloud billing projects link PROJECT_ID --billing-account=BILLING_ACCOUNT_ID

   Aşağıdakini değiştirin:

   • PROJECT_ID, faturalandırmayı etkinleştirmek istediğiniz Cloud projesinin proje kimliğidir.
   • BILLING_ACCOUNT_ID, Google Cloud projesine bağlanacak faturalandırma hesabı kimliğidir.

API'leri etkinleştirme

Kimlik doğrulama ve yetkilendirme ayarlarını yapma

Chat uygulaması, Chat uygulamasının kimlik bilgilerini kullanarak Google Chat API'ye erişir. Uygulama, Admin SDK API'ye ve Google Docs API'ye kullanıcı kimlik bilgileriyle erişiyor.

Kullanıcı kimlik doğrulamasını ve yetkilendirmeyi ayarlama

Kimlik doğrulama ve yetkilendirme, Chat uygulamasının bir olay yanıtını işlemek için Google Workspace ve Google Cloud'daki kaynaklara erişmesine olanak tanır. Özellikle, Google Docs API ve Yönetici SDK API'sini çağırmak için kullanıcı kimlik doğrulaması kullanılır.

Bu eğitimde, uygulamayı Workspace alanınıza dahili olarak yayınlarsınız. Bu nedenle, yer tutucu bilgileri kullanmanız kabul edilir. Uygulamayı harici olarak yayınlamadan önce, izin ekranındaki yer tutucu bilgileri gerçek bilgilerle değiştirin.

1. Google Cloud Console'da Menü menu > > Markalaşma'ya gidin.

   Markalama'ya gidin

2. 'ü daha önce yapılandırdıysanız Marka, Kitle ve Veri Erişimi'nde aşağıdaki OAuth izin ekranı ayarlarını yapılandırabilirsiniz. Henüz yapılandırılmadı yazan bir mesaj görürseniz Başlayın'ı tıklayın:

   1. Uygulama Bilgileri bölümündeki Uygulama adı alanına Incident Management yazın.
   2. Kullanıcı desteği e-postası bölümünde e-posta adresinizi veya uygun bir Google grubunu seçin.
   3. İleri'yi tıklayın.
   4. Kitle bölümünde Dahili'yi seçin. Dahili'yi seçemiyorsanız Harici'yi seçin.
   5. İleri'yi tıklayın.
   6. İletişim bilgileri bölümünde, projenizde yapılan değişikliklerle ilgili bildirim alabileceğiniz bir e-posta adresi girin.
   7. İleri'yi tıklayın.
   8. Son bölümünde Google API Hizmetleri Kullanıcı Verileri Politikası'nı inceleyin ve kabul ediyorsanız Google API Hizmetleri: Kullanıcı Verileri Politikası'nı kabul ediyorum'u seçin.
   9. Devam'ı tıklayın.
   10. Oluştur'u tıklayın.
   11. Kullanıcı türü için Harici'yi seçtiyseniz test kullanıcıları ekleyin:
       1. Kitle'yi tıklayın.
       2. Test kullanıcıları bölümünde Kullanıcı ekle'yi tıklayın.
       3. E-posta adresinizi ve diğer yetkili test kullanıcılarını girip Kaydet'i tıklayın.

3. Veri Erişimi > Kapsam Ekle veya Kaldır'ı tıklayın. Google Cloud projenizde etkinleştirdiğiniz her API'nin kapsamlarının listesini içeren bir panel görünür.

   1. Kapsamları manuel olarak ekle bölümüne aşağıdaki kapsamları yapıştırın:

      • 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

   2. Tabloya ekle'yi tıklayın.

   3. Güncelle'yi tıklayın.

   4. Uygulamanızın gerektirdiği kapsamları seçtikten sonra Veri Erişimi sayfasında Kaydet'i tıklayın.

Uygulama kimlik doğrulamasını ve yetkilendirmesini ayarlama

Uygulama Kimlik Doğrulaması, Google Chat API'yi çağırmak için kullanılır.

Google Cloud Console'da hizmet hesabı oluşturma

Hizmet hesabı oluşturmak için aşağıdaki adımları uygulayın:

Google Cloud konsolu

1. Google Cloud Console'da Menü menu > IAM ve Yönetici > Hizmet Hesapları'na gidin.

   Hizmet Hesaplarına gidin

2. Hizmet hesabı oluştur'u tıklayın.
3. Hizmet hesabı ayrıntılarını girip Oluştur ve devam et'i tıklayın.
4. İsteğe bağlı: Google Cloud projenizin kaynaklarına erişim izni vermek için hizmet hesabınıza rol atayın. Daha fazla bilgi için Kaynaklara erişim verme, erişimi değiştirme ve iptal etme başlıklı makaleyi inceleyin.
5. Devam'ı tıklayın.
6. İsteğe bağlı: Bu hizmet hesabını yönetebilecek ve bu hesapta işlem yapabilecek kullanıcıları veya grupları girin. Daha fazla bilgi için Hizmet hesabı kimliğine bürünmeyi yönetme başlıklı makaleyi inceleyin.
7. Bitti'yi tıklayın. Hizmet hesabının e-posta adresini not edin.

gcloud CLI

1. Hizmet hesabını oluşturun:

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
     --display-name="SERVICE_ACCOUNT_NAME"

2. İsteğe bağlı: Google Cloud projenizin kaynaklarına erişim izni vermek için hizmet hesabınıza rol atayın. Daha fazla bilgi için Kaynaklara erişim verme, erişimi değiştirme ve iptal etme başlıklı makaleyi inceleyin.

Hizmet hesabı, hizmet hesabı sayfasında görünür. Ardından, hizmet hesabı için özel anahtar oluşturun.

Özel anahtar oluşturma

Hizmet hesabı için özel anahtar oluşturmak ve indirmek üzere aşağıdaki adımları uygulayın:

1. Google Cloud Console'da Menü menu > IAM ve Yönetici > Hizmet Hesapları'na gidin.

   Hizmet Hesaplarına gidin

2. Hizmet hesabınızı seçin.
3. Anahtarlar > Anahtar ekle > Yeni anahtar oluştur'u tıklayın.
4. JSON'u seçip Oluştur'u tıklayın.

   Yeni herkese açık/özel anahtar çiftiniz oluşturulur ve makinenize yeni bir dosya olarak indirilir. İndirilen JSON dosyasını çalışma dizininizde credentials.json olarak kaydedin. Bu dosya, bu anahtarın tek kopyasıdır. Anahtarınızı güvenli şekilde nasıl depolayacağınız hakkında bilgi edinmek için Hizmet hesabı anahtarlarını yönetme başlıklı makaleyi inceleyin.

5. Kapat'ı tıklayın.

Hizmet hesapları hakkında daha fazla bilgi için Google Cloud IAM belgelerindeki hizmet hesapları bölümüne bakın.

Google Workspace Marketplace ile uyumlu bir OAuth istemcisi oluşturma

Google Workspace Marketplace ile uyumlu bir OAuth istemcisi oluşturmak için aşağıdaki adımları uygulayın:

1. Google Cloud Console'da Menü menu > IAM ve Yönetici > Hizmet Hesapları'na gidin.

   Hizmet Hesaplarına gidin

2. Chat uygulamanız için oluşturduğunuz hizmet hesabını tıklayın.

3. Gelişmiş ayarlar'ı tıklayın.

4. Google Workspace Marketplace uyumlu OAuth istemcisi oluştur'u tıklayın.

5. Devam'ı tıklayın.

Google Workspace Marketplace ile uyumlu bir OAuth istemcisinin oluşturulduğunu belirten bir onay mesajı görünür.

Chat uygulamasını oluşturma ve dağıtma

Aşağıdaki bölümde, Chat uygulamanız için gerekli tüm uygulama kodunu içeren bir Apps Script projesinin tamamını kopyalayıp güncelleyebilirsiniz. Bu nedenle, her dosyayı kopyalayıp yapıştırmanıza gerek yoktur.

Bazı işlevlerin adlarının sonuna alt çizgi eklenir (ör. ChatApp.gs'dan processSlashCommand_()). Alt çizgi, işlevi tarayıcıda açıkken olay başlatma web sayfasından gizler. Daha fazla bilgi için Gizli işlevler konusuna göz atın.

Apps Komut Dosyası, .gs komut dosyaları ve .html dosyalarının iki dosya türünü destekler. Bu desteğe uymak için uygulamanın istemci tarafı JavaScript'i <script /> etiketlerinin içine, CSS'si ise bir HTML dosyasının içindeki <style /> etiketlerinin içine dahil edilir.

İsterseniz projenin tamamını GitHub'da görüntüleyebilirsiniz.

GitHub'da göster

Her dosyaya genel bakış aşağıda verilmiştir:

Consts.gs

Cloud proje kimliğiniz, Vertex AI konum kimliğiniz, hizmet hesabı için uygulama kimlik bilgileri ve bir olayı kapatmak için eğik çizgi komut kimliği dahil olmak üzere diğer kod dosyalarının referans verdiği sabitleri tanımlar.

Consts.gs kodunu görüntüleme

apps-script/incident-response-app-auth/Consts.gs

GitHub'da göster

const PROJECT_ID = 'replace-with-your-project-id';
const CLOSE_INCIDENT_COMMAND_ID = 1;
const APP_CREDENTIALS = 'replace-with-your-app-credentials';
const APP_CREDENTIALS_SCOPES = 'https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.app.spaces.create';
const VERTEX_AI_LOCATION_ID = 'us-central1';
const MODEL_ID = 'gemini-1.5-flash-002';

ChatApp.gs

Mesajlar, kart tıklamaları, eğik çizgiyle başlayan komutlar ve iletişim kutuları dahil olmak üzere sohbet etkileşimi etkinliklerini işler. Olay çözümü ayrıntılarını toplamak için bir iletişim kutusu açarak /closeIncident eğik çizgi komutuna yanıt verir. Chat API'deki spaces.messages.list yöntemini çağırarak alandaki mesajları okur. Apps Komut Dosyası'nda Admin SDK Directory hizmetini kullanarak kullanıcı kimliklerini alır.

ChatApp.gs kodunu görüntüleme

apps-script/incident-response-app-auth/ChatApp.gs

GitHub'da göster

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * This app only responds to a slash command with the ID 1 ("/closeIncident").
 * It will respond to any other message with a simple "Hello" text message.
 *
 * @param {Object} event the event object from Google Chat
 */
function onMessage(event) {
  if (event.message.slashCommand) {
    return processSlashCommand_(event);
  }
  return { "text": "Hello from Incident Response app!" };
}

/**
 * Responds to a CARD_CLICKED event in Google Chat.
 *
 * This app only responds to one kind of dialog (Close Incident).
 *
 * @param {Object} event the event object from Google Chat
 */
function onCardClick(event) {
  if (event.isDialogEvent) {
    if (event.dialogEventType == 'SUBMIT_DIALOG') {
      return processSubmitDialog_(event);
    }
    return {
      actionResponse: {
        type: "DIALOG",
        dialogAction: {
          actionStatus: "OK"
        }
      }
    };
  }
}

/**
 * Responds to a MESSAGE event with a Slash command in Google Chat.
 *
 * This app only responds to a slash command with the ID 1 ("/closeIncident")
 * by returning a Dialog.
 *
 * @param {Object} event the event object from Google Chat
 */
function processSlashCommand_(event) {
  if (event.message.slashCommand.commandId != CLOSE_INCIDENT_COMMAND_ID) {
    return {
      "text": "Command not recognized. Use the command `/closeIncident` to close the incident managed by this space."
    };
  }
  const sections = [
    {
      header: "Close Incident",
      widgets: [
        {
          textInput: {
            label: "Please describe the incident resolution",
            type: "MULTIPLE_LINE",
            name: "description"
          }
        },
        {
          buttonList: {
            buttons: [
              {
                text: "Close Incident",
                onClick: {
                  action: {
                    function: "closeIncident"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ];
  return {
    actionResponse: {
      type: "DIALOG",
      dialogAction: {
        dialog: {
          body: {
            sections,
          }
        }
      }
    }
  };
}

/**
 * Responds to a CARD_CLICKED event with a Dialog submission in Google Chat.
 *
 * This app only responds to one kind of dialog (Close Incident).
 * It creates a Doc with a summary of the incident information and posts a message
 * to the space with a link to the Doc.
 *
 * @param {Object} event the event object from Google Chat
 */
function processSubmitDialog_(event) {
  const resolution = event.common.formInputs.description[""].stringInputs.value[0];
  const chatHistory = concatenateAllSpaceMessages_(event.space.name);
  const chatSummary = summarizeChatHistory_(chatHistory);
  const docUrl = createDoc_(event.space.displayName, resolution, chatHistory, chatSummary);
  return {
    actionResponse: {
      type: "NEW_MESSAGE",
    },
    text: `Incident closed with the following resolution: ${resolution}\n\nHere is the automatically generated post-mortem:\n${docUrl}`
  };
}

/**
 * Lists all the messages in the Chat space, then concatenate all of them into
 * a single text containing the full Chat history.
 *
 * For simplicity for this demo, it only fetches the first 100 messages.
 *
 * Messages with slash commands are filtered out, so the returned history will
 * contain only the conversations between users and not app command invocations.
 *
 * @return {string} a text containing all the messages in the space in the format:
 *          Sender's name: Message
 */
function concatenateAllSpaceMessages_(spaceName) {
  // Call Chat API method spaces.messages.list
  const response = Chat.Spaces.Messages.list(spaceName, { 'pageSize': 100 });
  const messages = response.messages;
  // Fetch the display names of the message senders and returns a text
  // concatenating all the messages.
  let userMap = new Map();
  return messages
    .filter(message => message.slashCommand === undefined)
    .map(message => `${getUserDisplayName_(userMap, message.sender.name)}: ${message.text}`)
    .join('\n');
}

/**
 * Obtains the display name of a user by using the Admin Directory API.
 *
 * The fetched display name is cached in the provided map, so we only call the API
 * once per user.
 *
 * If the user does not have a display name, then the full name is used.
 *
 * @param {Map} userMap a map containing the display names previously fetched
 * @param {string} userName the resource name of the user
 * @return {string} the user's display name
 */
function getUserDisplayName_(userMap, userName) {
  if (userMap.has(userName)) {
    return userMap.get(userName);
  }
  let displayName = 'Unknown User';
  try {
    const user = AdminDirectory.Users.get(
      userName.replace("users/", ""),
      { projection: 'BASIC', viewType: 'domain_public' });
    displayName = user.name.displayName ? user.name.displayName : user.name.fullName;
  } catch (e) {
    // Ignore error if the API call fails (for example, because it's an
    // out-of-domain user or Chat app)) and just use 'Unknown User'.
  }
  userMap.set(userName, displayName);
  return displayName;
}

ChatSpaceCreator.gs

Kullanıcıların olay başlatma web sayfasına girdikleri form verilerini alır ve bu verileri kullanarak bir Chat alanı oluşturup doldurur ve ardından olayla ilgili bir mesaj yayınlar.

ChatSpaceCreator.gs kodunu görüntüleme

apps-script/incident-response-app-auth/ChatSpaceCreator.gs

GitHub'da göster

/**
 * Handles an incident by creating a chat space, adding members, and posting a message.
 * All the actions are done using application credentials.
 *
 * @param {Object} formData - The data submitted by the user. It should contain the fields:
 *                           - title: The display name of the chat space.
 *                           - description: The description of the incident.
 *                           - users: A comma-separated string of user emails to be added to the space.
 * @return {string} The resource name of the new space.
 */
function handleIncident(formData) {
  const users = formData.users.trim().length > 0 ? formData.users.split(',') : [];
  const service = getService_();
  if (!service.hasAccess()) {
    console.error(service.getLastError());
    return;
   }
  const spaceName = createChatSpace_(formData.title, service);
  createHumanMembership_(spaceName, getUserEmail(), service);
  for (const user of users ){
    createHumanMembership_(spaceName, user, service);
  }
  createMessage_(spaceName, formData.description, service);
  return spaceName;
}
/**
 * Creates a chat space with application credentials.
 *
 * @param {string} displayName - The name of the chat space.
 * @param {object} service - The credentials of the service account.
 * @returns {string} The resource name of the new space.
*/
function createChatSpace_(displayName, service) {
  try {
    // For private apps, the alias can be used
    const my_customer_alias = "customers/my_customer";
    // Specify the space to create.
    const space = {
        displayName: displayName,
        spaceType: 'SPACE',                
        customer: my_customer_alias
    };
    // Call Chat API with a service account to create a message.
    const createdSpace = Chat.Spaces.create(
        space,
        {},
        // Authenticate with the service account token.
        {'Authorization': 'Bearer ' + service.getAccessToken()});
    return createdSpace.name;
  } catch (err) {
    // TODO (developer) - Handle exception.
    console.log('Failed to create space with error %s', err.message);
  }
}
/*
 * Creates a chat message with application credentials.
 *
 * @param {string} spaceName - The resource name of the space.
 * @param {string} message - The text to be posted.
 * @param {object} service - The credentials of the service account.
 * @return {string} the resource name of the new space.
 */
function createMessage_(spaceName, message, service) {
  try {
    // Call Chat API with a service account to create a message.
    const result = Chat.Spaces.Messages.create(
        {'text': message},
        spaceName,
        {},
        // Authenticate with the service account token.
        {'Authorization': 'Bearer ' + service.getAccessToken()});

  } catch (err) {
    // TODO (developer) - Handle exception.
    console.log('Failed to create message with error %s', err.message);
  }
}
/**
 * Creates a human membership in a chat space with application credentials.
 *
 * @param {string} spaceName - The resource name of the space.
 * @param {string} email - The email of the user to be added.
 * @param {object} service - The credentials of the service account.
 */
function createHumanMembership_(spaceName, email, service){
  try{
    const membership = {
      member: {
        name: 'users/'+email,
        // User type for the membership
        type: 'HUMAN'
      }
    };
    const result = Chat.Spaces.Members.create(
      membership,
      spaceName,
      {},
      {'Authorization': 'Bearer ' + service.getAccessToken()}
    );
  } catch (err){
    console.log('Failed to create membership with error %s', err.message)
  }

}

 /*
 * Creates a service for the service account.
 * @return {object}  - The credentials of the service account.
 */
function getService_() {
  return OAuth2.createService(APP_CREDENTIALS.client_email)
      .setTokenUrl('https://oauth2.googleapis.com/token')
      .setPrivateKey(APP_CREDENTIALS.private_key)
      .setIssuer(APP_CREDENTIALS.client_email)
      .setSubject(APP_CREDENTIALS.client_email)
      .setScope(APP_CREDENTIALS_SCOPES)
      .setPropertyStore(PropertiesService.getScriptProperties());
}

DocsApi.gs

Kullanıcının Google Drive'ında bir Google Dokümanlar dokümanı oluşturmak için Google Dokümanlar API'yi çağırır ve VertexAiApi.gs içinde oluşturulan olay bilgilerinin özetini dokümana yazar.

DocsApi.gs kodunu görüntüleme

apps-script/incident-response-app-auth/DocsApi.gs

GitHub'da göster

/**
 * Creates a Doc in the user's Google Drive and writes a summary of the incident information to it.
 *
 * @param {string} title The title of the incident
 * @param {string} resolution Incident resolution described by the user
 * @param {string} chatHistory The whole Chat history be included in the document
 * @param {string} chatSummary A summary of the Chat conversation to be included in the document
 * @return {string} the URL of the created Doc
 */
function createDoc_(title, resolution, chatHistory, chatSummary) {
  let doc = DocumentApp.create(title);
  let body = doc.getBody();
  body.appendParagraph(`Post-Mortem: ${title}`).setHeading(DocumentApp.ParagraphHeading.TITLE);
  body.appendParagraph("Resolution").setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(resolution);
  body.appendParagraph("Summary of the conversation").setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(chatSummary);
  body.appendParagraph("Full Chat history").setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(chatHistory);
  return doc.getUrl();
}

VertexAiApi.gs

Vertex AI API'yi kullanarak Chat alanındaki görüşmeyi özetler. Bu özet, DocsAPI.gs adresinde özel olarak oluşturulmuş bir dokümanda yayınlanır.

VertexAiApi.gs kodunu görüntüleme

apps-script/incident-response-app-auth/VertexAiApi.gs

GitHub'da göster

/**
 * Summarizes a Chat conversation using the Vertex AI text prediction API.
 *
 * @param {string} chatHistory The Chat history that will be summarized.
 * @return {string} The content from the text prediction response.
 */


function summarizeChatHistory_(chatHistory) {

  const API_ENDPOINT = `https://${VERTEX_AI_LOCATION_ID}-aiplatform.googleapis.com/v1/projects/${PROJECT_ID}/locations/${VERTEX_AI_LOCATION_ID}/publishers/google/models/${MODEL_ID}:generateContent`;
  const prompt = "Summarize the following conversation between Engineers resolving an incident"
      + " in a few sentences. Use only the information from the conversation.\n\n" + chatHistory;
  // Get the access token.
  const accessToken = ScriptApp.getOAuthToken();

  const headers = {
    'Authorization': 'Bearer ' + accessToken,
    'Content-Type': 'application/json',
  };
  const payload = {
    'contents': {
      'role': 'user',
      'parts' : [
        {
          'text': prompt
        }
      ]
    }
  }
  const options = {
    'method': 'post',
    'headers': headers,
    'payload': JSON.stringify(payload),
    'muteHttpExceptions': true,
  };
  try {
    const response = UrlFetchApp.fetch(API_ENDPOINT, options);
    const responseCode = response.getResponseCode();
    const responseText = response.getContentText();

    if (responseCode === 200) {
      const jsonResponse = JSON.parse(responseText);
      console.log(jsonResponse)
      if (jsonResponse.candidates && jsonResponse.candidates.length > 0) {
        return jsonResponse.candidates[0].content.parts[0].text; // Access the summarized text
      } else {
        return "No summary found in response.";
      }

    } else {
      console.error("Vertex AI API Error:", responseCode, responseText);
      return `Error: ${responseCode} - ${responseText}`;
    }
  } catch (e) {
    console.error("UrlFetchApp Error:", e);
    return "Error: " + e.toString();
  }
}

WebController.gs

Olay başlatma web sitesini sunar.

WebController.gs kodunu görüntüleme

apps-script/incident-response-app-auth/WebController.gs

GitHub'da göster

/**
 * Serves the web page from Index.html.
 */
function doGet() {
  return HtmlService
    .createTemplateFromFile('Index')
    .evaluate();
}

/**
 * Serves the web content from the specified filename.
 */
function include(filename) {
  return HtmlService
    .createHtmlOutputFromFile(filename)
    .getContent();
}

/**
 * Returns the email address of the user running the script.
 */
function getUserEmail() {
  return Session.getActiveUser().getEmail();
}

Index.html

Olay başlatma web sitesini içeren HTML.

Index.html kodunu görüntüleme

apps-script/incident-response-app-auth/Index.html

GitHub'da göster

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <link href='https://fonts.googleapis.com/css?family=Roboto' rel='stylesheet'>
    <?!= include('Stylesheet'); ?>
  </head>
  <body>
    <div class="container">
      <div class="content">
        <h1>Incident Manager</h1>
        <form id="incident-form" onsubmit="handleFormSubmit(this)">
          <div id="form">
            <p>
              <label for="title">Incident title</label><br/>
              <input type="text" name="title" id="title" />
            </p>
            <p>
              <label for="users">Incident responders</label><br/>
              <small>
                Please enter a comma-separated list of email addresses of the users
                that should be added to the space.
                Do not include <?= getUserEmail() ?> as it will be added automatically.
              </small><br/>
              <input type="text" name="users" id="users" />
            </p>
            <p>
              <label for="description">Initial message</label></br>
              <small>This message will be posted after the space is created.</small><br/>
              <textarea name="description" id="description"></textarea>
            </p>
            <p class="text-center">
              <input type="submit" value="CREATE CHAT SPACE" />
            </p>
          </div>
          <div id="output" class="hidden"></div>
          <div id="clear" class="hidden">
            <input type="reset" value="CREATE ANOTHER INCIDENT" onclick="onReset()" />
          </div>
        </form>
      </div>
    </div>
    <?!= include('JavaScript'); ?>
  </body>
</html>

JavaScript.html

Olay başlatma web sitesi için gönderimler, hatalar ve temizlemeler dahil olmak üzere form davranışını işler. WebController.gs içindeki özel include işlevi tarafından Index.html içine dahil edilir.

JavaScript.html kodunu görüntüleme

apps-script/incident-response-app-auth/JavaScript.html

GitHub'da göster

<script>
  var formDiv = document.getElementById('form');
  var outputDiv = document.getElementById('output');
  var clearDiv = document.getElementById('clear');

  function handleFormSubmit(formObject) {
    event.preventDefault();
    outputDiv.innerHTML = 'Please wait while we create the space...';
    hide(formDiv);
    show(outputDiv);
    google.script.run
      .withSuccessHandler(updateOutput)
      .withFailureHandler(onFailure)
      .handleIncident(formObject);
  }

  function updateOutput(response) {
    var spaceId = response.replace('spaces/', '');
    outputDiv.innerHTML =
      '<p>Space created!</p><p><a href="https://mail.google.com/chat/#chat/space/'
        + spaceId
        + '" target="_blank">Open space</a></p>';
    show(outputDiv);
    show(clearDiv);
  }

  function onFailure(error) {
    outputDiv.innerHTML = 'ERROR: ' + error.message;
    outputDiv.classList.add('error');
    show(outputDiv);
    show(clearDiv);
  }

  function onReset() {
    outputDiv.innerHTML = '';
    outputDiv.classList.remove('error');
    show(formDiv);
    hide(outputDiv);
    hide(clearDiv);
  }

  function hide(element) {
    element.classList.add('hidden');
  }

  function show(element) {
    element.classList.remove('hidden');
  }
</script>

Stylesheet.html

Olay başlatma web sitesinin CSS'si. WebController.gs içindeki özel include işlevi tarafından Index.html içine dahil edilir.

Stylesheet.html kodunu görüntüleme

apps-script/incident-response-app-auth/Stylesheet.html

GitHub'da göster

<style>
  * {
    box-sizing: border-box;
  }
  body {
    font-family: Roboto, Arial, Helvetica, sans-serif;
  }
  div.container {
    display: flex;
    justify-content: center;
    align-items: center;
    position: absolute;
    top: 0; bottom: 0; left: 0; right: 0;
  }
  div.content {
    width: 80%;
    max-width: 1000px;
    padding: 1rem;
    border: 1px solid #999;
    border-radius: 0.25rem;
    box-shadow: 0 2px 2px 0 rgba(66, 66, 66, 0.08), 0 2px 4px 2px rgba(66, 66, 66, 0.16);
  }
  h1 {
    text-align: center;
    padding-bottom: 1rem;
    margin: 0 -1rem 1rem -1rem;
    border-bottom: 1px solid #999;
  }
 #output {
    text-align: center;
    min-height: 250px;
  }
  div#clear {
    text-align: center;
    padding-top: 1rem;
    margin: 1rem -1rem 0 -1rem;
    border-top: 1px solid #999;
  }
  input[type=text], textarea {
    width: 100%;
    padding: 1rem 0.5rem;
    margin: 0.5rem 0;
    border: 0;
    border-bottom: 1px solid #999;
    background-color: #f0f0f0;
  }
  textarea {
    height: 5rem;
  }
  small {
    color: #999;
  }
  input[type=submit], input[type=reset] {
    padding: 1rem;
    border: none;
    background-color: #6200ee;
    color: #fff;
    border-radius: 0.25rem;
    width: 25%;
  }
  .hidden {
    display: none;
  }
  .text-center {
    text-align: center;
  }
  .error {
    color: red;
  }
</style>

Cloud proje numaranızı ve kimliğinizi bulma

1. Google Cloud Console'da Cloud projenize gidin.

   Google Cloud Console'a gidin

2. Ayarlar ve Yardımcı Programlar more_vert > Proje ayarları'nı tıklayın.

3. Proje numarası ve Proje kimliği alanlarındaki değerleri not edin. Bu bilgileri aşağıdaki bölümlerde kullanacaksınız.

Apps Komut Dosyası projesini oluşturma

Apps Komut Dosyası projesi oluşturmak ve bunu Cloud projenize bağlamak için:

1. Google Chat ile olaylara yanıt verme Apps Script projesini açmak için aşağıdaki düğmeyi tıklayın.
   Projeyi açma
2. info_outline Genel Bakış'ı tıklayın.
3. Genel bakış sayfasında Kopya oluştur'u tıklayın.

4. Apps Komut Dosyası projesinin kopyanıza bir ad verin:

   1. Google Chat ile olaylara yanıt verme başlıklı makalenin kopyasını tıklayın.

   2. Proje başlığı'na Incident Management Chat app yazın.

   3. Yeniden adlandır'ı tıklayın.

5. Apps Komut Dosyası projesinin kopyasında Consts.gs dosyasına gidin ve YOUR_PROJECT_ID yerine Cloud projenizin kimliğini yazın.

Apps Komut Dosyası projesinin Cloud projesini ayarlama

1. Apps Komut Dosyası projenizde Proje Ayarları'nı tıklayın.
2. Google Cloud Platform (GCP) Projesi bölümünde Projeyi değiştir'i tıklayın.
3. GCP proje numarası alanına Cloud projenizin proje numarasını yapıştırın.
4. Proje ayarla'yı tıklayın. Cloud projesi ve Apps Komut Dosyası projesi artık bağlıdır.

Apps Komut Dosyası dağıtımı oluşturma

Tüm kod eklendiğinden Apps Komut Dosyası projesini dağıtın. Dağıtım kimliğini, Google Cloud'da Chat uygulamasını yapılandırırken kullanırsınız.

1. Apps Komut Dosyası'nda olay yanıtlama uygulamasının projesini açın.

   Apps Komut Dosyası'na gidin

2. Dağıt > Yeni dağıtım'ı tıklayın.

3. Eklenti ve Web uygulaması henüz seçilmemişse Türü seç'in yanındaki dağıtım türlerini tıklayın ve Eklenti ile Web uygulaması'nı seçin.

4. Açıklama alanına bu sürüm için bir açıklama girin (ör. Complete version of incident management app).

5. Yürütme bölümünde Web uygulamasına erişen kullanıcı'yı seçin.

6. Erişimi olan kullanıcılar bölümünde Workspace kuruluşunuzdaki herkes'i seçin. Buradaki "Workspace kuruluşunuz", Google Workspace kuruluşunuzun adıdır.

7. Dağıt'ı tıklayın. Apps Script, başarılı dağıtımı bildirir ve olay başlatma web sayfası için bir dağıtım kimliği ve URL sağlar.

8. Daha sonra bir olay başlattığınızda ziyaret etmek için web uygulaması URL'sini not edin. Dağıtım kimliğini kopyalayın. Bu kimliği, Google Cloud Console'da Chat uygulamasını yapılandırırken kullanırsınız.

9. Bitti'yi tıklayın.

Google Cloud Console'da Chat uygulamasını yapılandırma

Bu bölümde, Google Cloud Console'da Google Chat API'nin, Apps Script projenizden yeni oluşturduğunuz dağıtımın kimliği de dahil olmak üzere Chat uygulamanızla ilgili bilgilerle nasıl yapılandırılacağı gösterilmektedir.

1. Google Cloud Console'da Menü menu > Diğer ürünler > Google Workspace > Ürün Kitaplığı > Google Chat API > Yönet > Yapılandırma'yı tıklayın.

   Chat API yapılandırmasına gidin

2. Uygulama adı alanına Incident Management yazın.

3. Avatar URL'si alanına https://developers.google.com/chat/images/quickstart-app-avatar.png yazın.

4. Açıklama alanına Responds to incidents. yazın.

5. Etkileşimli özellikleri etkinleştir açma/kapatma düğmesini açık konuma getirin.

6. İşlevsellik bölümünde 1:1 mesaj alma, Alanlara ve grup görüşmelerine katılma'yı seçin.

7. Bağlantı ayarları bölümünde Apps Komut Dosyası'nı seçin.

8. Dağıtım Kimliği alanına, daha önce Apps Komut Dosyası proje dağıtımından kopyaladığınız Apps Komut Dosyası dağıtım kimliğini yapıştırın.

9. Tam olarak uygulanmış Chat uygulamasının kullandığı bir eğik çizgiyle başlayan komut kaydedin:

   1. Komutlar bölümünde Komut ekle'yi tıklayın.

   2. Komut kimliği alanına 1 yazın.

   3. Açıklama alanına Closes the incident being discussed in the space. yazın

   4. Komut türü bölümünde Eğik çizgi komutu'nu seçin.

   5. Eğik çizgi komutu adı alanına /closeIncident yazın.

   6. İletişim kutusu açar'ı seçin.

   7. Bitti'yi tıklayın. Eğik çizgi komutu kayıtlı ve listelenir.

10. Görünürlük bölümünde Bu Chat uygulamasını Workspace Alanınızdaki belirli kişilere ve gruplara sun'u seçin ve e-posta adresinizi girin.

11. Günlükler bölümünde Günlük hatalarını Günlüğe kaydet'i seçin.

12. Kaydet'i tıklayın. Yapılandırmanın kaydedildiği mesajı gösterilir. Bu, uygulamanın test edilmeye hazır olduğu anlamına gelir.

Yönetici onayı alma

Yönetici onayı almak için Google Workspace Marketplace SDK'sında Chat uygulamasını yapılandırmanız gerekir.

Google Workspace Marketplace SDK'sında Chat uygulamasını yapılandırma

Google Workspace Marketplace SDK'sında Chat uygulamasını yapılandırmak için aşağıdaki adımları uygulayın:

1. Google Cloud Console'da Menü menu > API'ler ve Hizmetler > Etkin API'ler ve hizmetler > Google Workspace Marketplace SDK'sı > Uygulama Yapılandırması'na gidin.

   Uygulama Yapılandırması'na gidin

2. Uygulama Yapılandırması sayfasını tamamlayın. Sohbet uygulamanızı nasıl yapılandıracağınız, hedef kitlenizin kim olduğuna ve diğer faktörlere bağlıdır. Uygulama yapılandırma sayfasını doldurma hakkında yardım için Google Workspace Marketplace SDK'sında uygulamanızı yapılandırma başlıklı makaleyi inceleyin. Bu kılavuzun amaçları doğrultusunda aşağıdaki bilgileri girin:

   1. Uygulama görünürlüğü bölümünde Gizli'yi seçin.
   2. Yükleme ayarları bölümünde Yönetici yükleme'yi seçin.
   3. Uygulama entegrasyonları bölümünde Chat uygulaması'nı seçin.
   4. OAuth kapsamları bölümünde aşağıdaki kapsamları girin:
      • https://www.googleapis.com/auth/chat.app.spaces
      • https://www.googleapis.com/auth/chat.app.memberships
   5. Geliştirici bilgileri bölümünde Geliştirici adınızı, Geliştirici web sitesi URL'nizi ve Geliştirici e-postanızı girin.
   6. Taslağı kaydet'i tıklayın.

Uygulamayı yapılandırdıktan sonra mağaza girişini güncelleyin:

1. Google Cloud Console'da Menü > API'ler ve Hizmetler > Etkin API'ler ve hizmetler > Google Workspace Marketplace SDK'sı > Mağaza Girişi'ne gidin.
2. Uygulama ayrıntıları bölümünde, Kategori olarak Web Geliştirme'yi seçin.
3. Grafik Öğeleri bölümünde, uygulama simgelerini istenen biçimlerde yükleyin.
4. Ekran görüntüleri bölümüne uygulamanın ekran görüntüsünü yükleyin.
5. Destek Bağlantıları'na Hizmet Şartları URL'si, Gizlilik URL'si ve Destek URL'si girin.
6. Dağıtım bölümünde, bu uygulamanın kullanıma sunulacağı bölgeleri seçin.
7. Yayınla'yı tıklayın.

Yönetici onayı alma

Hizmet hesabınız yönetici onayı alacak şekilde yapılandırıldı. Chat uygulamaları için yetkilendirmeyi ayarlama başlıklı makaledeki adımları uygulayarak onay verebilecek bir Google Workspace yöneticisinden onay alın.

Chat uygulamasını test etme

Olay yönetimi Chat uygulamasını test etmek için web sayfasından bir olay başlatın ve Chat uygulamasının beklendiği gibi çalıştığını doğrulayın:

1. Apps Komut Dosyası dağıtım web uygulaması URL'sine gidin.

2. Apps Komut Dosyası verilerinize erişmek için izin istediğinde İzinleri incele'yi tıklayın, Google Workspace alanınızda uygun bir Google Hesabı ile oturum açın ve İzin ver'i tıklayın.

3. Olay başlatma web sayfası açılır. Test bilgilerini girin:

   1. Olay başlığı alanına The First Incident yazın.
   2. İsteğe bağlı olarak Olay yanıtlayıcıları bölümüne, olay yanıtlayıcı arkadaşlarınızın e-posta adreslerini girin. Kullanıcıların, Google Workspace kuruluşunuzda Google Chat hesabı olmalıdır. Aksi takdirde alan oluşturma işlemi başarısız olur. Otomatik olarak dahil edildiği için kendi e-posta adresinizi girmeyin.
   3. İlk mesaj alanına Testing the incident management Chat app. yazın

4. Sohbet alanı oluştur'u tıklayın. creating space mesajı görünür.

5. Alan oluşturulduktan sonra Space created! mesajı gösterilir. Alanı aç'ı tıklayın. Bu işlem, alanı Chat'te yeni bir sekmede açar.

6. İsteğe bağlı olarak, siz ve diğer olay müdahale ekipleri alanda mesaj gönderebilirsiniz. Uygulama, bu mesajları Vertex AI'ı kullanarak özetler ve geriye dönük bir belge paylaşır.

7. Olay yanıtını sonlandırmak ve çözüm sürecini başlatmak için sohbet alanında /closeIncident yazın. Olay yönetimi iletişim kutusu açılır.

8. Olayı kapat bölümünde, olay çözümü için bir açıklama girin (ör. Test complete).

9. Incident'i (olay) kapat'ı tıklayın.

Olay Yönetimi uygulaması, alandaki mesajları listeler, Vertex AI ile özetler, özeti bir Google Dokümanlar belgesine yapıştırır ve belgeyi alanda paylaşır.

Temizleme

Bu eğiticide kullanılan kaynaklar için Google Cloud hesabınızın ücretlendirilmesini istemiyorsanız Cloud projesini silmenizi öneririz.

1. Google Cloud Console'da Kaynakları yönetin sayfasına gidin. Menü menu > IAM ve Yönetici > Kaynakları Yönet'i tıklayın.

   Resource Manager'a gidin

2. Proje listesinde, silmek istediğiniz projeyi seçin ve ardından Sil'i delete tıklayın.
3. İletişim kutusuna proje kimliğini yazın ve projeyi silmek için Kapat'ı tıklayın.

İlgili konular

• Gemini yapay zeka sohbet uygulamasıyla Chat sohbetlerine dayalı soruları yanıtlama
• Google Chat, Vertex AI ve Firestore ile projeleri yönetme
• Google Chat, Vertex AI ve Apps Komut Dosyası ile olaylara yanıt verme (Kullanıcı Kimlik Doğrulaması)
• Olay yanıtlama uygulaması, API'leri çağırmak ve Chat API ve Vertex AI API gibi Google Cloud hizmetlerini çağırmak için kullanıcı kimlik bilgileriyle kimlik doğrulaması yapar. Bu, bir olayı başlatan kullanıcının bu hizmetlere erişimi olması gerektiği anlamına gelir. Uygulamayı daha güçlü hale getirmek için /closeIncident eğik çizgi komutunu çağıran kullanıcının kimlik bilgileri yerine Vertex AI API'yi hizmet hesabıyla çağırabilirsiniz. Vertex AI API için bir hizmet hesabı yapılandırmaya dair yardım için Özel hizmet hesabı kullanma başlıklı makaleyi inceleyin.