このガイドでは、Dialogflow CX の使用開始に必要なすべての設定手順について説明します。 また、Dialogflow を試行またはテストした後に発生する可能性のあるクリーンアップ手順に関するアドバイスも提供します。
始める前に
このガイドを読む前に、次の手順を行ってください。
- Dialogflow CX の基本をご覧ください。
- エディションをご覧ください。
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 の有効化の詳細については、Service Usage のドキュメントをご覧ください。
Dialogflow API を有効にします。
Google Cloud CLI をインストールして初期化する
Dialogflow API の使用を計画している場合は、Google Cloud CLI をインストールして初期化する必要があります。gcloud CLI は、Google Cloud でホストされるリソースやアプリケーションの管理に使用できる一連のツールです。
次のリンクで手順を説明します。
Google Cloud CLI をインストールして初期化します。認証とアクセス制御を設定します。
Dialogflow API を使用する場合は、認証を設定する必要があります。API を使用するクライアント アプリケーションは、認証の対象であり、リクエストされるリソースへのアクセス権が付与されている必要があります。このセクションでは、認証の重要なコンセプトと設定手順について説明します。詳細については、Google Cloud 認証の概要をご覧ください。
ユーザー アカウントを使用した認証
ユーザー アカウントは、Dialogflow API の学習とローカル開発のための最適な認証オプションです。 ユーザー アカウントを使用して、REST コマンドラインの実行またはクライアント ライブラリ呼び出しの認証を行うことができます。
REST コマンドライン ユーザー アカウントの認証
REST コマンドライン呼び出しに対して認証を行うには、gcloud CLI を使用します。 gcloud auth login コマンドは、ユーザー アカウントを使用して gcloud にログインします。これは、API を呼び出す前に行う必要があります。 gcloud auth print-access-token コマンドは、このドキュメントの REST コマンドライン サンプル全体を通して REST 呼び出しの認証に使用されます。
ローカル環境用のユーザー認証情報を作成するには:
gcloud auth login
クライアント ライブラリのユーザー アカウント認証
クライアント ライブラリの呼び出しを認証するには、gcloud CLI を使用します。
gcloud auth application-default loginこのコマンドは、ユーザー アカウントを使用してアプリケーションのデフォルト認証情報の gcloud にログインします。これは、API を呼び出す前に行う必要があります。 gcloud auth application-default set-quota-project コマンドを使用して、プロジェクトの課金と API 呼び出しに関連する割り当てを設定する必要があります。 通常、これはエージェントによって使用されるプロジェクトと同じものであり、上記の手順で作成したプロジェクトのプロジェクト ID を指定します。
クライアント ライブラリでアプリケーションのデフォルト認証情報を使用するには、GOOGLE_APPLICATION_CREDENTIALS 環境変数を設定しないでください。
ローカル環境用のアプリケーションのデフォルト認証情報を作成するには、次の手順に従います。
gcloud auth application-default login gcloud auth application-default set-quota-project PROJECT_ID
サービス アカウントによる認証
サービス アカウントも、本番環境やステージングなどの安全な環境でのみ使用する必要がある別の認証オプションです。 サービス アカウントでは、エンドユーザーではなく、アプリケーションの資格情報が提供されます。サービス アカウントはプロジェクトで所有されます。1 つのプロジェクトに対して多数のサービス アカウントを作成できます。関連ページ
ロールによるアクセス制御
プリンシパル（ユーザー アカウントやサービス アカウントなど）が API を呼び出す場合、そのプリンシパルには適切な権限が必要です。 プリンシパルに役割を付与することで、権限を付与できます。 詳細については、ロールの概要をご覧ください。
ユーザー アカウントを使用してプロジェクトを作成した場合は、ユーザー アカウントにプロジェクトのオーナーの基本ロールが割り当てられます。 この役割は、プロジェクトの任意の API を呼び出すためのアクセス権を付与します。 ただし、別のアカウントでプロジェクトを作成した場合は、API を呼び出す前にロールをユーザー アカウントに付与する必要があります。 手順については、Dialogflow アクセス制御ガイドをご覧ください。
Dialogflow クライアント ライブラリをインストールする
API を呼び出す方法として、Google がサポートするクライアント ライブラリ、REST、および gRPC の 3 つのオプションがあります。
クライアント ライブラリは、よく使われている複数の言語で利用できます。 インストール手順については、クライアント ライブラリで目的の言語をご覧ください。
クリーンアップ
Dialogflow を設定してテストした後、作成したリソースを削除できます。
- エージェントを削除することもできます。
- プロジェクトをシャットダウンすることをおすすめします。
-
gcloud auth loginを呼び出すと、コンピュータのユーザー ディレクトリに認証情報が保存されます。 次の呼び出しを行うことで、これらの認証情報を削除できます。gcloud auth revoke
-
gcloud auth application-default loginを呼び出すと、コンピュータのユーザー ディレクトリに認証情報が保存されます。 次の呼び出しを行うことで、これらの認証情報を削除できます。gcloud auth application-default revoke