Skip to content

Latest commit

 

History

History
205 lines (151 loc) · 8.4 KB

README.md

File metadata and controls

205 lines (151 loc) · 8.4 KB
Raw

Google Cloud Java Client for Translation

Java idiomatic client for Google Translation.

Kokoro CI Maven Codacy Badge

Quickstart

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

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-translate</artifactId>
  <version>1.88.0</version>
</dependency>

If you are using Gradle, add this to your dependencies

compile 'com.google.cloud:google-cloud-translate:1.88.0'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-translate" % "1.88.0"

Example Application

TranslateExample is a simple command line interface that provides some of Google Translation's functionality.

Authentication

For instructions on how to set up authentication and make authenticated calls, follow the Translation quickstart.

About Google Translation

Google Translation provides a simple programmatic interface for translating an arbitrary string into any supported language. Translation is highly responsive, so websites and applications can integrate with Translation API for fast, dynamic translation of source text from the source language to a target language (e.g., French to English). Language detection is also available in cases where the source language is unknown.

See the Translation quickstart for more details on how to activate Google Translation for your project.

See the Translation client library docs to learn how to interact with the Google Translation using this Client Library.

Getting Started

Prerequisites

For this tutorial, you need a Google Developers Console project with "Translation API" enabled via the console's API Manager. You also need to enable billing via the Google Developers Console.

Finally, you must set up the local development environment by installing the Google Cloud SDK and running the following command in command line: gcloud auth application-default login. Alternatively, you can authenticate Translation requests using an API key. See Translation quickstart for more details.

Installation and setup

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

Creating an authorized service object

To make authenticated requests to Google Translation, you must create a service object with credentials or use an API key. The simplest way to authenticate is to use Application Default Credentials. These credentials are automatically inferred from your environment, so you only need the following code to create your service object:

import com.google.cloud.translate.Translate;
import com.google.cloud.translate.TranslateOptions;

Translate translate = TranslateOptions.getDefaultInstance().getService();

Notice that this code can be also used with an API key. By default, an API key is looked for in the GOOGLE_API_KEY environment variable. Once the API key is set, you can make API calls by invoking methods on the Translation service created via TranslateOptions.getDefaultInstance().getService().

You can also explicitly set the API key as follows:

Translate translate = TranslateOptions.newBuilder().setApiKey("myKey").build().getService();

Detecting language

With Google Translation you can detect the language of some text. The service will provide you with the code of the detected language and a level of confidence.

Add the following import at the top of your file:

import com.google.cloud.translate.Detection;

Then pick a text sample:

final String mysteriousText = "Hola Mundo";

Then add the following code to detect the text's language:

Detection detection = translate.detect(mysteriousText);
String detectedLanguage = detection.getLanguage();

Translating text

Google translation allows you to translate some text. When translating one or more texts you can either provide the source language or let the service detect it for you.

Add the following imports at the top of your file:

import com.google.cloud.translate.Translate.TranslateOption;
import com.google.cloud.translate.Translation;

Then add the following code to translate the text, specifying the previously detected language (detectedLanguage) as its source language and English as the target language (providing the source language is optional, if it is not specified the service will try to detect it automatically):

Translation translation = translate.translate(
    mysteriousText,
    TranslateOption.sourceLanguage(detectedLanguage),
    TranslateOption.targetLanguage("en"));

Complete source code

In DetectLanguageAndTranslate.java we put together all the code shown above into one program. The program assumes that either Application Default Credentials or a valid API key are available.

Troubleshooting

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

Transport

Translate uses HTTP for the transport layer. Translate v3beta1 uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Testing

This library has tools to help make tests for code using Cloud Translation.

See TESTING to read more about testing.

Versioning

This library follows Semantic Versioning.

It is currently in major version one (1.y.z), which means that the public API should be considered stable.

Contributing

Contributions to this library are always welcome and highly encouraged.

See google-cloud's CONTRIBUTING documentation and the shared documentation for more information on 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.