Projekte mit Google Chat, Vertex AI und Firestore verwalten

In dieser Anleitung erfahren Sie, wie Sie eine Google Chat-App erstellen, mit der ein Team Projekte in Echtzeit verwalten kann. In der Chat-App wird Vertex AI verwendet, um Teams beim Erstellen von User Storys zu unterstützen. Diese stellen Funktionen eines Softwaresystems aus der Sicht eines Nutzers dar, die das Team entwickeln soll. Die Storys werden in einer Firestore-Datenbank gespeichert.

Vorbereitung

• Ein Business- oder Enterprise Google Workspace-Konto mit Zugriff auf Google Chat.

• Zugriff auf Google Cloud-Dienste für Folgendes:

  • Google Cloud-Projekt erstellen.
  • Google Cloud-Rechnungskonto mit dem Cloud-Projekt verknüpfen Ob Sie Zugriff haben, erfahren Sie unter Berechtigungen zum Aktivieren der Abrechnung.

  • Verwenden Sie nicht authentifizierte Google Cloud Functions-Aufrufe. Sie können prüfen, ob Ihre Google Cloud-Organisation die Freigabe mit Domaineinschränkung verwendet.

  Wenden Sie sich bei Bedarf an Ihren Google Cloud-Administrator, um Zugriff oder Berechtigung zu erhalten.

• Wenn Sie die Google Cloud CLI verwenden: eine Node.js-Entwicklungsumgebung, die für die Verwendung mit der gcloud CLI konfiguriert ist. Siehe Node.js-Entwicklungsumgebung einrichten.

Zielsetzungen

• Erstellen Sie eine Chat-App, mit der agile Softwareprojekte verwaltet werden.
• Mithilfe von generativen KI-gestützten Tools zum Erstellen von Storys, die auf Vertex AI basieren, können Sie Nutzern beim Erstellen von User Storys helfen:
  • Storybeschreibungen generieren und neu generieren
  • Erweitern Sie die Beschreibung der Geschichte von Notizen bis hin zu Anforderungen.
  • Korrigiere die Grammatik, um Tippfehler zu korrigieren.
• Halten Sie die Arbeit auf dem neuesten Stand, indem Sie in eine Firestore-Datenbank schreiben und aus dieser lesen.
• Erleichtern Sie die Zusammenarbeit in einem Chatbereich, indem Sie Nutzern die Möglichkeit geben, Geschichten direkt aus der Unterhaltung heraus zu erstellen, zu bearbeiten, zuzuweisen und zu starten.

Verwendete Produkte

Die Projektmanagement-App verwendet die folgenden Google Workspace- und Google Cloud-Produkte:

• Chat API: API zum Entwickeln von Google Chat-Apps, die Chat-Interaktionsereignisse wie Nachrichten empfangen und darauf reagieren. Die Google Chat App für das Projektmanagement verwendet die Chat API, um von Google Chat gesendete Interaktionsereignisse zu empfangen und darauf zu reagieren und um Attribute wie Name und Avatar zu konfigurieren, mit denen festgelegt wird, wie sie in Google Chat angezeigt werden.
• Vertex AI API: Eine Plattform für generative KI. Die Google Chat-App für das Projektmanagement verwendet die Vertex AI API, um User Story-Titel und -Beschreibungen zu schreiben.
• Firestore: Eine serverlose Dokumentendatenbank. Die Google Chat App für das Projektmanagement verwendet Firebase, um Daten zu User Storys zu speichern.

• Cloud Functions: Ein einfacher serverloser Computing-Dienst, mit dem Sie zweckgebundene, eigenständige Funktionen erstellen können, die auf Chat-Interaktionsereignisse reagieren können, ohne einen Server oder eine Laufzeitumgebung verwalten zu müssen. Die Google Chat-App für die Projektverwaltung verwendet Cloud Functions, um den HTTP-Endpunkt zu hosten, an den Chat-Interaktionsereignisse gesendet werden, und als Rechenplattform, um Logik auszuführen, die diese Ereignisse verarbeitet und darauf reagiert.

  Cloud Functions verwendet die folgenden Google Cloud-Produkte zum Erstellen, Verarbeiten von Interaktionsereignissen und Hosten von Rechenressourcen:

  • Cloud Build: Eine vollständig verwaltete Plattform für Continuous Integration, Delivery und Deployment, auf der automatisierte Builds ausgeführt werden.
  • Pub/Sub: Ein asynchroner, skalierbarer Messaging-Dienst, der Dienste entkoppelt, die Nachrichten von Diensten erzeugen, die diese Nachrichten verarbeiten.
  • Cloud Run Admin API: Vollständig verwaltete Umgebung zum Ausführen von Containeranwendungen.

