Mengelola project dengan Google Chat, Vertex AI, dan Firestore

Tutorial ini menunjukkan cara membuat aplikasi Google Chat yang dapat digunakan tim untuk mengelola project secara real time. Aplikasi Chat menggunakan Vertex AI untuk membantu tim menulis cerita pengguna (yang mewakili fitur sistem software dari sudut pandang pengguna untuk dikembangkan oleh tim) dan mempertahankan cerita tersebut dalam database Firestore.

Prasyarat

• Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.

• Akses ke layanan Google Cloud untuk melakukan hal berikut:

  • Membuat project Google Cloud.
  • Tautkan akun penagihan Google Cloud ke project Cloud. Untuk mengetahui apakah Anda memiliki akses, lihat Izin yang diperlukan untuk mengaktifkan penagihan.

  • Gunakan pemanggilan Fungsi Google Cloud yang tidak diautentikasi, yang dapat Anda verifikasi dengan menentukan apakah organisasi Google Cloud Anda menggunakan berbagi yang dibatasi domain.

  Jika perlu, minta akses atau izin kepada administrator Google Cloud Anda.

• Jika menggunakan Google Cloud CLI, lingkungan pengembangan Node.js yang dikonfigurasi untuk berfungsi dengan gcloud CLI. Lihat Menyiapkan lingkungan pengembangan Node.js.

Tujuan

• Buat aplikasi Chat yang mengelola project software yang gesit.
• Bantu pengguna menulis cerita pengguna dengan alat penulisan cerita yang dibantu AI generatif yang didukung oleh Vertex AI:
  • Membuat dan membuat ulang deskripsi cerita.
  • Perluas deskripsi cerita dari catatan untuk memenuhi persyaratan.
  • Memperbaiki tata bahasa untuk memperbaiki kesalahan ketik.
• Menjaga agar pekerjaan tetap terbaru dengan menulis ke, dan membaca dari, database Firestore.
• Fasilitasi kolaborasi di ruang Chat dengan memungkinkan pengguna membuat, mengedit, menetapkan, dan memulai cerita langsung dari percakapan.

Produk yang digunakan

Aplikasi pengelolaan project menggunakan produk Google Workspace dan Google Cloud berikut:

• Chat API: API untuk mengembangkan aplikasi Google Chat yang menerima dan merespons peristiwa interaksi Chat, seperti pesan. Aplikasi Google Chat pengelolaan project menggunakan Chat API untuk menerima dan merespons peristiwa interaksi yang dikirim oleh Chat, dan untuk mengonfigurasi atribut yang menentukan cara munculnya di Chat, seperti nama dan gambar avatar.
• Vertex AI API: Platform AI generatif. Aplikasi Google Chat manajemen project menggunakan Vertex AI API untuk menulis judul dan deskripsi cerita pengguna.
• Firestore: Database dokumen serverless. Aplikasi Google Chat manajemen project menggunakan Firebase untuk menyimpan data tentang cerita pengguna.

• Cloud Functions: Layanan komputasi serverless yang ringan memungkinkan Anda membuat fungsi mandiri dengan tujuan tunggal yang dapat merespons peristiwa interaksi Chat tanpa perlu mengelola server atau lingkungan runtime. Aplikasi Google Chat pengelolaan project menggunakan Cloud Functions untuk menghosting endpoint HTTP yang menjadi tujuan pengiriman peristiwa interaksi oleh Chat dan sebagai platform komputasi untuk menjalankan logika yang memproses dan merespons peristiwa ini.

  Cloud Functions menggunakan produk Google Cloud berikut untuk mem-build, memproses peristiwa interaksi, dan menghosting resource komputasi:

  • Cloud Build: Platform continuous integration, penayangan, dan deployment yang terkelola sepenuhnya yang menjalankan build otomatis.
  • Pub/Sub: Layanan pesan asinkron dan skalabel yang memisahkan layanan yang menghasilkan pesan dari layanan yang memproses pesan tersebut.
  • Cloud Run Admin API: Lingkungan yang terkelola sepenuhnya untuk menjalankan aplikasi dalam container.

Arsitektur

Arsitektur aplikasi Google Chat pengelolaan project menerima dan memproses peristiwa interaksi Chat di endpoint HTTP, menggunakan Vertex AI untuk membantu menulis cerita pengguna, dan menyimpan detail cerita pengguna di database Firestore. Diagram berikut menunjukkan arsitektur resource Google Workspace dan Google Cloud yang digunakan.

Cara kerja aplikasi Google Chat pengelolaan project adalah seperti ini:

1. Pengguna mengirim pesan di Chat dan memanggil aplikasi Google Chat pengelolaan project dengan mengirim pesan langsung, menyebutkannya di ruang, atau memasukkan perintah garis miring.

