Google Vertex AI Client for Java

Java idiomatic client for Vertex AI.

• Product Documentation
• Client Library Documentation

Quickstart

If you are using Maven with BOM, add this to your pom.xml file

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

If you are using Maven without BOM, add this to your dependencies:

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

If you are using Gradle 5.x or later, add this to your dependencies

implementation platform('com.google.cloud:libraries-bom:25.3.0')

implementation 'com.google.cloud:google-cloud-aiplatform'

If you are using Gradle without BOM, add this to your dependencies

implementation 'com.google.cloud:google-cloud-aiplatform:2.9.4'

If you are using SBT, add this to your dependencies

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

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Vertex AI APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Vertex AI API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Vertex AI API enabled. You will need to enable billing to use Google Vertex AI. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-aiplatform library. See the Quickstart section to add google-cloud-aiplatform as a dependency in your code.

About Vertex AI

Vertex AI is an integrated suite of machine learning tools and services for building and using ML models with AutoML or custom code. It offers both novices and experts the best workbench for the entire machine learning development lifecycle.

See the Vertex AI client library docs to learn how to use this Vertex AI Client Library.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
Cancel Batch Prediction Job Sample	source code
Cancel Data Labeling Job Sample	source code
Cancel Training Pipeline Sample	source code
Create Batch Prediction Job Bigquery Sample	source code
Create Batch Prediction Job Sample	source code
Create Batch Prediction Job Text Classification Sample	source code
Create Batch Prediction Job Text Entity Extraction Sample	source code
Create Batch Prediction Job Text Sentiment Analysis Sample	source code
Create Batch Prediction Job Video Action Recognition Sample	source code
Create Batch Prediction Job Video Classification Sample	source code
Create Batch Prediction Job Video Object Tracking Sample	source code
Create Data Labeling Job Active Learning Sample	source code
Create Data Labeling Job Image Sample	source code
Create Data Labeling Job Sample	source code
Create Data Labeling Job Specialist Pool Sample	source code
Create Data Labeling Job Video Sample	source code
Create Dataset Image Sample	source code
Create Dataset Sample	source code
Create Dataset Tabular Bigquery Sample	source code
Create Dataset Tabular Gcs Sample	source code
Create Dataset Text Sample	source code
Create Dataset Video Sample	source code
Create Endpoint Sample	source code
Create Hyperparameter Tuning Job Python Package Sample	source code
Create Hyperparameter Tuning Job Sample	source code
Create Training Pipeline Custom Job Sample	source code
Create Training Pipeline Custom Training Managed Dataset Sample	source code
Create Training Pipeline Image Classification Sample	source code
Create Training Pipeline Image Object Detection Sample	source code
Create Training Pipeline Sample	source code
Create Training Pipeline Tabular Classification Sample	source code
Create Training Pipeline Tabular Regression Sample	source code
Create Training Pipeline Text Classification Sample	source code
Create Training Pipeline Text Entity Extraction Sample	source code
Create Training Pipeline Text Sentiment Analysis Sample	source code
Create Training Pipeline Video Action Recognition Sample	source code
Create Training Pipeline Video Classification Sample	source code
Create Training Pipeline Video Object Tracking Sample	source code
Delete Batch Prediction Job Sample	source code
Delete Data Labeling Job Sample	source code
Delete Dataset Sample	source code
Delete Endpoint Sample	source code
Delete Export Model Sample	source code
Delete Model Sample	source code
Delete Training Pipeline Sample	source code
Deploy Model Custom Trained Model Sample	source code
Deploy Model Sample	source code
Export Model Sample	source code
Export Model Tabular Classification Sample	source code
Export Model Video Action Recognition Sample	source code
Get Batch Prediction Job Sample	source code
Get Hyperparameter Tuning Job Sample	source code
Get Model Evaluation Image Classification Sample	source code
Get Model Evaluation Image Object Detection Sample	source code
Get Model Evaluation Sample	source code
Get Model Evaluation Slice Sample	source code
Get Model Evaluation Tabular Classification Sample	source code
Get Model Evaluation Tabular Regression Sample	source code
Get Model Evaluation Text Classification Sample	source code
Get Model Evaluation Text Entity Extraction Sample	source code
Get Model Evaluation Text Sentiment Analysis Sample	source code
Get Model Evaluation Video Action Recognition Sample	source code
Get Model Evaluation Video Classification Sample	source code
Get Model Evaluation Video Object Tracking Sample	source code
Get Model Sample	source code
Get Training Pipeline Sample	source code
Import Data Image Classification Sample	source code
Import Data Image Object Detection Sample	source code
Import Data Text Classification Single Label Sample	source code
Import Data Text Entity Extraction Sample	source code
Import Data Text Sentiment Analysis Sample	source code
Import Data Video Action Recognition Sample	source code
Import Data Video Classification Sample	source code
Import Data Video Object Tracking Sample	source code
List Model Evaluation Slice Sample	source code
Predict Custom Trained Model Sample	source code
Predict Image Classification Sample	source code
Predict Image Object Detection Sample	source code
Predict Tabular Classification Sample	source code
Predict Tabular Regression Sample	source code
Predict Text Classification Single Label Sample	source code
Predict Text Entity Extraction Sample	source code
Predict Text Sentiment Analysis Sample	source code
Undeploy Model Sample	source code
Upload Model Sample	source code

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Vertex AI uses gRPC for the transport layer.

Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

Versioning

This library follows Semantic Versioning.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.