安装 Vertex AI 客户端库

客户端库为开发者提供调用 Vertex AI API 的优化体验。客户端库使用每种受支持的语言的自然惯例，并减少您必须编写的样板代码。以下指南介绍了其如何安装。

准备工作

1. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $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。

      注意：角色字段会影响服务帐号可以访问项目中的哪些资源。您可以撤消这些角色或稍后授予其他角色。在生产环境中，请勿授予 Owner、Editor 或 Viewer 角色。应授予满足您的需求的预定义角色或自定义角色。
   6. 点击继续。

   7. 点击完成以完成服务帐号的创建过程。

      不要关闭浏览器窗口。您将在下一步骤中用到它。

5. 创建服务帐号密钥：

   1. 在 Google Cloud 控制台中，点击您创建的服务帐号的电子邮件地址。
   2. 点击密钥。
   3. 点击添加密钥，然后点击创建新密钥。
   4. 点击创建。JSON 密钥文件将下载到您的计算机上。
   5. 点击关闭。

6. 将环境变量 GOOGLE_APPLICATION_CREDENTIALS 设置为包含凭据的 JSON 文件的路径。 此变量仅适用于当前的 shell 会话，因此，如果您打开新的会话，请重新设置该变量。

   示例：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。

      注意：角色字段会影响服务帐号可以访问项目中的哪些资源。您可以撤消这些角色或稍后授予其他角色。在生产环境中，请勿授予 Owner、Editor 或 Viewer 角色。应授予满足您的需求的预定义角色或自定义角色。
   6. 点击继续。

   7. 点击完成以完成服务帐号的创建过程。

      不要关闭浏览器窗口。您将在下一步骤中用到它。

10. 创建服务帐号密钥：

    1. 在 Google Cloud 控制台中，点击您创建的服务帐号的电子邮件地址。
    2. 点击密钥。
    3. 点击添加密钥，然后点击创建新密钥。
    4. 点击创建。JSON 密钥文件将下载到您的计算机上。
    5. 点击关闭。

11. 将环境变量 GOOGLE_APPLICATION_CREDENTIALS 设置为包含凭据的 JSON 文件的路径。 此变量仅适用于当前的 shell 会话，因此，如果您打开新的会话，请重新设置该变量。

    示例：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 Python 客户端库会在您安装 Python 版 Vertex AI SDK 时安装。

如需了解详情，请参阅安装 Python 版 Vertex AI SDK。

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（推荐）

  顶级 vertexai 目录的 golang-samples GitHub 代码库中提供了使用此软件包的示例：

  github.com/GoogleCloudPlatform/golang-samples > vertexai

• 软件包 cloud.google.com/go/aiplatform

  顶级 aiplatform 目录的 golang-samples GitHub 代码库中提供了使用此软件包的示例：

  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 参考文档