Architektur

Die Projektmanagement-Architektur der Google Chat-Anwendung empfängt und verarbeitet Chat-Interaktionsereignisse an einem HTTP-Endpunkt, verwendet Vertex AI, um User Storys zu schreiben, und speichert User Story-Details in einer Firestore-Datenbank. Das folgende Diagramm zeigt die Architektur der verwendeten Google Workspace- und Google Cloud-Ressourcen.

So funktioniert die Google Chat-App für das Projektmanagement:

1. Ein Nutzer sendet eine Nachricht in Google Chat und ruft die Google Chat-App für die Projektverwaltung auf, indem er sie direkt sendet, in einem Bereich erwähnt oder einen Slash-Befehl eingibt.

2. Chat sendet eine synchrone HTTP-Anfrage an den HTTP-Endpunkt der Cloud-Funktion.

3. Die Google Chat-App für das Projektmanagement verarbeitet die HTTP-Anfrage:

   1. Vertex AI unterstützt Sie beim Erstellen oder Aktualisieren einer User Story.

   2. Eine Firestore-Datenbank speichert, ruft, aktualisiert oder löscht User-Story-Daten.

4. Cloud Functions gibt eine HTTP-Antwort an Google Chat zurück, die dem Nutzer entweder als Nachricht oder als Dialogfeld angezeigt wird.

Umgebung vorbereiten

In diesem Abschnitt wird beschrieben, wie Sie ein Google Cloud-Projekt für die Chat-App erstellen und konfigurieren.

Google Cloud-Projekt erstellen

Google Cloud Console

1. Klicken Sie in der Google Cloud Console auf das Dreipunkt-Menü menu > IAM und Verwaltung > Projekt erstellen.

   Zur Seite „Projekt erstellen“

2. Geben Sie im Feld Projektname einen aussagekräftigen Namen für Ihr Projekt ein.

   Optional: Klicken Sie zum Bearbeiten der Projekt-ID auf Bearbeiten. Die Projekt-ID kann nach dem Erstellen des Projekts nicht mehr geändert werden. Wählen Sie also eine ID aus, die während der gesamten Dauer des Projekts den Anforderungen entspricht.

3. Klicken Sie im Feld Standort auf Durchsuchen, um mögliche Standorte für Ihr Projekt zu sehen. Klicken Sie danach auf Auswählen.
4. Klicken Sie auf Erstellen. In der Google Cloud Console wird die Dashboard-Seite aufgerufen und Ihr Projekt wird innerhalb weniger Minuten erstellt.

gcloud-CLI

Rufen Sie in einer der folgenden Entwicklungsumgebungen die Google Cloud CLI (gcloud) auf:

• Cloud Shell: Aktivieren Sie Cloud Shell, um ein Onlineterminal zu verwenden, auf dem die gcloud CLI bereits eingerichtet ist.
  Cloud Shell aktivieren
• Lokale Shell: Zur Verwendung einer lokalen Entwicklungsumgebung müssen Sie die gcloud CLI installieren und initialisieren.
  Verwenden Sie den Befehl gcloud projects create, um ein Cloud-Projekt zu erstellen:

  gcloud projects create PROJECT_ID

  Ersetzen Sie PROJECT_ID, indem Sie die ID für das Projekt festlegen, das Sie erstellen möchten.

Abrechnung für das Cloud-Projekt aktivieren

Google Cloud Console

1. Klicken Sie in der Google Cloud Console auf Abrechnung. Klicken Sie auf Menü menu > Abrechnung > Meine Projekte.

   Zur Abrechnung für „Meine Projekte“

2. Wählen Sie unter Organisation auswählen die Organisation aus, die mit Ihrem Google Cloud-Projekt verknüpft ist.
3. Öffnen Sie in der Projektzeile das Menü Aktionen (more_vert), klicken Sie auf Abrechnung ändern und wählen Sie das Cloud-Rechnungskonto aus.
4. Klicken Sie auf Konto festlegen.

gcloud-CLI

1. Führen Sie folgenden Befehl aus, um verfügbare Rechnungskonten aufzulisten:

   gcloud billing accounts list

