Zarządzanie projektami w Google Chat, Vertex AI i Firestore

W tym samouczku pokazujemy, jak utworzyć aplikację Google Chat, której zespół może używać do zarządzania projektami w czasie rzeczywistym. Aplikacja Google Chat wykorzystuje Vertex AI do pisania historii użytkowników (które przedstawiają cechy systemu oprogramowania z perspektywy użytkownika tworzonego przez zespół) i umożliwia ich przechowywanie w bazie danych Firestore.

Wymagania wstępne

• konto Google Workspace z dostępem do Google Chat.

• Dostęp do usług Google Cloud w celu wykonywania tych czynności:

  • Utwórz projekt Google Cloud.
  • Połącz konto rozliczeniowe Google Cloud z projektem Cloud. Aby sprawdzić, czy masz dostęp, zapoznaj się z informacjami o uprawnieniach wymaganych do włączenia płatności.

  • Używaj nieuwierzytelnionych wywołań funkcji w Google Cloud Functions, które możesz sprawdzić, określając, czy Twoja organizacja Google Cloud korzysta z udostępniania ograniczonego za pomocą domeny.

  W razie potrzeby poproś administratora Google Cloud o dostęp lub uprawnienia.

• jeśli używasz interfejsu wiersza poleceń Google Cloud, jest to środowisko programistyczne Node.js skonfigurowane pod kątem działania z tym interfejsem wiersza poleceń gcloud; Zapoznaj się z artykułem o konfigurowaniu środowiska programistycznego Node.js.

Cele

• Stwórz aplikację Google Chat do zarządzania elastycznymi projektami oprogramowania.
• Pomóż użytkownikom w pisaniu artykułów za pomocą narzędzi do pisania narracji wspomaganych generatywną AI, które korzystają z Vertex AI:
  • generować i ponownie generować opisy artykułów;
  • Rozwiń opisy artykułów z notatek, aby spełnić wymagania.
  • Popraw błędy gramatyczne, aby poprawić literówki.
• Zadbaj o aktualność zadań dzięki możliwości zapisywania i odczytu w bazie danych Firestore.
• Ułatwiaj współpracę w pokoju czatu, umożliwiając użytkownikom tworzenie, edytowanie, przypisywanie i rozpoczynanie relacji bezpośrednio w rozmowie.

Używane usługi

Aplikacja do zarządzania projektami korzysta z tych usług Google Workspace i Google Cloud:

• Chat API: interfejs API do tworzenia aplikacji Google Chat, które odbierają zdarzenia interakcji z Google Chat, takie jak wiadomości, i reagują na nie. Aplikacja do zarządzania projektami Google Chat używa interfejsu Chat API do odbierania zdarzeń interakcji wysyłanych przez Google Chat i reagowania na nie oraz do konfigurowania atrybutów, które określają sposób wyświetlania tych informacji w Google Chat, takich jak nazwa i obraz awatara.
• Vertex AI API: platforma generatywnej AI. Aplikacja Google Chat do zarządzania projektami wykorzystuje interfejs Vertex AI API do tworzenia tytułów i opisów historii użytkownika.
• Firestore: bezserwerowa baza danych dokumentów. Aplikacja Google Chat do zarządzania projektami wykorzystuje Firebase do przechowywania danych o historiach użytkowników.

• Cloud Functions: lekka bezserwerowa usługa obliczeniowa, która umożliwia tworzenie jednozadaniowych, samodzielnych funkcji mogących odpowiadać na zdarzenia interakcji z Google Chat bez konieczności zarządzania serwerem lub środowiskiem wykonawczym. Aplikacja do zarządzania projektami Google Chat korzysta z Cloud Functions do hostowania punktu końcowego HTTP, do którego Google Chat wysyła zdarzenia interakcji, oraz jako platformy obliczeniowej do uruchamiania logiki przetwarzającej te zdarzenia i reagowania na nie.

  Do tworzenia, przetwarzania zdarzeń interakcji i hostowania zasobów obliczeniowych Cloud Functions wykorzystuje te usługi Google Cloud:

  • Cloud Build: w pełni zarządzana platforma ciągłej integracji, dostarczania i wdrażania, która uruchamia automatyczne kompilacje.
  • Pub/Sub: asynchroniczna i skalowalna usługa do przesyłania wiadomości, która oddziela usługi generujące wiadomości z usług przetwarzających te wiadomości.
  • Cloud Run Admin API: w pełni zarządzane środowisko do uruchamiania aplikacji skonteneryzowanych.

