Dialogflow CX-Einrichtung

In dieser Anleitung werden alle erforderlichen Einrichtungsschritte für die Verwendung von Dialogflow CX erläutert.

Hinweis

Bevor Sie diese Anleitung lesen, sollten Sie mit Folgendem vertraut sein:

  1. Dialogflow CX-Grundlagen
  2. Editionen

Informationen zur Google Cloud Console

Die Google Cloud Console (Dokumentation ansehen, Console öffnen) ist eine Web-UI zur Bereitstellung, Konfiguration, Verwaltung und Überwachung von Systemen, die Google Cloud-Produkte verwenden. Dialogflow-Ressourcen werden in der Google Cloud Console eingerichtet und verwaltet.

Projekt erstellen

Wenn Sie Dienste von Google Cloud nutzen möchten, müssen Sie ein Projekt erstellen. Es dient zur Organisation all Ihrer Google Cloud-Ressourcen. Ein Projekt umfasst Mitarbeiter, aktivierte APIs (und andere Ressourcen), Monitoring-Tools, Zahlungsinformationen sowie Authentifizierungs- und Zugriffssteuerungen. Sie können wahlweise ein Projekt erstellen oder Ihre Google Cloud-Ressourcen durch Erstellen mehrerer Projekte in einer Ressourcenhierarchie organisieren. Notieren Sie sich beim Erstellen eines Projekts die Projekt-ID. Diese ID benötigen Sie für API-Aufrufe. Weitere Informationen zu Projekten finden Sie in der Dokumentation zu Resource Manager.

Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

Zur Projektauswahl

Abrechnung aktivieren

In Rechnungskonten ist festgelegt, wer die Nutzungsgebühren für Ressourcen bezahlt. Ein Rechnungskonto kann mit einem oder mehreren Projekten verknüpft sein. Die Gebühren für die Projektnutzung werden dem verknüpften Rechnungskonto belastet. In den meisten Fällen konfigurieren Sie die Abrechnung beim Erstellen eines Projekts. Weitere Informationen finden Sie in der Dokumentation zur Abrechnung.

Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für Ihr Projekt aktiviert ist.

API aktivieren

Für Ihr Projekt müssen Sie die Dialogflow API aktivieren. Weitere Informationen zur Aktivierung von APIs finden Sie in der Dokumentation zu Service Usage.

Aktivieren Sie die Dialogflow API.

Aktivieren Sie die API

Authentifizierung einrichten

Wenn Sie vorhaben, die Dialogflow API zu verwenden, müssen Sie die Authentifizierung einrichten. Jede Client-Anwendung, die die API verwendet, muss authentifiziert sein und Zugriff auf die angeforderten Ressourcen haben. In diesem Abschnitt werden wichtige Konzepte der Authentifizierung erklärt und Schritte für die Einrichtung beschrieben. Weitere Informationen finden Sie in der Authentifizierungsübersicht für Google Cloud.

Informationen zu Dienstkonten

Für die Authentifizierung gibt es mehrere Möglichkeiten. Es wird jedoch empfohlen, für die Authentifizierung und die Zugriffssteuerung Dienstkonten zu verwenden. Die Anmeldedaten für ein Dienstkonto werden für Anwendungen vergeben, nicht für Endnutzer. Dienstkonten gehören zu Projekten. Sie können mehrere Dienstkonten für ein Projekt erstellen. Weitere Informationen finden Sie unter Details zu Dienstkonten.

Informationen zu Rollen

Wenn eine Identität eine API aufruft, wird von Google Cloud verlangt, dass die Identität über die entsprechenden Berechtigungen verfügt. Sie können Berechtigungen gewähren durch Zuweisen von Rollen für Dienstkonten. Weitere Informationen finden Sie in der Dokumentation zur Identitäts- und Zugriffsverwaltung (IAM).

Zum Testen der Dialogflow API können Sie in den folgenden Schritten die Rolle Projekt > Inhaber verwenden, mit der dem Dienstkonto vollständiger Zugriff auf das Projekt gewährt wird. Weitere Informationen zu den speziellen Rollen in Dialogflow finden Sie in der Dokumentation zur Zugriffssteuerung in Dialogflow.

Informationen zu Dienstkontoschlüsseln

Dienstkonten sind mit einem oder mehreren öffentlichen/privaten Schlüsselpaaren verbunden. Wenn Sie ein neues Schlüsselpaar erstellen, laden Sie den privaten Schlüssel herunter. Der private Schlüssel wird verwendet, um beim Aufrufen der API Anmeldedaten zu erzeugen. Die Verantwortung für die Sicherheit des privaten Schlüssels und andere Verwaltungsvorgänge wie die Schlüsselrotation liegt bei Ihnen.

