クイックスタート: Dialogflow CX の設定

このガイドでは、Dialogflow CX の使用開始に必要なすべての設定手順について説明します。

準備

このガイドを読む前に、次の手順を行ってください。

  1. Dialogflow CX の基本をご覧ください。
  2. エディションをご覧ください。

Google Cloud Console について

Google Cloud Console(ドキュメントを表示コンソールを開く)は、Google Cloud プロダクトを使用するシステムのプロビジョニング、構成、管理、モニタリングに使用されるウェブ UI です。Google Cloud Console を使用して、Dialogflow リソースを設定して管理します。

プロジェクトを作成

Google Cloud が提供するサービスを使用するには、プロジェクトを作成する必要があります。プロジェクトを使用して、すべての Google Cloud のリソースがまとめられます。プロジェクトは、共同編集者、有効化された API などのリソース、モニタリング ツール、お支払い情報、認証とアクセス制御で構成されます。1 つのプロジェクトを作成できるほか、複数のプロジェクトを作成してリソース階層内で Google Cloud リソースを構成することもできます。プロジェクトを作成する際は、プロジェクト ID をメモしてください。API 呼び出しを行うには、この ID が必要です。プロジェクトの詳細については、Resource Manager ドキュメントをご覧ください。

Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

プロジェクト セレクタに移動

課金を有効にする

請求先アカウントは、特定のリソースセットに対して誰が支払うかを定義するために使用され、1 つ以上のプロジェクトにリンクできます。 プロジェクトの利用料金は、リンクされた請求先アカウントに請求されます。ほとんどの場合、プロジェクトの作成時に請求情報を構成します。詳細については、お支払いとご請求に関するドキュメントをご覧ください。

Cloud プロジェクトに対して課金が有効になっていることを確認します。詳しくは、プロジェクトで課金が有効になっているかどうかを確認する方法をご覧ください。

API を有効にする

Dialogflow API をプロジェクトで有効にする必要があります。 API の有効化の詳細については、サービス使用状況のドキュメントをご覧ください。

Dialogflow API を有効にします。

API を有効にする

認証を設定する

Dialogflow API を使用する場合は、認証を設定する必要があります。API を使用するクライアント アプリケーションは、認証の対象であり、リクエストされるリソースへのアクセス権が付与されている必要があります。このセクションでは、認証の重要なコンセプトと設定手順について説明します。詳細については、Google Cloud 認証の概要をご覧ください。

サービス アカウントについて

認証には複数のオプションがありますが、認証とアクセス制御にサービス アカウントを使用することをおすすめします。サービス アカウントでは、エンドユーザーではなく、アプリケーションの資格情報が提供されます。サービス アカウントはプロジェクトで所有されます。1 つのプロジェクトに対して多数のサービス アカウントを作成できます。詳細については、サービス アカウントについてをご覧ください。

ロールについて

ID で API を呼び出す場合、Google Cloud では、その ID が適切な権限を持っている必要があります。権限を付与するには、サービス アカウントにロールを付与します。詳細については、Identity and Access Management(IAM)のドキュメントをご覧ください。

Dialogflow API を試してみるには、[プロジェクト] > [オーナー] の役割を使用できます。これにより、サービス アカウントにプロジェクトへの完全アクセス権が付与されます。Dialogflow 固有の役割の詳細は、 Dialogflow アクセス制御ドキュメントをご覧ください。

サービス アカウントキーについて

サービス アカウントは、1 つまたは複数の公開鍵と秘密鍵のペアに関連付けられます。 新しい鍵ペアを作成すると、秘密鍵がダウンロードされます。秘密鍵は、API の呼び出し時に認証情報の生成に使用されます。秘密鍵のセキュリティと、キーのローテーションなどの他の管理操作は、ユーザーの責任になります。

サービス アカウントを作成し、秘密鍵ファイルをダウンロードする

サービス アカウントを作成します。

  1. コンソールで [サービス アカウントの作成] ページに移動します。

    [サービス アカウントの作成] に移動
  2. プロジェクトを選択します。
  3. [サービス アカウント名] フィールドに名前を入力します。この名前に基づいて [サービス アカウント ID] フィールドに値が入力されます。

    [サービス アカウントの説明] フィールドに説明を入力します。例: Service account for quickstart

  4. [作成して続行] をクリックします。
  5. プロジェクトへのアクセス権限を付与するには、サービス アカウントに次のロールを付与します。[プロジェクト] > [オーナー]

    [ロールを選択] リストでロールを選択します。

    ロールを追加するには、[別のロールを追加] をクリックして各ロールを追加します。

  6. [続行] をクリックします。
  7. [完了] をクリックして、サービス アカウントの作成を完了します。

    ブラウザ ウィンドウは閉じないでください。次のステップでこれを使用します。

サービス アカウント キーを作成します。

  1. コンソールで、作成したサービス アカウントのメールアドレスをクリックします。
  2. [キー] をクリックします。
  3. [鍵を追加]、[新しい鍵を作成] の順にクリックします。
  4. [作成] をクリックします。JSON キーファイルがパソコンにダウンロードされます。
  5. [閉じる] をクリックします。

環境でサービス アカウント キー ファイルを使用する

環境変数 GOOGLE_APPLICATION_CREDENTIALS を設定して、アプリケーション コードに認証情報を指定します。この変数は、現在のシェル セッションにのみ適用されます。この変数を新しいシェル セッションに適用する場合は、シェル起動ファイル(~/.bashrc ファイルや ~/.profile ファイルなど)で変数を設定します。

Linux または macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。

例:

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

Windows

PowerShell の場合:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。

例:

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

コマンド プロンプトの場合:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

KEY_PATH をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。

gcloud CLI をインストールして初期化する

Dialogflow API の使用を計画している場合は、Google Cloud CLI をインストールして初期化する必要があります。gcloud CLI は、Google Cloud でホストされるリソースやアプリケーションの管理に使用できる一連のツールです。

次のリンクで手順を説明します。

Google Cloud CLI をインストールして初期化します。

gcloud CLI と認証をテストする

前の手順で認証を設定した場合は、gcloud ツールを使用して認証環境をテストできます。 次のコマンドを実行し、エラーが発生せず、認証情報が返されることを確認します。

gcloud auth application-default print-access-token

このコマンドは、すべての Dialogflow コマンドライン REST サンプルで API 呼び出しの認証に使用されます。

Dialogflow クライアント ライブラリをインストールする

クライアント ライブラリは、よく使われている複数の言語で利用できます。クライアント ライブラリをインストールするには、次の手順を使用します。

Java

Maven を使用している場合は、次のものを pom.xml ファイルに追加します。BOM の詳細については、Google Cloud Platform ライブラリ BOM をご覧ください。

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

Gradle を使用している場合は、次のものを依存関係に追加します。

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

sbt を使用している場合は、次のものを依存関係に追加します。

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

Visual Studio Code、IntelliJ または Eclipse を使用している場合は、次の IDE プラグインでプロジェクトにクライアント ライブラリを追加できます。

プラグインでは、サービス アカウントのキー管理などの追加機能も提供されます。詳細は各プラグインのドキュメントをご覧ください。

Node.js

npm install @google-cloud/dialogflow-cx

Python

pip install google-cloud-dialogflow-cx