Architektura

Architektura aplikacji do zarządzania projektami Google Chat odbiera i przetwarza zdarzenia interakcji z Google Chat w punkcie końcowym HTTP, wykorzystuje Vertex AI do pisania historii użytkowników oraz przechowuje szczegóły relacji użytkownika w bazie danych Firestore. Poniższy diagram przedstawia architekturę używanych zasobów Google Workspace i Google Cloud.

Aplikacja Google Chat do zarządzania projektami działa w ten sposób:

1. Użytkownik wysyła wiadomość w Google Chat i wywołuje aplikację Google Chat do zarządzania projektami, wysyłając do niej bezpośrednio wiadomość, wzmiankę o niej w pokoju lub wpisując polecenie po ukośniku.

2. Google Chat wysyła synchroniczne żądanie HTTP do punktu końcowego HTTP funkcji w Cloud Functions.

3. Aplikacja do zarządzania projektami Google Chat przetwarza żądanie HTTP:

   1. Vertex AI pomaga pisać i aktualizować historie użytkownika.

   2. Baza danych Firestore przechowuje, pobiera, aktualizuje i usuwa dane historii użytkownika.

4. Cloud Functions zwraca do Google Chat odpowiedź HTTP, która wyświetla ją użytkownikowi jako wiadomość lub okno.

Przygotowywanie środowiska

W tej sekcji dowiesz się, jak utworzyć i skonfigurować projekt Google Cloud na potrzeby aplikacji Google Chat.

Tworzenie projektu Google Cloud

Konsola Google Cloud

1. W konsoli Google Cloud kliknij Menu menu > Administracja > Utwórz projekt.

   Otwórz stronę Utwórz projekt

2. W polu Nazwa projektu wpisz opisową nazwę projektu.

   Opcjonalnie: aby edytować identyfikator projektu, kliknij Edytuj. Po utworzeniu projektu nie można zmienić identyfikatora, więc wybierz taki, który spełnia Twoje potrzeby przez cały okres istnienia projektu.

3. W polu Lokalizacja kliknij Przeglądaj, aby wyświetlić potencjalne lokalizacje swojego projektu. Następnie kliknij Wybierz.
4. Kliknij Utwórz. W konsoli Google Cloud otworzy się strona panelu, a w ciągu kilku minut zostanie utworzony projekt.

interfejs wiersza poleceń gcloud

Uzyskaj dostęp do interfejsu wiersza poleceń Google Cloud („gcloud”) w jednym z tych środowisk programistycznych:

• Cloud Shell: aby używać terminala online ze skonfigurowanym już interfejsem wiersza poleceń gcloud, aktywuj Cloud Shell.
  Aktywuj Cloud Shell
• Local Shell (Powłoka lokalna): aby używać lokalnego środowiska programistycznego, zainstaluj i initialize interfejs wiersza poleceń gcloud.
  Aby utworzyć projekt Cloud, użyj polecenia `gcloud projects create`:

  gcloud projects create PROJECT_ID

  Zastąp PROJECT_ID, ustawiając identyfikator projektu, który chcesz utworzyć.

Włączanie płatności w projekcie Cloud

Konsola Google Cloud

1. W konsoli Google Cloud otwórz Rozliczenia. Kliknij Menu menu > Płatności > Moje projekty.

   Otwórz stronę Płatności w moich projektach

2. W sekcji Wybierz organizację wybierz organizację powiązaną z Twoim projektem Google Cloud.
3. W wierszu projektu otwórz menu Działania (more_vert), kliknij Zmień płatności i wybierz konto rozliczeniowe Cloud.
4. Kliknij Ustaw konto.

interfejs wiersza poleceń gcloud

1. Aby wyświetlić listę dostępnych kont rozliczeniowych, uruchom polecenie:

   gcloud billing accounts list

2. Połącz konto rozliczeniowe z projektem Google Cloud:

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

   Zastąp następujące elementy:

   • PROJECT_ID to identyfikator projektu projektu Cloud, w którym chcesz włączyć płatności.
   • BILLING_ACCOUNT_ID to identyfikator konta rozliczeniowego, które ma zostać połączone z projektem Google Cloud.

Włącz interfejsy API

