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

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

始める前に

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Enable the Vertex AI API.

   Enable the API

4. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the Project > Owner role to the service account.

      To grant the role, find the Select a role list, then select Project > Owner.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
   6. Click Continue.

   7. Click Done to finish creating the service account.

      Do not close your browser window. You will use it in the next step.

5. Create a service account key:

   1. In the Google Cloud console, click the email address for the service account that you created.
   2. Click Keys.
   3. Click Add key, and then click Create new key.
   4. Click Create. A JSON key file is downloaded to your computer.
   5. Click Close.

6. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

   Example: Linux or macOS

   export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

   For example:

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

   Example: Windows

   For PowerShell:

   $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

   For example:

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

   For command prompt:

   set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Enable the Vertex AI API.

   Enable the API

9. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the Project > Owner role to the service account.

      To grant the role, find the Select a role list, then select Project > Owner.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
   6. Click Continue.

   7. Click Done to finish creating the service account.

      Do not close your browser window. You will use it in the next step.

10. Create a service account key:

    1. In the Google Cloud console, click the email address for the service account that you created.
    2. Click Keys.
    3. Click Add key, and then click Create new key.
    4. Click Create. A JSON key file is downloaded to your computer.
    5. Click Close.

11. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

    Example: Linux or macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

    For example:

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

    Example: Windows

    For PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

    For example:

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

    For command prompt:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

クライアント ライブラリ

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 リファレンス