2. So verknüpfen Sie ein Abrechnungskonto mit einem Google Cloud-Projekt:

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

   Ersetzen Sie Folgendes:

   • PROJECT_ID ist die Projekt-ID des Cloud-Projekts, für das Sie die Abrechnung aktivieren möchten.
   • BILLING_ACCOUNT_ID ist die Rechnungskonto-ID, die mit dem Google Cloud-Projekt verknüpft werden soll.

APIs aktivieren

Authentifizierung und Autorisierung

Für diese Anleitung ist keine Konfiguration der Authentifizierung und Autorisierung erforderlich.

Zum Aufrufen der Firestore API und der Vertex AI API werden in dieser Anleitung Standardanmeldedaten für Anwendungen mit dem mit der Cloud Functions-Funktion verknüpften Standarddienstkonto verwendet, das Sie nicht einrichten müssen. Im Kontext einer Produktionsumgebung würden Sie in der Regel ein Dienstkonto create und an die Cloud Functions-Funktion anhängen.

Google Chat App erstellen und bereitstellen

Nachdem Sie Ihr Google Cloud-Projekt erstellt und konfiguriert haben, können Sie die Google Chat-App erstellen und bereitstellen. In diesem Abschnitt gehen Sie so vor:

1. Erstellen Sie eine Firestore-Datenbank, in der User Storys gespeichert und abgerufen werden können.
2. Optional können Sie sich den Beispielcode ansehen.
3. Erstellen Sie eine Cloud Functions-Funktion, um den Code der Chat-App als Antwort auf Ereignisse zu hosten und auszuführen, die von Google Chat als HTTP-Anfragen empfangen werden.
4. Erstellen Sie auf der Google Chat API-Konfigurationsseite eine Google Chat-App und stellen Sie sie bereit.

Firestore-Datenbank erstellen

In diesem Abschnitt erstellen Sie eine Firestore-Datenbank, um User Stories zu speichern und abzurufen, aber Sie definieren nicht das Datenmodell. Das Datenmodell wird im Beispielcode implizit durch die Dateien model/user-story.js und model/user.js festgelegt.

Die Datenbank der Chat-App für die Projektverwaltung verwendet ein NoSQL-Datenmodell, das auf class Dokumenten basiert, die in collections_bookmark Sammlungen organisiert sind. Weitere Informationen finden Sie unter Firestore-Datenmodell.

Das folgende Diagramm bietet einen Überblick über das Datenmodell der Google Chat-App für das Projektmanagement:

Die Stammsammlung ist spaces, wobei jedes Dokument einen Bereich darstellt, in dem die Chat-App Geschichten erstellt hat. Jede User Story wird durch ein Dokument in der Untersammlung userStories und jeder Nutzer durch ein Dokument in der Untersammlung users dargestellt.

So erstellen Sie die Firestore-Datenbank:

Beispielcode ansehen

Optional: Bevor Sie die Cloud Functions-Funktion erstellen, sollten Sie sich den auf GitHub gehosteten Beispielcode ansehen und sich damit vertraut machen.

Auf GitHub ansehen

Hier ein Überblick über die einzelnen Dateien:

env.js

Umgebungsvariablen zum Bereitstellen der Chat-App in einem bestimmten Google Cloud-Projekt und einer angegebenen Region. Sie müssen die Konfigurationsvariablen in dieser Datei aktualisieren.

package.json und package-lock.json

Node.js-Projekteinstellungen und ‑Abhängigkeiten

index.js

Einstiegspunkt für die Cloud Functions-Funktion der Chat-App. Sie liest das Chat-Ereignis aus der HTTP-Anfrage, ruft den App-Handler auf und postet die HTTP-Antwort als JSON-Objekt.

controllers/app.js

Die Hauptlogik der Anwendung. Verarbeitet die Interaktionsereignisse, indem Erwähnungen in der Chat-App und Slash-Befehle verarbeitet werden. Um auf Kartenklicks zu reagieren, wird app-action-handler.js aufgerufen.

controllers/app-action-handler.js

Anwendungslogik zur Verarbeitung von Chat-Interaktionsereignissen für Kartenklicks.

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

Diese Dateien enthalten die Teile der Anwendungslogik, die speziell für die Arbeit mit Chatbereichen, Nutzern und User Storys relevant sind. Die Funktionen in diesen Dateien werden von app.js oder app-action-handler.js aufgerufen. Zur Ausführung von Datenbankvorgängen rufen die Funktionen in diesen Dateien Funktionen in firestore-service.js auf.

services/firestore-service.js

Verwaltet Datenbankvorgänge. Die Funktionen in dieser Datei werden von services/space-service.js, services/user-service.js und services/user-story-service.js aufgerufen.

