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. Cloud Console で [サービス アカウントの作成] ページに移動します。

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

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

    4. [作成して続行] をクリックします。
    5. [ロールを選択] フィールドをクリックします。

      [クイック アクセス] で [基本]、[オーナー] の順にクリックします。

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

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

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

    1. Cloud Console で、作成したサービス アカウントのメールアドレスをクリックします。
    2. [キー] をクリックします。
    3. [鍵を追加]、[新しい鍵を作成] の順にクリックします。
    4. [作成] をクリックします。JSON キーファイルがパソコンにダウンロードされます。
    5. [閉じる] をクリックします。
  6. 環境変数 GOOGLE_APPLICATION_CREDENTIALS を、サービス アカウント キーが含まれる JSON ファイルのパスに設定します。 この変数は現在のシェル セッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定します。

クライアント ライブラリ

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

Java

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

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

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

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

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

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

コードサンプルを試す

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

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

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

Node.js

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

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

npm install @google-cloud/aiplatform

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

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

Python

Vertex SDK for Python

Vertex AI 用 Python クライアント ライブラリは、Vertex SDK for Python という名前に変わりました。バージョン 0.7(プレビュー)のリリースに伴い、Vertex SDK for Python は 2 つのレベルのサポートを提供します。高レベルの aiplatform ライブラリでは、ラッパークラスと独自のデフォルト値により、一般的なデータ サイエンス ワークフローを簡略化するように設計されています。柔軟な制御や、高レベルのライブラリでサポートされていないメソッドが必要な場合は、引き続き低レベルの aiplatform.gapic ライブラリを利用できます。

Vertex SDK for Python をインストールすると、両方のサポートレベルを使用できます。同じワークフローで aiplatform 呼び出しと aiplatform.gapic 呼び出しを混在させる場合は、それぞれの初期化手順が異なることに注意してください。これらの呼び出しは個別に初期化する必要があります。

インストールの前に

Vertex SDK for Python をインストールする前に、プロジェクトごとに隔離された Python 環境を作成することをおすすめします。venv 環境を有効にするか、別の方法で隔離された Python 環境を作成します。

Google Cloud と連携する Python 開発環境の設定方法を学習します。

もう 1 つの方法は、このプロジェクト用に Notebooks インスタンスを作成することです。ノートブックで作業している場合は、ノートブックのインスタンスまたは環境に Vertex SDK for Python をインストールします。

Vertex SDK for Python をインストールして初期化する

仮想環境で以下のコマンドを実行して、Vertex SDK for Python をインストールします。

YOUR_ENVIRONMENT/bin/pip install google-cloud-aiplatform

次のコードサンプルは、Python コードでライブラリを初期化する方法を示しています。

def init_sample(
    project: Optional[str] = None,
    location: Optional[str] = None,
    experiment: Optional[str] = None,
    staging_bucket: Optional[str] = None,
    credentials: Optional[auth_credentials.Credentials] = None,
    encryption_spec_key_name: Optional[str] = None,
):
    aiplatform.init(
        project=project,
        location=location,
        experiment=experiment,
        staging_bucket=staging_bucket,
        credentials=credentials,
        encryption_spec_key_name=encryption_spec_key_name,
    )

コードサンプルを試す

いくつかの Jupyter ノートブック形式のチュートリアルでは、より大規模なワークフローの一部として Vertex SDK for Python を使用する方法を説明しています。

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

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

詳細については、Vertex SDK for Python のドキュメントをご覧ください。