translate: add v3 samples for translate text with model (#1939)

* translate: add v3 samples for translate text with model

* Add clarifying comments that explain chunks of the code

translate/cloud-client/src/main/java/com/example/translate/BatchTranslateTextWithGlossaryAndModel.java

@@ -71,23 +71,28 @@ public static void batchTranslateTextWithGlossaryAndModel(
       String location = "us-central1";
       LocationName parent = LocationName.of(projectId, location);
 
+      // Configure the source of the file from a GCS bucket
       GcsSource gcsSource = GcsSource.newBuilder().setInputUri(inputUri).build();
       // Supported Mime Types: https://cloud.google.com/translate/docs/supported-formats
       InputConfig inputConfig =
           InputConfig.newBuilder().setGcsSource(gcsSource).setMimeType("text/plain").build();
 
+      // Configure where to store the output in a GCS bucket
       GcsDestination gcsDestination =
           GcsDestination.newBuilder().setOutputUriPrefix(outputUri).build();
       OutputConfig outputConfig =
           OutputConfig.newBuilder().setGcsDestination(gcsDestination).build();
 
+      // Configure the glossary used in the request
       GlossaryName glossaryName = GlossaryName.of(projectId, location, glossaryId);
       TranslateTextGlossaryConfig glossaryConfig =
           TranslateTextGlossaryConfig.newBuilder().setGlossary(glossaryName.toString()).build();
 
+      // Configure the model used in the request
       String modelPath =
           String.format("projects/%s/locations/%s/models/%s", projectId, location, modelId);
 
+      // Build the request that will be sent to the API
       BatchTranslateTextRequest request =
           BatchTranslateTextRequest.newBuilder()
               .setParent(parent.toString())
@@ -99,6 +104,7 @@ public static void batchTranslateTextWithGlossaryAndModel(
               .putModels(targetLanguage, modelPath)
               .build();
 
+      // Start an asynchronous request
       OperationFuture<BatchTranslateResponse, BatchTranslateMetadata> future =
           client.batchTranslateTextAsync(request);
 

translate/cloud-client/src/main/java/com/example/translate/BatchTranslateTextWithModel.java

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.translate;
+
+// [START translate_v3_batch_translate_text_with_model]
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.translate.v3.BatchTranslateMetadata;
+import com.google.cloud.translate.v3.BatchTranslateResponse;
+import com.google.cloud.translate.v3.BatchTranslateTextRequest;
+import com.google.cloud.translate.v3.GcsDestination;
+import com.google.cloud.translate.v3.GcsSource;
+import com.google.cloud.translate.v3.InputConfig;
+import com.google.cloud.translate.v3.LocationName;
+import com.google.cloud.translate.v3.OutputConfig;
+import com.google.cloud.translate.v3.TranslationServiceClient;
+
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+
+public class BatchTranslateTextWithModel {
+
+  public static void batchTranslateTextWithModel()
+      throws InterruptedException, ExecutionException, IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "YOUR-PROJECT-ID";
+    // Supported Languages: https://cloud.google.com/translate/docs/languages
+    String sourceLanguage = "your-source-language";
+    String targetLanguage = "your-target-language";
+    String inputUri = "gs://your-gcs-bucket/path/to/input/file.txt";
+    String outputUri = "gs://your-gcs-bucket/path/to/results/";
+    String modelId = "YOUR-MODEL-ID";
+    batchTranslateTextWithModel(
+        projectId, sourceLanguage, targetLanguage, inputUri, outputUri, modelId);
+  }
+
+  // Batch translate text using AutoML Translation model
+  public static void batchTranslateTextWithModel(
+      String projectId,
+      String sourceLanguage,
+      String targetLanguage,
+      String inputUri,
+      String outputUri,
+      String modelId)
+      throws IOException, ExecutionException, InterruptedException {
+
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests. After completing all of your requests, call
+    // the "close" method on the client to safely clean up any remaining background resources.
+    try (TranslationServiceClient client = TranslationServiceClient.create()) {
+      // Supported Locations: `global`, [glossary location], or [model location]
+      // Glossaries must be hosted in `us-central1`
+      // Custom Models must use the same location as your model. (us-central1)
+      String location = "us-central1";
+      LocationName parent = LocationName.of(projectId, location);
+
+      // Configure the source of the file from a GCS bucket
+      GcsSource gcsSource = GcsSource.newBuilder().setInputUri(inputUri).build();
+      // Supported Mime Types: https://cloud.google.com/translate/docs/supported-formats
+      InputConfig inputConfig =
+          InputConfig.newBuilder().setGcsSource(gcsSource).setMimeType("text/plain").build();
+
+      // Configure where to store the output in a GCS bucket
+      GcsDestination gcsDestination =
+          GcsDestination.newBuilder().setOutputUriPrefix(outputUri).build();
+      OutputConfig outputConfig =
+          OutputConfig.newBuilder().setGcsDestination(gcsDestination).build();
+
+      // Configure the model used in the request
+      String modelPath =
+          String.format("projects/%s/locations/%s/models/%s", projectId, location, modelId);
+
+      // Build the request that will be sent to the API
+      BatchTranslateTextRequest request =
+          BatchTranslateTextRequest.newBuilder()
+              .setParent(parent.toString())
+              .setSourceLanguageCode(sourceLanguage)
+              .addTargetLanguageCodes(targetLanguage)
+              .addInputConfigs(inputConfig)
+              .setOutputConfig(outputConfig)
+              .putModels(targetLanguage, modelPath)
+              .build();
+
+      // Start an asynchronous request
+      OperationFuture<BatchTranslateResponse, BatchTranslateMetadata> future =
+          client.batchTranslateTextAsync(request);
+
+      System.out.println("Waiting for operation to complete...");
+      BatchTranslateResponse response = future.get();
+      // Display the translation for each input text provided
+      System.out.printf("Total Characters: %s\n", response.getTotalCharacters());
+      System.out.printf("Translated Characters: %s\n", response.getTranslatedCharacters());
+    }
+  }
+}
+// [END translate_v3_batch_translate_text_with_model]

translate/cloud-client/src/main/java/com/example/translate/CreateGlossary.java

@@ -65,6 +65,7 @@ public static void createGlossary(
       Glossary.LanguageCodesSet languageCodesSet =
           Glossary.LanguageCodesSet.newBuilder().addAllLanguageCodes(languageCodes).build();
 
+      // Configure the source of the file from a GCS bucket
       GcsSource gcsSource = GcsSource.newBuilder().setInputUri(inputUri).build();
       GlossaryInputConfig inputConfig =
           GlossaryInputConfig.newBuilder().setGcsSource(gcsSource).build();
@@ -82,6 +83,7 @@ public static void createGlossary(
               .setGlossary(glossary)
               .build();
 
+      // Start an asynchronous request
       OperationFuture<Glossary, CreateGlossaryMetadata> future =
           client.createGlossaryAsync(request);
 

translate/cloud-client/src/main/java/com/example/translate/DeleteGlossary.java

@@ -51,6 +51,7 @@ public static void deleteGlossary(String projectId, String glossaryId)
       DeleteGlossaryRequest request =
           DeleteGlossaryRequest.newBuilder().setName(glossaryName.toString()).build();
 
+      // Start an asynchronous request
       OperationFuture<DeleteGlossaryResponse, DeleteGlossaryMetadata> future =
           client.deleteGlossaryAsync(request);
 

translate/cloud-client/src/main/java/com/example/translate/TranslateTextWithModel.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.translate;
+
+// [START translate_v3_translate_text_with_model]
+import com.google.cloud.translate.v3.LocationName;
+import com.google.cloud.translate.v3.TranslateTextRequest;
+import com.google.cloud.translate.v3.TranslateTextResponse;
+import com.google.cloud.translate.v3.Translation;
+import com.google.cloud.translate.v3.TranslationServiceClient;
+
+import java.io.IOException;
+
+public class TranslateTextWithModel {
+
+  public static void translateTextWithModel() throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "YOUR-PROJECT-ID";
+    // Supported Languages: https://cloud.google.com/translate/docs/languages
+    String sourceLanguage = "your-source-language";
+    String targetLanguage = "your-target-language";
+    String text = "your-text";
+    String modelId = "YOUR-MODEL-ID";
+    translateTextWithModel(projectId, sourceLanguage, targetLanguage, text, modelId);
+  }
+
+  // Translating Text with Model
+  public static void translateTextWithModel(
+      String projectId, String sourceLanguage, String targetLanguage, String text, String modelId)
+      throws IOException {
+
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests. After completing all of your requests, call
+    // the "close" method on the client to safely clean up any remaining background resources.
+    try (TranslationServiceClient client = TranslationServiceClient.create()) {
+      // Supported Locations: `global`, [glossary location], or [model location]
+      // Glossaries must be hosted in `us-central1`
+      // Custom Models must use the same location as your model. (us-central1)
+      String location = "us-central1";
+      LocationName parent = LocationName.of(projectId, location);
+      String modelPath =
+          String.format("projects/%s/locations/%s/models/%s", projectId, location, modelId);
+
+      // Supported Mime Types: https://cloud.google.com/translate/docs/supported-formats
+      TranslateTextRequest request =
+          TranslateTextRequest.newBuilder()
+              .setParent(parent.toString())
+              .setMimeType("text/plain")
+              .setSourceLanguageCode(sourceLanguage)
+              .setTargetLanguageCode(targetLanguage)
+              .addContents(text)
+              .setModel(modelPath)
+              .build();
+
+      TranslateTextResponse response = client.translateText(request);
+
+      // Display the translation for each input text provided
+      for (Translation translation : response.getTranslationsList()) {
+        System.out.printf("Translated text: %s\n", translation.getTranslatedText());
+      }
+    }
+  }
+}
+// [END translate_v3_translate_text_with_model]

translate/cloud-client/src/test/java/com/example/translate/BatchTranslateTextWithModelTests.java

@@ -0,0 +1,115 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.translate;
+
+import static com.google.common.truth.Truth.assertThat;
+import static junit.framework.TestCase.assertNotNull;
+
+import com.google.api.gax.paging.Page;
+
+import com.google.cloud.storage.Blob;
+import com.google.cloud.storage.Storage;
+import com.google.cloud.storage.StorageOptions;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.PrintStream;
+import java.util.concurrent.ExecutionException;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests for Batch Translate Text With Model sample. */
+@RunWith(JUnit4.class)
+@SuppressWarnings("checkstyle:abbreviationaswordinname")
+public class BatchTranslateTextWithModelTests {
+  private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
+  private static final String INPUT_URI =
+      "gs://cloud-samples-data/translation/custom_model_text.txt";
+  private static final String MODEL_ID = "TRL2188848820815848149";
+
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+
+  private static final void cleanUpBucket() {
+    Storage storage = StorageOptions.getDefaultInstance().getService();
+    Page<Blob> blobs =
+        storage.list(
+            PROJECT_ID,
+            Storage.BlobListOption.currentDirectory(),
+            Storage.BlobListOption.prefix("BATCH_TRANSLATION_OUTPUT/"));
+
+    deleteDirectory(storage, blobs);
+  }
+
+  private static void deleteDirectory(Storage storage, Page<Blob> blobs) {
+    for (Blob blob : blobs.iterateAll()) {
+      System.out.println(blob.getBlobId());
+      if (!blob.delete()) {
+        Page<Blob> subBlobs =
+            storage.list(
+                PROJECT_ID,
+                Storage.BlobListOption.currentDirectory(),
+                Storage.BlobListOption.prefix(blob.getName()));
+
+        deleteDirectory(storage, subBlobs);
+      }
+    }
+  }
+
+  private static void requireEnvVar(String varName) {
+    assertNotNull(
+        "Environment variable '%s' is required to perform these tests.".format(varName),
+        System.getenv(varName));
+  }
+
+  @BeforeClass
+  public static void checkRequirements() {
+    requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");
+    requireEnvVar("GOOGLE_CLOUD_PROJECT");
+  }
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() {
+    cleanUpBucket();
+    System.setOut(null);
+  }
+
+  @Test
+  public void testBatchTranslateTextWithModel()
+      throws InterruptedException, ExecutionException, IOException {
+    BatchTranslateTextWithModel.batchTranslateTextWithModel(
+        PROJECT_ID,
+        "en",
+        "ja",
+        INPUT_URI,
+        "gs://" + PROJECT_ID + "/BATCH_TRANSLATION_OUTPUT/",
+        MODEL_ID);
+    String got = bout.toString();
+    assertThat(got).contains("Total Characters: 15");
+  }
+}