services/aip-service.js

Ruft die Vertex AI API für die Textvorhersage mit generativer KI auf.

model/*.js

Diese Dateien enthalten die Definition von Klassen und Enums, die von den Anwendungsdiensten zum Speichern und Übergeben von Daten zwischen Funktionen verwendet werden. Er legt das Datenmodell für die Firestore-Datenbank fest.

views/*.js

Jede Datei in diesem Verzeichnis instanziiert ein Kartenobjekt, das die Chat-App dann als Kartennachricht oder als Antwort auf Dialogaktion an Google Chat zurücksendet.

views/widgets/*.js

Jede Datei instanziiert einen Widget-Objekttyp, mit dem die App die Karten im Verzeichnis views/ erstellt.

test/**/*.test.js

Jede Datei in diesem Verzeichnis und seinen Unterverzeichnissen enthält die Einheitentests für die entsprechende Funktion, den entsprechenden Controller, den Dienst, die Ansicht oder das Widget. Sie können alle Unit-Tests ausführen, indem Sie npm run test im Stammverzeichnis des Projekts ausführen.

Cloud Functions-Funktion erstellen und bereitstellen

In diesem Abschnitt erstellen und stellen Sie eine Cloud-Funktion bereit, die die Anwendungslogik der Chat-Anwendung für die Projektverwaltung enthält.

Die Cloud Functions-Funktion wird als Antwort auf eine HTTP-Anfrage von Google Chat mit einem Chat-Interaktionsereignis ausgeführt. Bei der Ausführung verarbeitet der Cloud Functions-Code das Ereignis und gibt eine Antwort an Chat zurück, die Google Chat als Nachricht, Dialog oder andere Art von Nutzerinteraktion rendert. Gegebenenfalls liest die Cloud Functions-Funktion auch aus der Firestore-Datenbank oder schreibt in diese.

So erstellen Sie die Cloud Functions-Funktion:

1. Kopieren Sie nach der Bereitstellung der Funktion das Attribut url aus der Antwort. Dies ist die Trigger-URL, die Sie im folgenden Abschnitt zum Konfigurieren der Google Chat-App verwenden.

Google Chat-App in der Google Cloud Console konfigurieren

In diesem Abschnitt erfahren Sie, wie Sie die Chat API in der Google Cloud Console mit Informationen zu Ihrer Chat-App konfigurieren, einschließlich des Namens der Chat-App, unterstützter Slash-Befehle und der Trigger-URL der Cloud-Funktion der Chat-App, an die Chat-Interaktionsereignisse gesendet werden.

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü menu und dann auf > Weitere Produkte > Google Workspace > Produktbibliothek > Google Chat API > Verwalten > Konfiguration.

   Chat API-Konfiguration aufrufen

2. Geben Sie unter App-Name Project Manager ein.

3. Geben Sie unter Avatar-URL https://developers.google.com/chat/images/quickstart-app-avatar.png ein.

4. Geben Sie unter Beschreibung den Wert Manages projects with user stories. ein.

5. Klicken Sie auf die Ein/Aus-Schaltfläche Interaktive Funktionen aktivieren, um die Position „Ein“ festzulegen.

6. Wählen Sie unter Funktionsweise die Optionen 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten aus.

7. Wählen Sie unter Verbindungseinstellungen die Option HTTP-Endpunkt-URL aus.

8. Fügen Sie unter HTTP-Endpunkt-URL die Trigger-URL ein, die Sie aus der Cloud Functions-Bereitstellung kopiert haben, im Format https://REGION-PROJECT_ID.cloudfunctions.net/project-management-tutorial. Wenn Sie die Cloud Functions-Funktion mit der gcloud CLI bereitgestellt haben, ist dies das Attribut url.

9. Registrieren Sie die Slash-Befehle der Chat-App. So registrierst du einen Slash-Befehl:

   1. Klicken Sie unter Slash-Befehle auf Slash-Befehl hinzufügen.

   2. Geben Sie für jeden in der folgenden Tabelle beschriebenen Slash-Befehl den Namen, die Befehls-ID und die Beschreibung ein. Wählen Sie dann aus, ob der Slash-Befehl ein Dialogfeld öffnet, und klicken Sie auf Fertig:

      Name	Befehls-ID	Beschreibung	Öffnet ein Dialogfeld
      /createUserStory	1	Erstelle eine Story mit dem angegebenen Titel.	Auswahl aufgehoben
      /myUserStories	2	Listet alle Stories auf, die dem Nutzer zugewiesen sind.	Auswahl aufgehoben
      /userStory	3	Zeigt den aktuellen Status der angegebenen Geschichte an.	Auswahl aufgehoben
      /manageUserStories	4	Es wird ein Dialogfeld geöffnet, in dem Stories bearbeitet werden können.	Ausgewählt
      /cleanupUserStories	5	Alle Meldungen im Gruppenbereich werden gelöscht.	Auswahl aufgehoben

