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

クライアント ライブラリを使用すると、Vertex AI API を呼び出すデベロッパーに最適化された体験を提供できます。クライアント ライブラリは、対応している各言語の自然な規則を使用して、記述が必要なボイラープレート コードの量を減らします。次のガイドでは、クライアント ライブラリをインストールする方法について説明します。

始める前に

1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

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

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

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

3. Vertex AI API を有効にします。

   API を有効にする

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

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

      [サービス アカウントの作成] に移動
   2. プロジェクトを選択します。

   3. [サービス アカウント名] フィールドに名前を入力します。Google Cloud コンソールでは、この名前に基づいて [サービス アカウント ID] フィールドに値が設定されます。

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

   4. [作成して続行] をクリックします。

   5. サービス アカウントに Project > Owner ロールを付与します。

      ロールを付与するには、[ロールを選択] リストで [Project > Owner] を選択します。

      注: [ロール] フィールドは、サービス アカウントがプロジェクト内のどのリソースにアクセスできるかに影響します。これらのロールは後で取り消すことも、追加のロールを付与することもできます。本番環境では、オーナー、編集者、閲覧者のロールを付与しないでください。代わりに、ニーズに合わせて事前定義ロールまたはカスタムロールを付与します。
   6. [続行] をクリックします。

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

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

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

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

6. 環境変数 GOOGLE_APPLICATION_CREDENTIALS を、認証情報を含む JSON ファイルのパスに設定します。この変数は現在のシェル セッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定する必要があります。

   例: 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 ファイルのパスに置き換えます。

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

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

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

8. Vertex AI API を有効にします。

   API を有効にする

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

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

      [サービス アカウントの作成] に移動
   2. プロジェクトを選択します。

   3. [サービス アカウント名] フィールドに名前を入力します。Google Cloud コンソールでは、この名前に基づいて [サービス アカウント ID] フィールドに値が設定されます。

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

   4. [作成して続行] をクリックします。

   5. サービス アカウントに Project > Owner ロールを付与します。

      ロールを付与するには、[ロールを選択] リストで [Project > Owner] を選択します。

      注: [ロール] フィールドは、サービス アカウントがプロジェクト内のどのリソースにアクセスできるかに影響します。これらのロールは後で取り消すことも、追加のロールを付与することもできます。本番環境では、オーナー、編集者、閲覧者のロールを付与しないでください。代わりに、ニーズに合わせて事前定義ロールまたはカスタムロールを付与します。
   6. [続行] をクリックします。

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

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

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

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

11. 環境変数 GOOGLE_APPLICATION_CREDENTIALS を、認証情報を含む JSON ファイルのパスに設定します。この変数は現在のシェル セッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定する必要があります。

    例: 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 ファイルのパスに置き換えます。

クライアント ライブラリ

Vertex AI には、次の言語のクライアント ライブラリが用意されています。使用する言語を選択します。

C#

次のコマンドを実行して、Google.Cloud.AIPlatform.V1 パッケージ リファレンスをプロジェクト ファイルに追加します。

dotnet add package Google.Cloud.AIPlatform.V1

コードサンプルを試す

個別のコードサンプルを表示または取得する場合は、dotnet-aiplatform GitHub リポジトリに移動してください。

クライアント ライブラリのドキュメント

詳細については、Vertex AI .NET クライアント ライブラリのドキュメントをご覧ください。

Java

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

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-aiplatform</artifactId>
  <version>3.35.0</version>
</dependency>

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

compile 'com.google.cloud:google-cloud-aiplatform:3.35.0'

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

libraryDependencies += "com.google.cloud" % "google-cloud-aiplatform" % "3.35.0"

コードサンプルを試す

個別のコードサンプルを表示または取得する場合は、java-aiplatform GitHub リポジトリに移動してください。

クライアント ライブラリのドキュメント

詳細については、Java 用 Vertex AI クライアント ライブラリのドキュメントをご覧ください。

Node.js

ライブラリをインストールする前に、Node.js 開発用の環境を準備します。

使用している環境で次のコマンドを実行して、クライアント ライブラリをインストールします。

npm install @google-cloud/aiplatform

クライアント ライブラリのドキュメント

詳細については、Node.js 用 Vertex AI クライアント ライブラリのドキュメントをご覧ください。

Python

Vertex AI SDK for Python をインストールすると、Vertex AI Python クライアント ライブラリがインストールされます。

詳細については、Vertex AI SDK for Python をインストールするをご覧ください。

Go

ライブラリをインストールする前に、Go 開発用の環境を準備します。

利用可能なパッケージを確認する

利用可能な Vertex AI API Go パッケージを確認して、プロジェクトのニーズに最適なパッケージを判断します。

• パッケージ cloud.google.com/go/vertexai（推奨）

  vertexai は人の手で作成されたパッケージであり、このパッケージを使うことで一般的な機能を利用することができます。

  Vertex AI API を使ってアプリを構築するほとんどのデベロッパーの方に、足がかりとしておすすめのパッケージです。このパッケージにまだ含まれていない機能を利用するには、自動生成された aiplatform を使用してください。

• パッケージ cloud.google.com/go/aiplatform

  aiplatform は自動生成されたパッケージです。

  このパッケージは、人の手によって作成された vertexai パッケージではまだ提供されていない Vertex AI API 機能を使用する必要があるプロジェクトを対象としています。

インストール

• パッケージ cloud.google.com/go/vertexai（推奨）

  次のコマンドを実行して、このパッケージを環境にインストールします。

  go get cloud.google.com/go/vertexai
  

• パッケージ cloud.google.com/go/aiplatform

  次のコマンドを実行して、このパッケージを環境にインストールします。

  go get cloud.google.com/go/aiplatform
  

サンプル

• パッケージ cloud.google.com/go/vertexai（推奨）

  このパッケージの使用サンプルは、golang-samples GitHub リポジトリの最上位の vertexai ディレクトリにあります。

  github.com/GoogleCloudPlatform/golang-samples > vertexai

• パッケージ cloud.google.com/go/aiplatform

  このパッケージの使用サンプルは、golang-samples GitHub リポジトリの最上位の aiplatform ディレクトリにあります。

  github.com/GoogleCloudPlatform/golang-samples > aiplatform

クライアント ライブラリのドキュメント

ライブラリの詳細については、Go 用 Vertex AI クライアント ライブラリのドキュメントをご覧ください。

• パッケージ cloud.google.com/go/vertexai（推奨）

  • Vertex AI cloud.google.com/go/vertexai API リファレンス

• パッケージ cloud.google.com/go/aiplatform

  • Vertex AI cloud.google.com/go/aiplatform v1 API リファレンス
  • Vertex AI cloud.google.com/go/aiplatform v1beta1 API リファレンス