Text Translation Samples: Updating README and java samples (Azure#36346)

rangothedog · Rango Meadows · web-flow · commit 96b4a85783a4 · 2023-08-18T10:22:30.000+08:00
Co-authored-by: Rango Meadows &lt;v-rameadows@microsoft.com&gt;
diff --git a/sdk/translation/azure-ai-translation-text/README.md b/sdk/translation/azure-ai-translation-text/README.md
@@ -62,15 +62,16 @@ update the API key without creating a new client.
 
 With the value of the endpoint, `AzureKeyCredential` and a `Region`, you can create the [TextTranslationClient][translator_client_class]:
 
-```Java
+```java createTextTranslationRestClient
 String apiKey = System.getenv("TEXT_TRANSLATOR_API_KEY");
 String region = System.getenv("TEXT_TRANSLATOR_API_REGION");
 AzureKeyCredential credential = new AzureKeyCredential(apiKey);
 
 TextTranslationClient client = new TextTranslationClientBuilder()
-.credential(credential)
-.region(region)
-.buildClient();
+        .credential(credential)
+        .region(region)
+        .endpoint("https://api.cognitive.microsofttranslator.com")
+        .buildClient();
 ```
 
 ## Key concepts
@@ -94,7 +95,7 @@ The following section provides several code snippets using the `client` [created
 
 Gets the set of languages currently supported by other operations of the Translator.
 
-```Java
+```java getTextTranslationLanguages
 GetLanguagesResult languages = client.getLanguages();
 
 System.out.println("Number of supported languages for translate operation: " + languages.getTranslation().size() + ".");
@@ -123,7 +124,7 @@ Please refer to the service documentation for a conceptual discussion of [langua
 
 Renders single source-language text to multiple target-language texts with a single request.
 
-```Java
+```java getTextTranslationMultiple
 String from = "en";
 List<String> targetLanguages = new ArrayList<>();
 targetLanguages.add("cs");
@@ -145,7 +146,7 @@ Please refer to the service documentation for a conceptual discussion of [transl
 
 Converts characters or letters of a source language to the corresponding characters or letters of a target language.
 
-```Java
+```java getTextTranslationTransliterate
 String language = "zh-Hans";
 String fromScript = "Hans";
 String toScript = "Latn";
@@ -165,7 +166,7 @@ Please refer to the service documentation for a conceptual discussion of [transl
 
 Identifies the positioning of sentence boundaries in a piece of text.
 
-```Java
+```java getTextTranslationSentenceBoundaries
 String sourceLanguage = "zh-Hans";
 String sourceScript = "Latn";
 List<InputTextItem> content = new ArrayList<>();
@@ -184,7 +185,7 @@ Please refer to the service documentation for a conceptual discussion of [break
 
 Returns equivalent words for the source term in the target language.
 
-```Java
+```java getTextTranslationDictionaryLookup
 String sourceLanguage = "en";
 String targetLanguage = "es";
 List<InputTextItem> content = new ArrayList<>();
@@ -204,7 +205,7 @@ Please refer to the service documentation for a conceptual discussion of [dictio
 
 Returns grammatical structure and context examples for the source term and target term pair.
 
-```Java
+```java getTextTranslationDictionaryExamples
 String sourceLanguage = "en";
 String targetLanguage = "es";
 List<DictionaryExampleTextItem> content = new ArrayList<>();
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/BreakSentence.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/BreakSentence.java
@@ -28,7 +28,8 @@ public static void main(final String[] args) {
                 .region(region)
                 .endpoint("https://api.cognitive.microsofttranslator.com")
                 .buildClient();
-
+		
+		// BEGIN: getTextTranslationSentenceBoundaries
         String sourceLanguage = "zh-Hans";
         String sourceScript = "Latn";
         List<InputTextItem> content = new ArrayList<>();
@@ -39,5 +40,6 @@ public static void main(final String[] args) {
         for (BreakSentenceItem breakSentence : breakSentences) {
             System.out.println("The detected sentence boundaries: " + breakSentence.getSentLen());
         }
+		// END: getTextTranslationSentenceBoundaries
     }
 }
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/DictionaryExamples.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/DictionaryExamples.java
@@ -28,7 +28,8 @@ public static void main(final String[] args) {
                 .region(region)
                 .endpoint("https://api.cognitive.microsofttranslator.com")
                 .buildClient();
-
+		
+		// BEGIN: getTextTranslationDictionaryExamples
         String sourceLanguage = "en";
         String targetLanguage = "es";
         List<DictionaryExampleTextItem> content = new ArrayList<>();
@@ -40,5 +41,6 @@ public static void main(final String[] args) {
             System.out.println("For the given input " + dictionaryEntry.getExamples().size() + " entries were found in the dictionary.");
             System.out.println("Example: '" + dictionaryEntry.getExamples().get(0).getTargetPrefix() + dictionaryEntry.getExamples().get(0).getTargetTerm() + dictionaryEntry.getExamples().get(0).getTargetSuffix());
         }
+		// END: getTextTranslationDictionaryExamples
     }
 }
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/DictionaryLookup.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/DictionaryLookup.java
@@ -29,6 +29,7 @@ public static void main(final String[] args) {
                 .endpoint("https://api.cognitive.microsofttranslator.com")
                 .buildClient();
 
+		// BEGIN: getTextTranslationDictionaryLookup
         String sourceLanguage = "en";
         String targetLanguage = "es";
         List<InputTextItem> content = new ArrayList<>();
@@ -40,5 +41,6 @@ public static void main(final String[] args) {
             System.out.println("For the given input " + dictionaryEntry.getTranslations().size() + " entries were found in the dictionary.");
             System.out.println("First entry: '" + dictionaryEntry.getTranslations().get(0).getDisplayTarget() + "', confidence: " + dictionaryEntry.getTranslations().get(0).getConfidence());
         }
+		// END: getTextTranslationDictionaryLookup
     }
 }
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/GetLanguages.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/GetLanguages.java
@@ -23,6 +23,7 @@ public static void main(final String[] args) {
             .endpoint("https://api.cognitive.microsofttranslator.com")
             .buildClient();
 
+		// BEGIN: getTextTranslationLanguages
         GetLanguagesResult languages = client.getLanguages();
 
         System.out.println("Number of supported languages for translate operation: " + languages.getTranslation().size() + ".");
@@ -43,5 +44,6 @@ public static void main(final String[] args) {
         for (Map.Entry<String, SourceDictionaryLanguage> dictionaryLanguage : languages.getDictionary().entrySet()) {
             System.out.println(dictionaryLanguage.getKey() + " -- name: " + dictionaryLanguage.getValue().getName() + ", supported target languages count: " + dictionaryLanguage.getValue().getTranslations().size());
         }
+		// END: getTextTranslationLanguages
     }
 }
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/ReadmeSamples.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/ReadmeSamples.java
@@ -20,6 +20,7 @@ public void createClientAnonymous() {
      * Sample for creating text translator client using Text Translator API Key and Region.
      */
     public void createClient() {
+        // BEGIN: createTextTranslationRestClient
         String apiKey = System.getenv("TEXT_TRANSLATOR_API_KEY");
         String region = System.getenv("TEXT_TRANSLATOR_API_REGION");
         AzureKeyCredential credential = new AzureKeyCredential(apiKey);
@@ -29,6 +30,7 @@ public void createClient() {
                 .region(region)
                 .endpoint("https://api.cognitive.microsofttranslator.com")
                 .buildClient();
+        // END: createTextTranslationRestClient
     }
 
     /**
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/Translate.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/Translate.java
@@ -33,6 +33,7 @@ public static void main(final String[] args) {
                 .endpoint("https://api.cognitive.microsofttranslator.com")
                 .buildClient();
 
+		// BEGIN: getTextTranslationMultiple
         String from = "en";
         List<String> targetLanguages = new ArrayList<>();
         targetLanguages.add("cs");
@@ -46,5 +47,6 @@ public static void main(final String[] args) {
                 System.out.println("Text was translated to: '" + textTranslation.getTo() + "' and the result is: '" + textTranslation.getText() + "'.");
             }
         }
+		// END: getTextTranslationMultiple
     }
 }
diff --git a/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/Transliterate.java b/sdk/translation/azure-ai-translation-text/src/samples/java/com/azure/ai/translation/text/Transliterate.java
@@ -30,6 +30,7 @@ public static void main(final String[] args) {
                 .endpoint("https://api.cognitive.microsofttranslator.com")
                 .buildClient();
 
+		// BEGIN: getTextTranslationTransliterate
         String language = "zh-Hans";
         String fromScript = "Hans";
         String toScript = "Latn";
@@ -41,5 +42,6 @@ public static void main(final String[] args) {
         for (TransliteratedText transliteration : transliterations) {
             System.out.println("Input text was transliterated to '" + transliteration.getScript() + "' script. Transliterated text: '" + transliteration.getText() + "'.");
         }
+		// END: getTextTranslationTransliterate
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,8 @@ public static void main(final String[] args) {`
`28`	`28`	`.region(region)`
`29`	`29`	`.endpoint("https://api.cognitive.microsofttranslator.com")`
`30`	`30`	`.buildClient();`
`31`		`-`
	`31`	`+`
	`32`	`+ // BEGIN: getTextTranslationSentenceBoundaries`
`32`	`33`	`String sourceLanguage = "zh-Hans";`
`33`	`34`	`String sourceScript = "Latn";`
`34`	`35`	`List<InputTextItem> content = new ArrayList<>();`
`@@ -39,5 +40,6 @@ public static void main(final String[] args) {`
`39`	`40`	`for (BreakSentenceItem breakSentence : breakSentences) {`
`40`	`41`	`System.out.println("The detected sentence boundaries: " + breakSentence.getSentLen());`
`41`	`42`	`}`
	`43`	`+ // END: getTextTranslationSentenceBoundaries`
`42`	`44`	`}`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ public static void main(final String[] args) {`
`29`	`29`	`.endpoint("https://api.cognitive.microsofttranslator.com")`
`30`	`30`	`.buildClient();`
`31`	`31`
	`32`	`+ // BEGIN: getTextTranslationDictionaryLookup`
`32`	`33`	`String sourceLanguage = "en";`
`33`	`34`	`String targetLanguage = "es";`
`34`	`35`	`List<InputTextItem> content = new ArrayList<>();`
`@@ -40,5 +41,6 @@ public static void main(final String[] args) {`
`40`	`41`	`System.out.println("For the given input " + dictionaryEntry.getTranslations().size() + " entries were found in the dictionary.");`
`41`	`42`	`System.out.println("First entry: '" + dictionaryEntry.getTranslations().get(0).getDisplayTarget() + "', confidence: " + dictionaryEntry.getTranslations().get(0).getConfidence());`
`42`	`43`	`}`
	`44`	`+ // END: getTextTranslationDictionaryLookup`
`43`	`45`	`}`
`44`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ public static void main(final String[] args) {`
`23`	`23`	`.endpoint("https://api.cognitive.microsofttranslator.com")`
`24`	`24`	`.buildClient();`
`25`	`25`
	`26`	`+ // BEGIN: getTextTranslationLanguages`
`26`	`27`	`GetLanguagesResult languages = client.getLanguages();`
`27`	`28`
`28`	`29`	`System.out.println("Number of supported languages for translate operation: " + languages.getTranslation().size() + ".");`
`@@ -43,5 +44,6 @@ public static void main(final String[] args) {`
`43`	`44`	`for (Map.Entry<String, SourceDictionaryLanguage> dictionaryLanguage : languages.getDictionary().entrySet()) {`
`44`	`45`	`System.out.println(dictionaryLanguage.getKey() + " -- name: " + dictionaryLanguage.getValue().getName() + ", supported target languages count: " + dictionaryLanguage.getValue().getTranslations().size());`
`45`	`46`	`}`
	`47`	`+ // END: getTextTranslationLanguages`
`46`	`48`	`}`
`47`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ public static void main(final String[] args) {`
`33`	`33`	`.endpoint("https://api.cognitive.microsofttranslator.com")`
`34`	`34`	`.buildClient();`
`35`	`35`
	`36`	`+ // BEGIN: getTextTranslationMultiple`
`36`	`37`	`String from = "en";`
`37`	`38`	`List<String> targetLanguages = new ArrayList<>();`
`38`	`39`	`targetLanguages.add("cs");`
`@@ -46,5 +47,6 @@ public static void main(final String[] args) {`
`46`	`47`	`System.out.println("Text was translated to: '" + textTranslation.getTo() + "' and the result is: '" + textTranslation.getText() + "'.");`
`47`	`48`	`}`
`48`	`49`	`}`
	`50`	`+ // END: getTextTranslationMultiple`
`49`	`51`	`}`
`50`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ public static void main(final String[] args) {`
`30`	`30`	`.endpoint("https://api.cognitive.microsofttranslator.com")`
`31`	`31`	`.buildClient();`
`32`	`32`
	`33`	`+ // BEGIN: getTextTranslationTransliterate`
`33`	`34`	`String language = "zh-Hans";`
`34`	`35`	`String fromScript = "Hans";`
`35`	`36`	`String toScript = "Latn";`
`@@ -41,5 +42,6 @@ public static void main(final String[] args) {`
`41`	`42`	`for (TransliteratedText transliteration : transliterations) {`
`42`	`43`	`System.out.println("Input text was transliterated to '" + transliteration.getScript() + "' script. Transliterated text: '" + transliteration.getText() + "'.");`
`43`	`44`	`}`
	`45`	`+ // END: getTextTranslationTransliterate`
`44`	`46`	`}`
`45`	`47`	`}`