10. Wählen Sie unter Sichtbarkeit die Option Diese Chat-App bestimmten Personen und Gruppen in Ihrer Workspace-Domain zur Verfügung stellen aus und geben Sie Ihre E-Mail-Adresse ein.

11. Wählen Sie optional unter Logs die Option Fehler in Logging protokollieren aus.

12. Klicken Sie auf Speichern. Eine Meldung, dass die Konfiguration gespeichert wurde, zeigt an, dass die Chat-App zum Testen bereit ist.

Chat-App testen

Testen Sie die Chat-App für die Projektverwaltung, indem Sie ihr Nachrichten senden und mithilfe der Slash-Befehle User Storys erstellen, bearbeiten und löschen.

1. Öffnen Sie Google Chat mit dem Google Workspace-Konto, das Sie angegeben haben, als Sie sich als vertrauenswürdiger Tester hinzugefügt haben.

   Zu Google Chat

2. Klicken Sie auf add Neuer Chat.
3. Geben Sie im Feld Eine oder mehrere Personen hinzufügen den Namen Ihrer Chat-App ein.

4. Wählen Sie aus den Ergebnissen Ihre Chat-App aus. Eine Direktnachricht wird geöffnet.

5. Geben Sie in der neuen Direktnachricht an die App Hello ein und drücken Sie enter. Die Chat-App für das Projektmanagement antwortet mit einem Hilfemenü, in dem die Funktionen beschrieben werden.
6. Wenn Sie eine Story erstellen möchten, geben Sie /createUserStory Test story in die Nachrichtenleiste ein und senden Sie die Nachricht. Die Chat-App für die Projektverwaltung antwortet mit einer Kartennachricht, in der die User Story beschrieben wird, die sie mithilfe von generativer KI von Vertex AI für Sie erstellt hat.

7. Prüfen Sie in der Console die Firestore-Datenbank, um die Datensätze zu überprüfen, die erstellt wurde, zu dem Bereich, dem Sie die Chat-App hinzugefügt haben, zu den Nutzern, die damit interagiert haben, und zu der von Ihnen erstellten User Story.

   Firestore aufrufen

8. Kehren Sie zu Google Chat zurück.

   Google Chat öffnen

9. Optional: Klicken Sie auf Bearbeiten, um die Story zu bearbeiten. Wenn Sie mit der Story zufrieden sind, klicken Sie auf Speichern.
10. Testen Sie jeden von der App unterstützten Slash-Befehl. Geben Sie / ein oder erwähnen Sie die Chat-App, um sie zu sehen.
11. Löschen Sie die Test-User Story mit dem Befehl /cleanupUserStories. Alternativ können Sie die App entfernen oder deinstallieren. Wenn Sie die App entfernen, werden alle in diesem Gruppenbereich erstellten User Storys gelöscht.

Fehlerbehebung

Wenn eine Google Chat-App oder Karte einen Fehler zurückgibt, wird in der Chat-Benutzeroberfläche die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann nicht verarbeitet werden.“ Manchmal wird in der Chat-UI keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte liefert ein unerwartetes Ergebnis. So kann z. B. keine Kartenmeldung angezeigt werden.

Obwohl eine Fehlermeldung möglicherweise nicht in der Chat-UI angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, um Sie beim Beheben von Fehlern zu unterstützen, wenn das Fehler-Logging für Chat-Apps aktiviert ist. Informationen zum Ansehen, Debuggen und Beheben von Fehlern finden Sie unter Google Chat-Fehler beheben.

Bereinigen

Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, sollten Sie das Cloud-Projekt löschen.

1. Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Menü menu > IAM und Verwaltung > Ressourcen verwalten.

   Zu Resource Manager

2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen delete.
3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Beenden, um das Projekt zu löschen.

Weitere Informationen

• Antworten auf Fragen basierend auf Chat-Unterhaltungen mit einer KI-Chat-App von Gemini
• Mit Google Chat, Vertex AI und Apps Script auf Vorfälle reagieren