2. Chat mengirimkan permintaan HTTP sinkron ke endpoint HTTP Cloud Function.

3. Aplikasi Google Chat pengelolaan project memproses permintaan HTTP:

   1. Vertex AI membantu menulis atau memperbarui cerita pengguna.

   2. Database Firestore menyimpan, mengambil, memperbarui, atau menghapus data cerita pengguna.

4. Cloud Functions menampilkan respons HTTP ke Chat yang menampilkannya kepada pengguna sebagai pesan atau dialog.

Menyiapkan lingkungan

Bagian ini menunjukkan cara membuat dan mengonfigurasi project Google Cloud untuk aplikasi Chat.

Membuat project Google Cloud

Konsol Google Cloud

1. Di konsol Google Cloud, buka Menu menu > IAM & Admin > Create a Project.

   Buka Membuat Project

2. Di kolom Project Name, masukkan nama deskriptif untuk project Anda.

   Opsional: Untuk mengedit Project ID, klik Edit. Project ID tidak dapat diubah setelah project dibuat. Jadi, pilih yang sesuai dengan kebutuhan Anda sepanjang waktu project tersebut.

3. Di kolom Location, klik Browse untuk menampilkan lokasi potensial untuk project Anda. Kemudian, klik Select.
4. Klik Buat. Konsol Google Cloud akan membuka halaman Dasbor dan project Anda akan dibuat dalam beberapa menit.

gcloud CLI

Di salah satu lingkungan pengembangan berikut, akses Google Cloud CLI (gcloud):

• Cloud Shell: Untuk menggunakan terminal online dengan gcloud CLI yang sudah disiapkan, aktifkan Cloud Shell.
  Aktifkan Cloud Shell
• Shell Lokal: Untuk menggunakan lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI.
  Untuk membuat project Cloud, gunakan perintah gcloud projects create:

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan menetapkan ID untuk project yang ingin Anda buat.

Mengaktifkan penagihan untuk project Cloud

Konsol Google Cloud

1. Di konsol Google Cloud, buka Billing. Klik Menu menu > Penagihan > Project Saya.

   Buka Penagihan untuk Project Saya

2. Di Pilih organisasi, pilih organisasi yang terkait dengan project Google Cloud Anda.
3. Di baris project, buka menu Actions (more_vert), klik Change billing, lalu pilih akun Penagihan Cloud.
4. Klik Tetapkan akun.

gcloud CLI

1. Untuk mencantumkan akun penagihan yang tersedia, jalankan:

   gcloud billing accounts list

2. Menautkan akun penagihan dengan project Google Cloud:

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

   Ganti kode berikut:

   • PROJECT_ID adalah Project ID untuk project Cloud yang penagihannya ingin Anda aktifkan.
   • BILLING_ACCOUNT_ID adalah ID akun penagihan yang akan ditautkan dengan project Google Cloud.

Mengaktifkan API

Autentikasi dan otorisasi

Tidak diperlukan konfigurasi autentikasi dan otorisasi untuk mengikuti tutorial ini.

Untuk memanggil Firestore dan Vertex AI API, tutorial ini menggunakan Kredensial Default Aplikasi dengan akun layanan default yang dilampirkan ke Cloud Function, yang tidak perlu Anda siapkan. Dalam konteks lingkungan produksi, Anda biasanya akan create dan melampirkan akun layanan ke Cloud Function.

Membuat dan men-deploy aplikasi Google Chat

Setelah project Google Cloud dibuat dan dikonfigurasi, Anda siap membangun dan men-deploy aplikasi Google Chat. Di bagian ini, Anda akan melakukan hal berikut:

1. Buat database Firestore untuk mempertahankan dan mengambil cerita pengguna.
2. Secara opsional, tinjau kode contoh.
3. Buat Cloud Function untuk menghosting dan menjalankan kode aplikasi Chat sebagai respons terhadap peristiwa yang diterima dari Chat sebagai permintaan HTTP.
4. Buat dan deploy aplikasi Google Chat di halaman konfigurasi Google Chat API.

Membuat database Firestore

Di bagian ini, Anda akan membuat database Firestore untuk mempertahankan dan mengambil cerita pengguna, tetapi Anda tidak menentukan model data. Model data ditetapkan secara implisit dalam kode contoh oleh file model/user-story.js dan model/user.js.

Database aplikasi Chat pengelolaan project menggunakan model data NoSQL berdasarkan dokumen class yang diatur ke dalam koleksi collections_bookmark. Untuk mempelajari lebih lanjut, lihat Model data Firestore.

Diagram berikut adalah ringkasan model data aplikasi Google Chat pengelolaan project:

Kumpulan root adalah spaces, dengan setiap dokumen mewakili ruang tempat aplikasi Chat membuat cerita. Setiap cerita pengguna diwakili oleh dokumen dalam subkoleksi userStories, dan setiap pengguna diwakili oleh dokumen dalam subkoleksi users.