Uwierzytelnianie i autoryzacja

Aby skorzystać z tego samouczka, nie musisz konfigurować uwierzytelniania ani autoryzacji.

Aby wywołać interfejsy API Firestore i Vertex AI, w tym samouczku używane są domyślne dane logowania aplikacji z domyślnym kontem usługi przyłączonym do funkcji w Cloud Functions, której nie musisz konfigurować. W kontekście środowiska produkcyjnego należałoby utworzyć i dołączyć konto usługi do funkcji w Cloud Functions.

Utwórz i wdróż aplikację Google Chat

Po utworzeniu i skonfigurowaniu projektu Google Cloud możesz skompilować i wdrożyć aplikację Google Chat. W tej sekcji wykonaj te czynności:

1. Utwórz bazę danych Firestore, w której chcesz przechowywać i pobierać historie użytkowników.
2. Opcjonalnie możesz zobaczyć przykładowy kod.
3. Utwórz funkcję w Cloud Functions do hostowania i uruchamiania kodu aplikacji Google Chat w odpowiedzi na zdarzenia odebrane z Google Chat w formie żądań HTTP.
4. Utwórz i wdróż aplikację Google Chat na stronie konfiguracji interfejsu Google Chat API.

Tworzenie bazy danych Firestore

W tej sekcji utworzysz bazę danych Firestore, która będzie utrwalać i pobierać historie użytkowników, ale nie definiuje modelu danych. Model danych jest ustawiany niejawnie w przykładowym kodzie przez pliki model/user-story.js i model/user.js.

Baza danych aplikacji Google Chat do zarządzania projektami wykorzystuje model danych NoSQL oparty na class dokumentach uporządkowanych w collections_bookmark kolekcje. Więcej informacji znajdziesz w artykule o modelu danych Firestore.

Ten diagram przedstawia przegląd modelu danych w aplikacji Google Chat do zarządzania projektami:

Kolekcja główna to spaces, gdzie każdy dokument reprezentuje obszar, w którym aplikacja Google Chat utworzyła relacje. Każda historia użytkownika jest reprezentowana przez dokument z podkolekcji userStories, a każdy użytkownik jest reprezentowany przez dokument z kolekcji users.

Aby utworzyć bazę danych Firestore:

Przeglądanie przykładowego kodu

Opcjonalnie, zanim utworzysz funkcję w Cloud Functions, poświęć chwilę na zapoznanie się z przykładowym kodem hostowanym w GitHubie.

Wyświetl w GitHubie

Poniżej znajdziesz omówienie każdego pliku:

env.js

zmiennych środowiskowych służących do wdrożenia aplikacji Google Chat w określonym projekcie Google Cloud i wybranym regionie. Zmienne konfiguracji musisz zaktualizować w tym pliku.

package.json i package-lock.json

Ustawienia i zależności projektu Node.js.

index.js

Punkt wejścia dla funkcji w aplikacji Google Chat. Odczytuje zdarzenie Google Chat z żądania HTTP, wywołuje moduł obsługi aplikacji i publikuje odpowiedź HTTP jako obiekt JSON.

controllers/app.js

Główna logika aplikacji. Przetwarza zdarzenia interakcji przez obsługę wzmianek i poleceń po ukośniku z aplikacji Google Chat. Aby odpowiedzieć na kliknięcia karty, wywołuje ona app-action-handler.js.

controllers/app-action-handler.js

Logika aplikacji do obsługi kliknięć karty Zdarzenia interakcji z Google Chat.

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

Pliki te zawierają elementy logiki aplikacji specyficzne dla pracy z pokojami czatu, użytkownikami i historiami użytkowników. Funkcje w tych plikach są wywoływane przez app.js lub app-action-handler.js. Aby wykonywać operacje na bazie danych, funkcje w tych plikach wywołują funkcje w komponencie firestore-service.js.

services/firestore-service.js

Obsługuje operacje na bazie danych. Funkcje w tym pliku są wywoływane przez services/space-service.js, services/user-service.js i services/user-story-service.js.

services/aip-service.js

Wywołuje interfejs Vertex AI API na potrzeby prognozowania tekstu za pomocą generatywnej AI.

