com.azure.ai.translation.text.TextTranslationClient

public final class TextTranslationClient extends Object

Initializes a new instance of the synchronous TextTranslationClient type.

Method Summary

Modifier and Type

Method

Description

List<BreakSentenceItem>

findSentenceBoundaries(List<InputTextItem> content)

Find Sentence Boundaries.

List<BreakSentenceItem>

findSentenceBoundaries(List<InputTextItem> content, String clientTraceId, String language, String script)

Find Sentence Boundaries.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

findSentenceBoundariesWithResponse(com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Find Sentence Boundaries.

GetLanguagesResult

getLanguages()

Gets the set of languages currently supported by other operations of the Translator.

GetLanguagesResult

getLanguages(String clientTraceId, String scope, String acceptLanguage, String ifNoneMatch)

Gets the set of languages currently supported by other operations of the Translator.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getLanguagesWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Gets the set of languages currently supported by other operations of the Translator.

List<DictionaryLookupItem>

lookupDictionaryEntries(String from, String to, List<InputTextItem> content)

Lookup Dictionary Entries.

List<DictionaryLookupItem>

lookupDictionaryEntries(String from, String to, List<InputTextItem> content, String clientTraceId)

Lookup Dictionary Entries.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

lookupDictionaryEntriesWithResponse(String from, String to, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Lookup Dictionary Entries.

List<DictionaryExampleItem>

lookupDictionaryExamples(String from, String to, List<DictionaryExampleTextItem> content)

Lookup Dictionary Examples.

List<DictionaryExampleItem>

lookupDictionaryExamples(String from, String to, List<DictionaryExampleTextItem> content, String clientTraceId)

Lookup Dictionary Examples.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

lookupDictionaryExamplesWithResponse(String from, String to, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Lookup Dictionary Examples.

List<TranslatedTextItem>

translate(List<String> to, List<InputTextItem> content)

Translate Text.

List<TranslatedTextItem>

translate(List<String> to, List<InputTextItem> content, String clientTraceId, String from, TextType textType, String category, ProfanityAction profanityAction, ProfanityMarker profanityMarker, Boolean includeAlignment, Boolean includeSentenceLength, String suggestedFrom, String fromScript, String toScript, Boolean allowFallback)

Translate Text.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

translateWithResponse(List<String> to, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Translate Text.

List<TransliteratedText>

transliterate(String language, String fromScript, String toScript, List<InputTextItem> content)

Transliterate Text.

List<TransliteratedText>

transliterate(String language, String fromScript, String toScript, List<InputTextItem> content, String clientTraceId)

Transliterate Text.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

transliterateWithResponse(String language, String fromScript, String toScript, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Transliterate Text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getLanguagesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getLanguagesWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Gets the set of languages currently supported by other operations of the Translator.

Query Parameters

Query Parameters
Name	Type	Required	Description
scope	String	No	A comma-separated list of names defining the group of languages to return. Allowed group names are: `translation`, `transliteration` and `dictionary`. If no scope is given, then all groups are returned, which is equivalent to passing `scope=translation,transliteration,dictionary`. To decide which set of supported languages is appropriate for your scenario, see the description of the [response object](#response-body).

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Header Parameters

Header Parameters
Name	Type	Required	Description
X-ClientTraceId	String	No	A client-generated GUID to uniquely identify the request.
Accept-Language	String	No	The language to use for user interface strings. Some of the fields in the response are names of languages or names of regions. Use this parameter to define the language in which these names are returned. The language is specified by providing a well-formed BCP 47 language tag. For instance, use the value `fr` to request names in French or use the value `zh-Hant` to request names in Chinese Traditional. Names are provided in the English language when a target language is not specified or when localization is not available.
If-None-Match	String	No	Passing the value of the ETag response header in an If-None-Match field will allow the service to optimize the response. If the resource has not been modified, the service will return status code 304 and an empty response body.

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Response Body Schema


 {
     translation (Optional): {
         String (Optional): {
             name: String (Required)
             nativeName: String (Required)
             dir: String (Required)
         }
     }
     transliteration (Optional): {
         String (Optional): {
             name: String (Required)
             nativeName: String (Required)
             scripts (Required): [
                  (Required){
                     code: String (Required)
                     name: String (Required)
                     nativeName: String (Required)
                     dir: String (Required)
                     toScripts (Required): [
                          (Required){
                             code: String (Required)
                             name: String (Required)
                             nativeName: String (Required)
                             dir: String (Required)
                         }
                     ]
                 }
             ]
         }
     }
     dictionary (Optional): {
         String (Optional): {
             name: String (Required)
             nativeName: String (Required)
             dir: String (Required)
             translations (Required): [
                  (Required){
                     name: String (Required)
                     nativeName: String (Required)
                     dir: String (Required)
                     code: String (Required)
                 }
             ]
         }
     }
 }

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the set of languages currently supported by other operations of the Translator along with Response.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

translateWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> translateWithResponse(List<String> to, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Translate Text.

Query Parameters

Query Parameters
Name	Type	Required	Description
from	String	No	Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter isn't specified, automatic language detection is applied to determine the source language. You must use the from parameter rather than autodetection when using the dynamic dictionary feature. Note: the dynamic dictionary feature is case-sensitive.
textType	String	No	Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete element. Possible values are: plain (default) or html. Allowed values: "plain", "html".
category	String	No	A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general.
profanityAction	String	No	Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted. Allowed values: "NoAction", "Marked", "Deleted".
profanityMarker	String	No	Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag. . Allowed values: "Asterisk", "Tag".
includeAlignment	Boolean	No	Specifies whether to include alignment projection from source text to translated text. Possible values are: true or false (default).
includeSentenceLength	Boolean	No	Specifies whether to include sentence boundaries for the input text and the translated text. Possible values are: true or false (default).
suggestedFrom	String	No	Specifies a fallback language if the language of the input text can't be identified. Language autodetection is applied when the from parameter is omitted. If detection fails, the suggestedFrom language will be assumed.
fromScript	String	No	Specifies the script of the input text.
toScript	String	No	Specifies the script of the translated text.
allowFallback	Boolean	No	Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false. allowFallback=false specifies that the translation should only use systems trained for the category specified by the request. If a translation for language X to language Y requires chaining through a pivot language E, then all the systems in the chain (X → E and E → Y) will need to be custom and have the same category. If no system is found with the specific category, the request will return a 400 status code. allowFallback=true specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Header Parameters

Header Parameters
Name	Type	Required	Description
X-ClientTraceId	String	No	A client-generated GUID to uniquely identify the request.

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema


 [
      (Required){
         text: String (Required)
     }
 ]

Response Body Schema


 [
      (Required){
         detectedLanguage (Optional): {
             language: String (Required)
             score: double (Required)
         }
         translations (Required): [
              (Required){
                 to: String (Required)
                 text: String (Required)
                 transliteration (Optional): {
                     text: String (Required)
                     script: String (Required)
                 }
                 alignment (Optional): {
                     proj: String (Required)
                 }
                 sentLen (Optional): {
                     srcSentLen (Required): [
                         int (Required)
                     ]
                     transSentLen (Required): [
                         int (Required)
                     ]
                 }
             }
         ]
         sourceText (Optional): {
             text: String (Required)
         }
     }
 ]

Parameters:: to - Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de&to=it to translate to German and Italian.; content - Array of the text to be translated.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the response body along with Response.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

transliterateWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> transliterateWithResponse(String language, String fromScript, String toScript, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
Transliterate Text.
Header Parameters
Header Parameters
Name Type Required Description

X-ClientTraceId String No A client-generated GUID to uniquely identify the request.

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
Request Body Schema
```
 [
      (Required){
         text: String (Required)
     }
 ]
 
```
Response Body Schema
```
 [
      (Required){
         text: String (Required)
         script: String (Required)
     }
 ]
 
```
Parameters:

language - Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages.

fromScript - Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language.

toScript - Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script.

content - Array of the text to be transliterated.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

findSentenceBoundariesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> findSentenceBoundariesWithResponse(com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)

Find Sentence Boundaries.

Query Parameters

Query Parameters
Name	Type	Required	Description
language	String	No	Language tag identifying the language of the input text. If a code isn't specified, automatic language detection will be applied.
script	String	No	Script tag identifying the script used by the input text. If a script isn't specified, the default script of the language will be assumed.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Header Parameters

Header Parameters
Name	Type	Required	Description
X-ClientTraceId	String	No	A client-generated GUID to uniquely identify the request.

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema


 [
      (Required){
         text: String (Required)
     }
 ]

Response Body Schema


 [
      (Required){
         detectedLanguage (Optional): {
             language: String (Required)
             score: double (Required)
         }
         sentLen (Required): [
             int (Required)
         ]
     }
 ]

Parameters:: content - Array of the text for which values the sentence boundaries will be calculated.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the response body along with Response.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

lookupDictionaryEntriesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> lookupDictionaryEntriesWithResponse(String from, String to, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
Lookup Dictionary Entries.
Header Parameters
Header Parameters
Name Type Required Description

X-ClientTraceId String No A client-generated GUID to uniquely identify the request.

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
Request Body Schema
```
 [
      (Required){
         text: String (Required)
     }
 ]
 
```
Response Body Schema
```
 [
      (Required){
         normalizedSource: String (Required)
         displaySource: String (Required)
         translations (Required): [
              (Required){
                 normalizedTarget: String (Required)
                 displayTarget: String (Required)
                 posTag: String (Required)
                 confidence: double (Required)
                 prefixWord: String (Required)
                 backTranslations (Required): [
                      (Required){
                         normalizedText: String (Required)
                         displayText: String (Required)
                         numExamples: int (Required)
                         frequencyCount: int (Required)
                     }
                 ]
             }
         ]
     }
 ]
 
```
Parameters:

from - Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

to - Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.

content - Array of the text to be sent to dictionary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
lookupDictionaryExamplesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> lookupDictionaryExamplesWithResponse(String from, String to, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
Lookup Dictionary Examples.
Header Parameters
Header Parameters
Name Type Required Description

X-ClientTraceId String No A client-generated GUID to uniquely identify the request.

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
Request Body Schema
```
 [
      (Required){
         text: String (Required)
         translation: String (Required)
     }
 ]
 
```
Response Body Schema
```
 [
      (Required){
         normalizedSource: String (Required)
         normalizedTarget: String (Required)
         examples (Required): [
              (Required){
                 sourcePrefix: String (Required)
                 sourceTerm: String (Required)
                 sourceSuffix: String (Required)
                 targetPrefix: String (Required)
                 targetTerm: String (Required)
                 targetSuffix: String (Required)
             }
         ]
     }
 ]
 
```
Parameters:

from - Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

to - Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.

content - Array of the text to be sent to dictionary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
getLanguages

public GetLanguagesResult getLanguages(String clientTraceId, String scope, String acceptLanguage, String ifNoneMatch)

Gets the set of languages currently supported by other operations of the Translator.

Parameters:

clientTraceId - A client-generated GUID to uniquely identify the request.

scope - A comma-separated list of names defining the group of languages to return. Allowed group names are: `translation`, `transliteration` and `dictionary`. If no scope is given, then all groups are returned, which is equivalent to passing `scope=translation,transliteration,dictionary`. To decide which set of supported languages is appropriate for your scenario, see the description of the [response object](#response-body).

acceptLanguage - The language to use for user interface strings. Some of the fields in the response are names of languages or names of regions. Use this parameter to define the language in which these names are returned. The language is specified by providing a well-formed BCP 47 language tag. For instance, use the value `fr` to request names in French or use the value `zh-Hant` to request names in Chinese Traditional. Names are provided in the English language when a target language is not specified or when localization is not available.

ifNoneMatch - Passing the value of the ETag response header in an If-None-Match field will allow the service to optimize the response. If the resource has not been modified, the service will return status code 304 and an empty response body.

Returns:

the set of languages currently supported by other operations of the Translator.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
getLanguages

public GetLanguagesResult getLanguages()

Gets the set of languages currently supported by other operations of the Translator.

Returns:

the set of languages currently supported by other operations of the Translator.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
translate

public List<TranslatedTextItem> translate(List<String> to, List<InputTextItem> content, String clientTraceId, String from, TextType textType, String category, ProfanityAction profanityAction, ProfanityMarker profanityMarker, Boolean includeAlignment, Boolean includeSentenceLength, String suggestedFrom, String fromScript, String toScript, Boolean allowFallback)

Translate Text.

Parameters:

to - Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de&to=it to translate to German and Italian.

content - Array of the text to be translated.

clientTraceId - A client-generated GUID to uniquely identify the request.

from - Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter isn't specified, automatic language detection is applied to determine the source language.
You must use the from parameter rather than autodetection when using the dynamic dictionary feature. Note: the dynamic dictionary feature is case-sensitive.

textType - Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete element. Possible values are: plain (default) or html.

category - A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general.

profanityAction - Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted.

profanityMarker - Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag.

includeAlignment - Specifies whether to include alignment projection from source text to translated text. Possible values are: true or false (default).

includeSentenceLength - Specifies whether to include sentence boundaries for the input text and the translated text. Possible values are: true or false (default).

suggestedFrom - Specifies a fallback language if the language of the input text can't be identified. Language autodetection is applied when the from parameter is omitted. If detection fails, the suggestedFrom language will be assumed.

fromScript - Specifies the script of the input text.

toScript - Specifies the script of the translated text.

allowFallback - Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false.
allowFallback=false specifies that the translation should only use systems trained for the category specified by the request. If a translation for language X to language Y requires chaining through a pivot language E, then all the systems in the chain (X → E and E → Y) will need to be custom and have the same category. If no system is found with the specific category, the request will return a 400 status code. allowFallback=true specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
translate

public List<TranslatedTextItem> translate(List<String> to, List<InputTextItem> content)

Translate Text.

Parameters:

to - Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de&to=it to translate to German and Italian.

content - Array of the text to be translated.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
transliterate

public List<TransliteratedText> transliterate(String language, String fromScript, String toScript, List<InputTextItem> content, String clientTraceId)

Transliterate Text.

Parameters:

language - Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages.

fromScript - Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language.

toScript - Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script.

content - Array of the text to be transliterated.

clientTraceId - A client-generated GUID to uniquely identify the request.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
transliterate

public List<TransliteratedText> transliterate(String language, String fromScript, String toScript, List<InputTextItem> content)

Transliterate Text.

Parameters:

language - Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages.

fromScript - Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language.

toScript - Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script.

content - Array of the text to be transliterated.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
findSentenceBoundaries

public List<BreakSentenceItem> findSentenceBoundaries(List<InputTextItem> content, String clientTraceId, String language, String script)

Find Sentence Boundaries.

Parameters:

content - Array of the text for which values the sentence boundaries will be calculated.

clientTraceId - A client-generated GUID to uniquely identify the request.

language - Language tag identifying the language of the input text. If a code isn't specified, automatic language detection will be applied.

script - Script tag identifying the script used by the input text. If a script isn't specified, the default script of the language will be assumed.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
findSentenceBoundaries

public List<BreakSentenceItem> findSentenceBoundaries(List<InputTextItem> content)

Find Sentence Boundaries.

Parameters:

content - Array of the text for which values the sentence boundaries will be calculated.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
lookupDictionaryEntries

public List<DictionaryLookupItem> lookupDictionaryEntries(String from, String to, List<InputTextItem> content, String clientTraceId)

Lookup Dictionary Entries.

Parameters:

from - Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

to - Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.

content - Array of the text to be sent to dictionary.

clientTraceId - A client-generated GUID to uniquely identify the request.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
lookupDictionaryEntries

public List<DictionaryLookupItem> lookupDictionaryEntries(String from, String to, List<InputTextItem> content)

Lookup Dictionary Entries.

Parameters:

from - Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

to - Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.

content - Array of the text to be sent to dictionary.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
lookupDictionaryExamples

public List<DictionaryExampleItem> lookupDictionaryExamples(String from, String to, List<DictionaryExampleTextItem> content, String clientTraceId)

Lookup Dictionary Examples.

Parameters:

from - Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

to - Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.

content - Array of the text to be sent to dictionary.

clientTraceId - A client-generated GUID to uniquely identify the request.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
lookupDictionaryExamples

public List<DictionaryExampleItem> lookupDictionaryExamples(String from, String to, List<DictionaryExampleTextItem> content)

Lookup Dictionary Examples.

Parameters:

from - Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

to - Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.

content - Array of the text to be sent to dictionary.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

Class TextTranslationClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

getLanguagesWithResponse

translateWithResponse

transliterateWithResponse

findSentenceBoundariesWithResponse

lookupDictionaryEntriesWithResponse

lookupDictionaryExamplesWithResponse

getLanguages

getLanguages

translate

translate

transliterate

transliterate

findSentenceBoundaries

findSentenceBoundaries

lookupDictionaryEntries

lookupDictionaryEntries

lookupDictionaryExamples

lookupDictionaryExamples