設定とクリーンアップ

このガイドでは、CX Agent Studio の使用開始に必要なすべての設定手順について説明します。 また、エージェントの試行後またはテスト後のクリーンアップ手順に関するアドバイスも示します。

コンソールについて Google Cloud

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

プロジェクトを作成

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

コンソールのプロジェクト セレクタページで、プロジェクトを選択または作成します。 Google Cloud Google Cloud

プロジェクトを選択または作成するために必要なロール

  • プロジェクトを選択する: プロジェクトの選択に特定の IAM ロールは必要ありません。ロールが付与されているプロジェクトを選択できます。
  • プロジェクトを作成する: プロジェクトを作成するには、プロジェクト作成者ロール （roles/resourcemanager.projectCreator）が必要です。これには resourcemanager.projects.create 権限が含まれています。詳しくは、ロールを付与する方法をご覧ください。

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

課金を有効にする

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

プロジェクト Google Cloud で課金が有効になっていることを確認します。

API を有効にする

プロジェクトで Gemini Enterprise for Customer Experience API を有効にする必要があります。 API の有効化の詳細については、 Service Usage のドキュメントをご覧ください。

Gemini Enterprise for Customer Experience API を有効にします。

API を有効にするために必要なロール

API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。詳しくは、ロールを付与する方法をご覧ください。

API を有効にする

監査ログを有効にする

プロジェクトで Gemini Enterprise for Customer Experience API のデータアクセス監査 ログを有効にします。バージョンとともに、監査ログは、プロジェクトに関連付けられた CX Agent Studio エージェント アプリケーションのデザイン時の変更を追跡するのに役立ちます。

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

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

次のリンク先に手順が記載されています。

Google Cloud CLI をインストールします。 インストール後、 初期化するには、次のコマンドを実行して Google Cloud CLI を初期化します。 

gcloud init

外部 ID プロバイダ（IdP）を使用している場合は、まず フェデレーション ID を使用して gcloud CLI にログインする必要があります。

認証とアクセス制御を設定する

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

ユーザー アカウントによる認証

Gemini Enterprise for Customer Experience API の学習時やローカルでの開発時には、ユーザー アカウントが最適な認証オプションです。ユーザー アカウントを使用して、REST コマンドラインの実行またはクライアント ライブラリの呼び出しの認証を行うことができます。

REST コマンドライン ユーザー アカウントの認証

REST コマンドラインの呼び出しの認証には、gcloud CLI を使用します。gcloud auth login コマンドは、ユーザー アカウントを使用して gcloud にログインします。この作業は、API を呼び出す前に行う必要があります。このドキュメントの REST コマンドラインのサンプル全体で、gcloud auth print-access-token コマンドは REST 呼び出しの認証に使用します。

ローカル環境のユーザー認証情報を作成するには:

gcloud auth login

クライアント ライブラリのユーザー アカウントの認証

クライアント ライブラリの呼び出しを認証するには、gcloud CLI を使用します。gcloud auth application-default login コマンドは、アプリケーションのデフォルト認証情報を使用するために、ユーザー アカウントを使用して gcloud にログインします。この操作は、API を呼び出す前に行う必要があります。 API 呼び出しに関連する請求と割り当て用のプロジェクトを設定するには、gcloud auth application-default set-quota-project コマンドを使用する必要があります。これは通常、エージェントが使用するプロジェクトと同じです。また、前の手順で作成したプロジェクトのプロジェクト ID を指定します。

アプリケーションのデフォルト認証情報をクライアント ライブラリで使用できるようにするため、GOOGLE_APPLICATION_CREDENTIALS 環境変数を設定しないでください。

ローカル環境のアプリケーションのデフォルト認証情報を作成するには:

gcloud auth application-default login
gcloud auth application-default set-quota-project PROJECT_ID

サービス アカウントによる認証

サービス アカウントでは、エンドユーザーではなく、アプリケーションの認証情報が提供されます。サービス アカウントはプロジェクトで所有されます。1 つのプロジェクトに対して多数のサービス アカウントを作成できます。詳細については、次をご覧ください。

ロールを使用したアクセス制御

Google Cloud では、プリンシパル（ユーザー アカウント、サービス アカウントなど）が API を呼び出す場合、プリンシパルに適切な権限が割り当てられている必要があります。権限を付与するには、プリンシパルにロールを付与します。詳細については、 ロールの概要をご覧ください。

ユーザー アカウントを使用してプロジェクトを作成した場合は、ユーザー アカウントにプロジェクトのオーナーの基本ロールが付与されています。このロールは、プロジェクトの API を呼び出すためのアクセス権を付与します。ただし、別のアカウントでプロジェクトを作成した場合、 API を呼び出す前にユーザーアカウントにロールを付与する必要があります。

CX Agent Studio Agents クライアント ライブラリをインストールする

ライブラリのダウンロードとインストール手順については、 クライアント ライブラリをご覧ください。

クリーンアップ

CX Agent Studio を設定して試した後、 作成したリソースの削除が必要になる場合があります:

  • プロジェクトをシャットダウンすることもできます。
  • gcloud auth login を呼び出すと、パソコンのユーザー ディレクトリに認証情報が保存されます。これらの認証情報は、以下を呼び出して削除できます。
    gcloud auth revoke
  • gcloud auth application-default login を呼び出すと、パソコンのユーザー ディレクトリに認証情報が保存されます。これらの認証情報は、以下を呼び出して削除できます。
    gcloud auth application-default revoke