GitHub exportieren/wiederherstellen

Konversations-Agents (Dialogflow CX) lassen sich in GitHub einbinden. Mit dieser Integration können Sie Ihren Agenten ganz einfach in JSON exportieren, um ihn auf GitHub hochzuladen, und ihn von GitHub abrufen, um ihn wiederherzustellen. Das exportierte JSON-Format, das an GitHub gesendet wurde ist der Inhalt der maximierten ZIP-Datei des exportierten Agents.

Mit dieser Funktion können Sie die folgenden Funktionen der GitHub-Versionsverwaltung nutzen:

Beschränkungen

Es gelten folgende Einschränkungen:

  • GitHub hat eine Geschwindigkeitsbeschränkung für die Anzahl der Anfragen pro Stunde (5.000 für Nicht-Enterprise-Konten, 15.000 für Enterprise-Konten). Wenn Ihr Agent-Push dieses Limit überschreitet, meldet die Dialogflow CX-Konsole den Ratenbegrenzungsfehler. Sie können nach einer Stunde noch einmal versuchen, die Übertragung durchzuführen.
  • Die GitHub APIs haben eine Beschränkung für die Anzahl der Dateien, die in einem einzelnen Commit aktualisiert werden können. Wenn die Anzahl der Dateien 500 übersteigt, können Sie möglicherweise nicht von Conversational Agents (Dialogflow CX) aus auf GitHub pushen. In solchen Fällen können Sie
    den Agent als ZIP-Datei und verwenden Sie die Git-Befehlszeile auf Ihrem Computer, um die Agent-Dateien per Push an GitHub zu übertragen. Diese Einschränkung wird in einem späteren Release für Conversational Agents (Dialogflow CX) behandelt.
  • Privater Zugriff selbst gehostet werden Repositories nicht unterstützt, da Conversational Agents (Dialogflow CX) keinen Zugriff auf diese Repositories haben.
  • Das GitHub-Repository darf keine anderen Dateien als die vom Agentenexport exportierten Agentendateien enthalten. Alle anderen Dateien im Repository werden bei jedem Push entfernt.

Konfiguration

So konfigurieren Sie diese Integration:

  1. Öffnen Sie die Dialogflow CX-Konsole.
  2. Wählen Sie Ihr Google Cloud-Projekt aus.
  3. Wählen Sie den Agent aus.
  4. Klicke auf den Tab Verwalten.
  5. Klicken Sie im Abschnitt Testing & Deployment (Testen und Bereitstellen) auf Git.
  6. Klicken Sie auf Git-Integration hinzufügen. Daraufhin wird ein Konfigurationsdialogfeld geöffnet.
  7. Geben Sie Folgendes ein:
    • Anzeigename für die GitHub-Verbindung.
    • GitHub-Repository-URL (z. B. https://api.github.com/repos/<repository_owner>/<repository_name>).
    • Fügen Sie GitHub-Branches hinzu, mit denen Ihr Kundenservicemitarbeiter interagieren wird. Sie können einen Branch als Standardbranch festlegen, indem Sie neben ihm auf das Sternsymbol klicken.
    • Das persönliche GitHub-Token kann nach der Einrichtung nicht mehr aufgerufen werden. Es werden nur Updates unterstützt. Wenn Sie ein detailliertes persönliches Zugriffstoken verwenden, benötigen Sie die folgenden Berechtigungen:
      • Repository-Berechtigungen > Inhalt: Lesen und Schreiben
      • Repository-Berechtigungen > Metadaten: Schreibgeschützt (sollte automatisch ausgewählt werden) nachdem Sie die Berechtigung „Inhaltsverzeichnis“ ausgewählt haben.
  8. Klicken Sie auf Verbinden.

Diese Konfiguration kann jederzeit geändert werden, indem Sie auf das Bearbeitungssymbol klicken.

Push und Wiederherstellen

Nach der Konfiguration können Sie den Agent per Push oder Pull an GitHub übertragen bzw. daraus abrufen.

Über die Schaltfläche Push können Sie Ihren Agenten exportieren und einen Commit für den im Drop-down-Menü „Git-Branch“ ausgewählten GitHub-Branch vornehmen. Dieser Commit besteht aus dem gesamten Agenten und nicht aus bestimmten Änderungen. Außerdem werden alle vorhandenen Dateien im Repository gelöscht.

Achten Sie bei neuen Repositories darauf, dass mindestens ein Commit aus GitHub vorhanden ist bevor Sie die Push-Option in der Dialogflow CX-Konsole verwenden.

Nutzer mit der Rolle Dialogflow Reader können Push-Vorgänge auf GitHub-Repositories ausführen. Konfigurieren Sie diese Agents mit Lesezugriff, um unerwünschte Push-Nachrichten zu vermeiden persönliche Zugriffstokens.

Über die Schaltfläche Wiederherstellen können Sie die Agent-Daten aus dem GitHub-Branch abrufen, der im Drop-down-Menü „Git-Branch“ ausgewählt ist, und Ihren Conversational AI (Dialogflow CX)-Agenten anhand dieser Daten wiederherstellen. Dadurch wird Ihr Agent auf die gleiche Weise überschrieben wie bei jeder Agentwiederherstellung.

Anwendungsbeispiel

Im folgenden Beispiel wird gezeigt, wie diese Funktion von mehreren Personen verwendet werden kann, um einem Produktionsmitarbeiter verschiedene Änderungen vorzuschlagen.

Ihr Agent verwendet die folgenden GitHub-Zweige:

  • Prod: Zweig für den Produktions-Agent
  • Dev1: Zweig für die Agent-Entwicklung
  • Dev2: ein weiterer Branch für die Entwicklung von Kundenservicemitarbeitern

Nutzer 1 möchte Änderungen an einem Kundenservicemitarbeiter vorschlagen und führt dazu die folgenden Schritte aus:

  1. Exportieren Sie den Produktions-Agent in einen neuen Agent.
  2. Nehmen Sie die gewünschten Änderungen an diesem Kundenservicemitarbeiter-Text vor.
  3. Testen Sie die Änderungen.
  4. Übertragen Sie den geänderten Agenten per Push auf den Dev1-Zweig.
  5. Erstellen Sie eine Zusammenführungsanfrage für den Prod-Branch.

Nutzer 2 möchte Änderungen an einem Kundenservicemitarbeiter vorschlagen und führt dazu die folgenden Schritte aus:

  1. Exportieren Sie den Produktions-Agenten in einen neuen Agenten.
  2. Nehmen Sie die gewünschten Änderungen an diesem Kundenservicemitarbeiter-Text vor.
  3. Testen Sie die Änderungen.
  4. Übertragen Sie den geänderten Agenten per Push auf den Dev2-Zweig.
  5. Erstellen Sie eine Zusammenführungsanfrage für den Prod-Branch.

Nutzer 3 prüft Zusammenführungsanfragen von beiden Nutzern und führt die folgenden Schritte aus:

  1. Konflikte lösen
  2. Genehmigte Änderungen werden übernommen.
  3. Stellt den GitHub-Zweig für die Produktion im Conversational Agents-Agent (Dialogflow CX) der Produktion wieder her.