Dienstkonto erstellen und Datei mit dem privaten Schlüssel herunterladen

Erstellen Sie ein Dienstkonto:

  1. Wechseln Sie in der Cloud Console zur Seite Dienstkonto erstellen.

    Zur Seite „Dienstkonto erstellen“
  2. Wählen Sie ein Projekt aus.
  3. Geben Sie im Feld Dienstkontoname einen Namen ein. Die Cloud Console füllt das Feld Dienstkonto-ID basierend auf diesem Namen aus.

    Geben Sie im Feld Dienstkontobeschreibung eine Beschreibung ein. Beispiel: Service account for quickstart.

  4. Klicken Sie auf Erstellen und fortfahren.
  5. Klicken Sie auf das Feld Rolle auswählen.

    Klicken Sie unter Schnellzugriff auf Einfach und dann auf Inhaber.

  6. Klicken Sie auf Weiter.
  7. Klicken Sie auf Fertig, um das Erstellen des Dienstkontos abzuschließen.

    Schließen Sie das Browserfenster nicht. Sie verwenden es in der nächsten Aufgabe.

Dienstkontoschlüssel erstellen

  1. Klicken Sie in der Cloud Console auf die E-Mail-Adresse des von Ihnen erstellten Dienstkontos.
  2. Klicken Sie auf Schlüssel.
  3. Klicken Sie auf Schlüssel hinzufügen > Neuen Schlüssel erstellen.
  4. Klicken Sie auf Erstellen. Daraufhin wird eine JSON-Schlüsseldatei auf Ihren Computer heruntergeladen.
  5. Klicken Sie auf Schließen.

Schlüsseldatei des Dienstkontos in Ihrer Umgebung verwenden

Die Anmeldedaten zur Authentifizierung für Ihren Anwendungscode geben Sie durch Festlegung der Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS an. Diese Variable gilt nur für Ihre aktuelle Shell-Sitzung. Wenn Sie eine neue Sitzung öffnen, müssen Sie die Variable neu festlegen.

Linux oder macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

Beispiel:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

Für PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

Beispiel:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

Für Eingabeaufforderung:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

Cloud SDK installieren und initialisieren

Wenn Sie vorhaben, die Dialogflow API zu verwenden, müssen Sie das Cloud SDK installieren und initialisieren. Das Cloud SDK umfasst mehrere Tools, mit denen Sie auf Google Cloud gehostete Ressourcen und Anwendungen verwalten können. Dazu gehört auch das gcloud-Befehlszeilentool.

Unter folgendem Link finden Sie eine Anleitung:

Installieren und initialisieren Sie das Cloud SDK.

SDK und Authentifizierung testen

Wenn Sie in den vorangegangenen Schritten die Authentifizierung eingerichtet haben, können Sie Ihre Authentifizierungsumgebung mit dem Tool 'gcloud' testen. Führen Sie folgenden Befehl aus und achten Sie darauf, dass kein Fehler auftritt und Anmeldedaten zurückgegeben werden:

gcloud auth application-default print-access-token

Dieser Befehl wird in allen REST-Beispielen für die Dialogflow-Befehlszeile verwendet, um API-Aufrufe zu authentifizieren.

Dialogflow-Clientbibliothek installieren

Clientbibliotheken sind für mehrere gängige Sprachen verfügbar. So installieren Sie eine Clientbibliothek:

Java

Wenn Sie Maven verwenden, fügen Sie Ihrer Datei pom.xml den folgenden Code hinzu. Weitere Informationen zu BOMs finden Sie unter The Google Cloud Platform Libraries BOM.

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-dialogflow-cx</artifactId>
  <version>0.10.1</version>
</dependency>

Wenn Sie Gradle verwenden, fügen Sie den Abhängigkeiten Folgendes hinzu:

implementation 'com.google.cloud:google-cloud-dialogflow-cx:0.10.1'

Wenn Sie sbt nutzen, fügen Sie den Abhängigkeiten Folgendes hinzu:

libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.10.1"

Wenn Sie Visual Studio Code, IntelliJ oder Eclipse verwenden, können Sie Ihrem Projekt mithilfe der folgenden IDE-Plug-ins Clientbibliotheken hinzufügen:

Diese Plug-ins bieten zusätzliche Funktionen wie die Schlüsselverwaltung für Dienstkonten. Einzelheiten finden Sie in der Dokumentation der einzelnen Plug-ins.

Node.js

npm install @google-cloud/dialogflow-cx

Python

pip install google-cloud-dialogflow-cx