Berikut cara membuat database Firestore:

Meninjau kode contoh

Atau, sebelum membuat Cloud Function, luangkan waktu untuk meninjau dan mempelajari kode contoh yang dihosting di GitHub.

Lihat di GitHub

Berikut ringkasan setiap filenya:

env.js

Variabel konfigurasi lingkungan untuk men-deploy aplikasi Chat ke project dan region Google Cloud yang ditentukan. Anda harus memperbarui variabel konfigurasi dalam file ini.

package.json dan package-lock.json

Setelan dan dependensi project Node.js.

index.js

Titik entri untuk Cloud Function aplikasi Chat. Metode ini membaca peristiwa Chat dari permintaan HTTP, memanggil pengendali aplikasi, dan memposting respons HTTP sebagai objek JSON.

controllers/app.js

Logika aplikasi utama. Memproses peristiwa interaksi dengan menangani perintah garis miring dan sebutan aplikasi Chat. Untuk merespons klik kartu, metode ini memanggil app-action-handler.js.

controllers/app-action-handler.js

Logika aplikasi untuk menangani klik kartu peristiwa interaksi Chat.

services/space-service.js, services/user-service.js, dan services/user-story-service.js

File ini berisi bagian dari logika aplikasi yang khusus untuk menggunakan ruang Chat, pengguna, dan cerita pengguna. Fungsi dalam file ini dipanggil oleh app.js atau app-action-handler.js. Untuk melakukan operasi database, fungsi dalam file ini memanggil fungsi di firestore-service.js.

services/firestore-service.js

Menangani operasi database. Fungsi dalam file ini dipanggil oleh services/space-service.js, services/user-service.js, dan services/user-story-service.js.

services/aip-service.js

Memanggil Vertex AI API untuk prediksi teks AI generatif.

model/*.js

File ini berisi definisi class dan enum yang digunakan layanan aplikasi untuk menyimpan dan meneruskan data antar-fungsi. Model data ini menetapkan database Firestore.

views/*.js

Setiap file dalam direktori ini membuat instance objek kartu yang kemudian dikirim kembali oleh aplikasi Chat ke Chat sebagai pesan kartu atau respons tindakan dialog.

views/widgets/*.js

Setiap file membuat instance jenis objek widget yang digunakan aplikasi untuk mem-build kartu di direktori views/.

test/**/*.test.js

Setiap file dalam direktori ini dan subdirektorinya berisi pengujian unit untuk fungsi, pengontrol, layanan, tampilan, atau widget yang sesuai. Anda dapat menjalankan semua pengujian unit dengan menjalankan npm run test saat berada di direktori root project.

Membuat dan men-deploy Cloud Function

Di bagian ini, Anda akan membuat dan men-deploy Cloud Function yang terdiri dari logika aplikasi aplikasi Chat pengelolaan project.

Cloud Function berjalan sebagai respons terhadap permintaan HTTP dari Chat yang berisi peristiwa interaksi Chat. Saat dijalankan, kode Cloud Function memproses peristiwa dan menampilkan respons ke Chat yang dirender oleh Chat sebagai pesan, dialog, atau jenis interaksi pengguna lainnya. Jika berlaku, Cloud Function juga membaca dari, atau menulis ke, database Firestore.

Berikut cara membuat Cloud Function:

1. Setelah fungsi selesai di-deploy, salin properti url dari respons. Ini adalah URL Pemicu yang Anda gunakan di bagian berikut untuk mengonfigurasi aplikasi Google Chat.

Mengonfigurasi aplikasi Google Chat di konsol Google Cloud

Bagian ini menunjukkan cara mengonfigurasi Chat API di Konsol Google Cloud dengan informasi tentang aplikasi Chat Anda, termasuk nama aplikasi Chat, perintah garis miring yang didukung, dan URL pemicu dari Cloud Function aplikasi Chat yang menjadi tujuan pengiriman peristiwa interaksi Chat.

1. Di konsol Google Cloud, klik Menu menu > Produk lainnya > Google Workspace > Library Produk > Google Chat API > Kelola > Konfigurasi.

   Buka konfigurasi Chat API

2. Di App name, ketik Project Manager.

3. Di Avatar URL, ketik https://developers.google.com/chat/images/quickstart-app-avatar.png.

4. Di Deskripsi, ketik Manages projects with user stories.

5. Klik tombol Aktifkan Fitur interaktif ke posisi aktif.

6. Di bagian Functionality, pilih Receive 1:1 messages, Join spaces and group conversations.

7. Di bagian Connection settings, pilih HTTP endpoint URL.

8. Di HTTP endpoint URL, tempel URL Pemicu yang Anda salin dari deployment Cloud Functions, dengan format https://REGION-PROJECT_ID.cloudfunctions.net/project-management-tutorial. Jika Anda men-deploy Cloud Function dengan gcloud CLI, ini adalah properti url.