model/*.js

Pliki te zawierają definicje klas i wyliczeń, które są wykorzystywane przez usługi aplikacji do przechowywania i przekazywania danych między funkcjami. Ustawia on model danych dla bazy danych Firestore.

views/*.js

Każdy plik w tym katalogu tworzy instancję obiektu karty, który aplikacja Google Chat wysyła z powrotem do Google Chat w formie wiadomości karty lub odpowiedzi na działanie w oknie dialogowym.

views/widgets/*.js

Każdy plik tworzy instancję typu widżetu, którego aplikacja używa do budowania kart w katalogu views/.

test/**/*.test.js

Każdy plik w tym katalogu i jego podkatalogach zawiera testy jednostkowe odpowiedniej funkcji, kontrolera, usługi, widoku lub widżetu. Możesz wykonać wszystkie testy jednostkowe, uruchamiając polecenie npm run test w katalogu głównym projektu.

Tworzenie i wdrażanie funkcji w Cloud Functions

W tej sekcji utworzysz i wdrożysz funkcję w Cloud Functions, która stanowi logikę aplikacji do zarządzania projektem.

Funkcja w Cloud Functions jest uruchamiana w odpowiedzi na żądanie HTTP z Google Chat zawierające zdarzenie interakcji z Google Chat. Po uruchomieniu kod funkcji w Cloud Functions przetwarza zdarzenie i zwraca odpowiedź do Google Chat, którą Google Chat renderuje jako wiadomość, okno lub inny rodzaj interakcji użytkownika. W stosownych przypadkach funkcja w Cloud Functions odczytuje też dane z bazy danych Firestore lub zapisuje w niej dane.

Oto jak utworzyć funkcję w Cloud Functions:

1. Po zakończeniu wdrażania funkcji skopiuj właściwość url z odpowiedzi. To adres URL aktywatora, którego w dalszej części użyjesz do skonfigurowania aplikacji Google Chat.

Konfigurowanie aplikacji Google Chat w konsoli Google Cloud

W tej sekcji dowiesz się, jak skonfigurować interfejs Chat API w konsoli Google Cloud przy użyciu informacji o aplikacji do obsługi czatu, w tym jej nazwy, obsługiwanych poleceń po ukośniku oraz adresu URL aktywatora funkcji w Cloud Functions, do której wysyła ona zdarzenia interakcji z Google Chat.

1. W konsoli Google Cloud kliknij Menu menu > Więcej usług > Google Workspace > Biblioteka usług > Google Chat API > Zarządzaj > Konfiguracja.

   Otwórz stronę konfiguracji interfejsu Chat API

2. W polu Nazwa aplikacji wpisz Project Manager.

3. W polu URL awatara wpisz https://developers.google.com/chat/images/quickstart-app-avatar.png.

4. W polu Opis wpisz Manages projects with user stories.

5. Kliknij przełącznik Włącz funkcje interaktywne, aby ustawić go w pozycji włączenia.

6. W sekcji Funkcjonalność wybierz Odbieranie wiadomości 1:1 i Dołączanie do pokoi i rozmów grupowych.

7. W sekcji Ustawienia połączenia wybierz URL aplikacji.

8. W polu URL aplikacji wklej adres URL aktywatora skopiowany z wdrożenia funkcji w Cloud Functions w formacie https://REGION-PROJECT_ID.cloudfunctions.net/project-management-tutorial. Jeśli funkcja Cloud Functions została wdrożona za pomocą interfejsu wiersza poleceń gcloud, jest to właściwość url.

9. Zarejestruj polecenia po ukośniku w aplikacji Google Chat. Aby zarejestrować polecenie po ukośniku:

   1. W sekcji Polecenia po ukośniku kliknij Dodaj polecenie po ukośniku.

   2. W przypadku każdego polecenia po ukośniku opisanego w poniższej tabeli wpisz nazwę, identyfikator polecenia i opis, a następnie wybierz, czy polecenie po ukośniku Otwiera okno, a następnie kliknij Gotowe:

      Nazwa	Identyfikator polecenia	Opis	Otwiera okno
      /createUserStory	1	Utwórz artykuł z określonym tytułem.	Odznaczono
      /myUserStories	2	Wyświetla listę wszystkich artykułów przypisanych użytkownikowi.	Odznaczono
      /userStory	3	Wyświetla bieżący stan wybranego artykułu.	Odznaczono
      /manageUserStories	4	Otwiera okno, w którym można edytować artykuły.	Wybrano
      /cleanupUserStories	5	Usuwa wszystkie artykuły z pokoju.	Odznaczono

