README.md

Google Cloud Auto ML Client for Java

Java idiomatic client for Cloud Auto ML.

• Product Documentation
• Client Library Documentation

Quickstart

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

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>23.0.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-automl</artifactId>
  </dependency>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-bigquery</artifactId>
  </dependency>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-storage</artifactId>
  </dependency>
</dependencies>

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

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-automl</artifactId>
  <version>2.1.0</version>
</dependency>
<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-bigquery</artifactId>
  <version>2.1.11</version>
</dependency>
<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-storage</artifactId>
  <version>2.1.5</version>
</dependency>

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

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

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

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

implementation 'com.google.cloud:google-cloud-automl:2.1.1'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-automl" % "2.1.1"

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 Cloud Auto ML APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud Auto ML API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Cloud Auto ML API enabled. You will need to enable billing to use Google Cloud Auto ML. 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-automl library. See the Quickstart section to add google-cloud-automl as a dependency in your code.

About Cloud Auto ML

Cloud Auto ML makes the power of machine learning available to you even if you have limited knowledge of machine learning. You can use AutoML to build on Google's machine learning capabilities to create your own custom machine learning models that are tailored to your business needs, and then integrate those models into your applications and web sites.

See the Cloud Auto ML client library docs to learn how to use this Cloud Auto ML Client Library.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
Batch Predict	source code
Cancel Operation	source code
Delete Dataset	source code
Delete Model	source code
Deploy Model	source code
Get Model	source code
Get Model Evaluation	source code
Get Operation Status	source code
Import Dataset	source code
List Datasets	source code
List Model Evaluations	source code
List Models	source code
Set Endpoint	source code
Tables Batch Predict Big Query	source code
Tables Create Dataset	source code
Tables Create Model	source code
Tables Get Model	source code
Tables Import Dataset	source code
Tables Predict	source code
Undeploy Model	source code
Video Classification Create Dataset	source code
Video Classification Create Model	source code
Video Object Tracking Create Dataset	source code
Video Object Tracking Create Model	source code
Batch Predict	source code
Delete Dataset	source code
Delete Model	source code
Deploy Model	source code
Export Dataset	source code
Get Dataset	source code
Get Model	source code
Get Model Evaluation	source code
Get Operation Status	source code
Import Dataset	source code
Language Entity Extraction Create Dataset	source code
Language Entity Extraction Create Model	source code
Language Entity Extraction Predict	source code
Language Sentiment Analysis Create Dataset	source code
Language Sentiment Analysis Create Model	source code
Language Sentiment Analysis Predict	source code
Language Text Classification Create Dataset	source code
Language Text Classification Create Model	source code
Language Text Classification Predict	source code
List Datasets	source code
List Model Evaluations	source code
List Models	source code
List Operation Status	source code
Translate Create Dataset	source code
Translate Create Model	source code
Translate Predict	source code
Undeploy Model	source code
Vision Classification Create Dataset	source code
Vision Classification Create Model	source code
Vision Classification Deploy Model Node Count	source code
Vision Classification Predict	source code
Vision Object Detection Create Dataset	source code
Vision Object Detection Create Model	source code
Vision Object Detection Deploy Model Node Count	source code
Vision Object Detection Predict	source code
Dataset Api	source code
Model Api	source code
Classification Undeploy Model	source code
Prediction Api	source code
Classification Deploy Model	source code
Classification Deploy Model Node Count	source code
Classification Undeploy Model	source code
Model Api	source code
Object Detection Deploy Model Node Count	source code
Prediction Api	source code

Troubleshooting

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

Transport

Cloud Auto ML uses gRPC for the transport layer.

Supported Java Versions

Java 7 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 7
Java 8
Java 8 OSX
Java 8 Windows
Java 11

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