9. Daftarkan perintah garis miring aplikasi Chat. Untuk mendaftarkan perintah garis miring:

   1. Di bagian Slash commands, klik Add a slash command.

   2. Untuk setiap perintah garis miring yang dijelaskan dalam tabel berikut, masukkan Nama, ID Perintah, Deskripsi, dan pilih apakah perintah garis miring Membuka dialog, lalu klik Selesai:

      Nama	ID Perintah	Deskripsi	Membuka dialog
      /createUserStory	1	Buat cerita dengan judul yang ditentukan.	Batal dipilih
      /myUserStories	2	Mencantumkan semua cerita yang ditetapkan ke pengguna.	Batal dipilih
      /userStory	3	Menampilkan status saat ini dari cerita yang ditentukan.	Batal dipilih
      /manageUserStories	4	Membuka dialog tempat cerita dapat diedit.	Dipilih
      /cleanupUserStories	5	Menghapus semua artikel di ruang.	Batal dipilih

10. Di bagian Visibilitas, pilih Buat aplikasi Chat ini tersedia untuk orang dan grup tertentu di domain Workspace Anda, lalu masukkan alamat email Anda.

11. Atau, di bagian Logs, pilih Log errors to Logging.

12. Klik Simpan. Pesan konfigurasi tersimpan akan muncul, yang berarti aplikasi Chat siap diuji.

Menguji aplikasi Chat

Uji aplikasi Chat pengelolaan project dengan mengirim pesan ke aplikasi tersebut dan menggunakan perintah garis miring untuk membuat, mengedit, dan menghapus cerita pengguna.

1. Buka Google Chat menggunakan akun Google Workspace yang Anda berikan saat menambahkan diri sebagai penguji tepercaya.

   Buka Google Chat

2. Klik add Chat baru.
3. Di kolom Tambahkan 1 orang atau lebih, ketik nama aplikasi Chat Anda.

4. Pilih aplikasi Chat Anda dari hasil. Pesan langsung akan terbuka.

5. Di pesan langsung baru dengan aplikasi, ketik Hello, lalu tekan enter. Aplikasi Chat manajemen project merespons dengan menu bantuan yang menjelaskan apa yang dapat dilakukannya.
6. Untuk membuat cerita, ketik /createUserStory Test story di panel pesan, lalu kirim. Aplikasi Chat pengelolaan project akan merespons dengan pesan kartu yang menjelaskan cerita pengguna yang dibuat untuk Anda menggunakan AI generatif dari Vertex AI.

7. Di konsol, periksa database Firestore untuk meninjau data yang dibuatnya tentang ruang tempat Anda menambahkan aplikasi Chat, pengguna yang telah berinteraksi dengannya, dan cerita pengguna yang Anda buat.

   Buka Firestore

8. Kembali ke Google Chat.

   Buka Google Chat

9. Atau, untuk mengedit cerita, klik Edit. Jika Anda puas dengan cerita, klik Simpan.
10. Uji setiap perintah garis miring yang didukung oleh aplikasi. Untuk melihatnya, ketik / atau sebutkan aplikasi Chat.
11. Hapus cerita pengguna pengujian dengan mengeluarkan perintah garis miring /cleanupUserStories. Atau, hapus atau uninstal aplikasi. Jika dihapus, aplikasi akan menghapus semua cerita pengguna yang dibuat di ruang tersebut.

Memecahkan masalah

Saat aplikasi Google Chat atau kartu menampilkan error, antarmuka Chat akan menampilkan pesan yang bertuliskan "Terjadi masalah". atau "Tidak dapat memproses permintaan Anda". Terkadang UI Chat tidak menampilkan pesan error, tetapi aplikasi atau kartu Chat menghasilkan hasil yang tidak terduga; misalnya, pesan kartu mungkin tidak muncul.

Meskipun pesan error mungkin tidak ditampilkan di UI Chat, pesan error deskriptif dan data log tersedia untuk membantu Anda memperbaiki error saat logging error untuk aplikasi Chat diaktifkan. Untuk mendapatkan bantuan dalam melihat, melakukan proses debug, dan memperbaiki error, lihat Memecahkan masalah dan memperbaiki error Google Chat.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, sebaiknya hapus project Cloud.

1. Di Konsol Google Cloud, buka halaman Manage resources. Klik Menu menu > IAM & Admin > Manage Resources.

   Buka Resource Manager

2. Dalam daftar project, pilih project yang ingin Anda hapus, lalu klik Hapus delete.
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Topik terkait

• Menjawab pertanyaan berdasarkan percakapan Chat dengan aplikasi Gemini AI Chat
• Merespons insiden dengan Google Chat, Vertex AI, dan Apps Script