10. W sekcji Widoczność wybierz Udostępnij tę aplikację do obsługi czatu określonym osobom i grupom w domenie Workspace i wpisz swój adres e-mail.

11. Opcjonalnie w sekcji Logi wybierz Loguj błędy w usłudze Logging.

12. Kliknij Zapisz. Pojawi się komunikat z zapisaną konfiguracją, co oznacza, że aplikacja Google Chat jest gotowa do przetestowania.

Testowanie aplikacji Google Chat

Przetestuj aplikację do zarządzania projektami, wysyłając do niej wiadomości i używając poleceń po ukośniku, aby tworzyć, edytować i usuwać historie użytkowników.

1. Otwórz Google Chat na koncie Google Workspace podanym podczas dodawania siebie jako zaufanego testera.

   Otwórz Google Chat

2. Kliknij add Nowy czat.
3. W polu Dodaj co najmniej 1 osobę wpisz nazwę aplikacji do obsługi czatu.

4. W wynikach wybierz swoją aplikację do obsługi czatu. Otworzy się czat.

5. W nowym czacie z aplikacją wpisz Hello i naciśnij enter. Aplikacja do zarządzania projektami Google Chat w odpowiedzi wyświetla menu pomocy ze szczegółowymi informacjami o jego możliwościach.
6. Aby utworzyć relację, wpisz /createUserStory Test story na pasku wiadomości i wyślij ją. Aplikacja do zarządzania projektami Google Chat w odpowiedzi przesyła wiadomość z kartą ze szczegółowymi informacjami o historii użytkownika, którą tworzy dla Ciebie z wykorzystaniem generatywnej AI z Vertex AI.

7. W konsoli sprawdź bazę danych Firestore, aby przejrzeć utworzone przez nią rekordy dotyczące pokoju, do którego dodano aplikację Google Chat, a także informacje o użytkownikach, którzy z niego korzystali, oraz utworzonej historii użytkownika.

   Otwórz Firestore

8. Wróć do Google Chat.

   Otwórz Google Chat

9. Opcjonalnie, aby edytować historię, kliknij Edytuj. Jeśli historia wydaje Ci się zadowalająca, kliknij Zapisz.
10. Przetestuj wszystkie polecenia po ukośniku obsługiwane przez aplikację. Aby je wyświetlić, wpisz / lub wspomnij o aplikacji Google Chat.
11. Usuń testową historię użytkownika, uruchamiając polecenie po ukośniku /cleanupUserStories. Możesz też usunąć lub odinstalować aplikację. Po usunięciu aplikacja usuwa wszystkie artykuły użytkowników utworzone w tym pokoju.

Rozwiązywanie problemów

Gdy aplikacja lub karta Google Chat zwróci błąd, interfejs czatu wyświetli komunikat „Coś poszło nie tak” lub „Nie udało się przetworzyć Twojej prośby”. Czasami w interfejsie Google Chat nie pojawia się żaden komunikat o błędzie, ale aplikacja lub karta Google Chat zwraca nieoczekiwany wynik, na przykład komunikat na karcie może się nie pojawić.

Mimo że komunikat o błędzie może nie wyświetlać się w interfejsie Google Chat, dostępne są opisowe komunikaty o błędach i dane dziennika, które pomogą Ci naprawić błędy występujące po włączeniu logowania błędów w aplikacjach do obsługi czatu. Informacje o wyświetlaniu, debugowaniu i naprawianiu błędów znajdziesz w artykule Rozwiązywanie problemów z Google Chat i ich naprawianie.

Czyszczenie danych

Aby uniknąć obciążenia konta Google Cloud opłatami za zasoby zużyte w tym samouczku, zalecamy usunięcie projektu Cloud.

1. W konsoli Google Cloud otwórz stronę Zarządzanie zasobami. Kliknij Menu menu > Administracja > Zarządzaj zasobami.

   Otwórz menedżera zasobów

2. Na liście projektów wybierz projekt, który chcesz usunąć, a następnie kliknij Usuń delete.
3. W oknie wpisz identyfikator projektu i kliknij Wyłącz, aby usunąć projekt.

Powiązane artykuły

• Odpowiadanie na pytania na podstawie rozmów z Google Chat w aplikacji Gemini AI Chat
• Reagowanie na incydenty przy użyciu Google Chat, Vertex AI i Apps Script