AutoML Natural Language Client Libraries

This page shows how to get started with the Cloud Client Libraries for the AutoML API. Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Installing the client library

C#

For more information, see Setting Up a C# Development Environment.

The C# client libraries for the AutoML Natural Language are currently released as Alpha.

install-package Google.Cloud.AutoML.V1 -pre

Go

go get -u cloud.google.com/go/automl

Java

For more information, see Setting Up a Java Development Environment. If you are using Maven, add the following to your pom.xml file:
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>3.4.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-automl</artifactId>
  </dependency>
</dependencies>
If you are using Gradle, add the following to your dependencies:
compile 'com.google.cloud:google-cloud-automl:1.0.0'
If you are using SBT, add the following to your dependencies:
libraryDependencies += "com.google.cloud" % "google-cloud-automl" % "1.0.0"

If you're using IntelliJ or Eclipse, you can add client libraries to your project using the following IDE plugins:

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

Node.js

For more information, see Setting Up a Node.js Development Environment.
npm install --save @google-cloud/automl

PHP

composer require google/cloud-automl

Python

For more information, see Setting Up a Python Development Environment.
pip install --upgrade google-cloud-automl

Ruby

For more information, see Setting Up a Ruby Development Environment.
gem install google-cloud-automl

Setting up authentication

To run the client library, you must first set up authentication by creating a service account and setting an environment variable. Complete the following steps to set up authentication. For other ways to authenticate, see the GCP authentication documentation.

Cloud Console

  1. In the Cloud Console, go to the Create service account key page.

    Go to the Create Service Account Key page
  2. From the Service account list, select New service account.
  3. In the Service account name field, enter a name.
  4. From the Role list, select Project > Owner.

    Note: The Role field authorizes your service account to access resources. You can view and change this field later by using the Cloud Console. If you are developing a production app, specify more granular permissions than Project > Owner. For more information, see granting roles to service accounts.
  5. Click Create. A JSON file that contains your key downloads to your computer.

Command line

You can run the following commands using the Cloud SDK on your local machine, or in Cloud Shell.

  1. Create the service account. Replace [NAME] with a name for the service account.

    gcloud iam service-accounts create [NAME]
  2. Grant permissions to the service account. Replace [PROJECT_ID] with your project ID.

    gcloud projects add-iam-policy-binding [PROJECT_ID] --member "serviceAccount:[NAME]@[PROJECT_ID].iam.gserviceaccount.com" --role "roles/owner"
    Note: The Role field authorizes your service account to access resources. You can view and change this field later by using Cloud Console. If you are developing a production app, specify more granular permissions than Project > Owner. For more information, see granting roles to service accounts.
  3. Generate the key file. Replace [FILE_NAME] with a name for the key file.

    gcloud iam service-accounts keys create [FILE_NAME].json --iam-account [NAME]@[PROJECT_ID].iam.gserviceaccount.com

Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. Replace [PATH] with the file path of the JSON file that contains your service account key, and [FILE_NAME] with the filename. This variable only applies to your current shell session, so if you open a new session, set the variable again.

Linux or macOS

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json"

Windows

With PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\[FILE_NAME].json"

With command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

Using the client library

The following example shows how to use the client library.

C#

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

Go

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

Java

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

Node.js

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

PHP

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

Python

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

Ruby

For more information, see Setting Up a Ruby Development Environment. For information on how to use the client libraries with AutoML Natural Language, see the following guides:

Additional resources