com.ibm.watson.developer_cloud.language_translator.v3

Class LanguageTranslator

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.language_translator.v3.LanguageTranslator

public class LanguageTranslator
extends WatsonService

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple IBM provided translation models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.

See Also:

Language Translator

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
LanguageTranslator(java.lang.String versionDate) Instantiates a new `LanguageTranslator`.
LanguageTranslator(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `LanguageTranslator` with IAM.
LanguageTranslator(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new `LanguageTranslator` with username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<TranslationModel>	createModel(CreateModelOptions createModelOptions) Create model.
ServiceCall<java.lang.Void>	deleteModel(DeleteModelOptions deleteModelOptions) Delete model.
ServiceCall<TranslationModel>	getModel(GetModelOptions getModelOptions) Get model details.
ServiceCall<IdentifiedLanguages>	identify(IdentifyOptions identifyOptions) Identify language.
ServiceCall<IdentifiableLanguages>	listIdentifiableLanguages() List identifiable languages.
ServiceCall<IdentifiableLanguages>	listIdentifiableLanguages(ListIdentifiableLanguagesOptions listIdentifiableLanguagesOptions) List identifiable languages.
ServiceCall<TranslationModels>	listModels() List models.
ServiceCall<TranslationModels>	listModels(ListModelsOptions listModelsOptions) List models.
ServiceCall<TranslationResult>	translate(TranslateOptions translateOptions) Translate.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LanguageTranslator

public LanguageTranslator(java.lang.String versionDate)

Instantiates a new `LanguageTranslator`.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

LanguageTranslator

public LanguageTranslator(java.lang.String versionDate,
                          java.lang.String username,
                          java.lang.String password)

Instantiates a new `LanguageTranslator` with username and password.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

username - the username

password - the password

LanguageTranslator

public LanguageTranslator(java.lang.String versionDate,
                          IamOptions iamOptions)

Instantiates a new `LanguageTranslator` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

iamOptions - the options for authenticating through IAM

Method Detail

translate

public ServiceCall<TranslationResult> translate(TranslateOptions translateOptions)

Translate. Translates the input text from the source language to the target language.

Parameters:

translateOptions - the TranslateOptions containing the options for the call

Returns:

a ServiceCall with a response type of TranslationResult

identify

public ServiceCall<IdentifiedLanguages> identify(IdentifyOptions identifyOptions)

Identify language. Identifies the language of the input text.

Parameters:

identifyOptions - the IdentifyOptions containing the options for the call

Returns:

a ServiceCall with a response type of IdentifiedLanguages

listIdentifiableLanguages

public ServiceCall<IdentifiableLanguages> listIdentifiableLanguages(ListIdentifiableLanguagesOptions listIdentifiableLanguagesOptions)

List identifiable languages. Lists the languages that the service can identify. Returns the language code (for example, `en` for English or `es` for Spanish) and name of each language.

Parameters:

listIdentifiableLanguagesOptions - the ListIdentifiableLanguagesOptions containing the options for the call

Returns:

a ServiceCall with a response type of IdentifiableLanguages

listIdentifiableLanguages

public ServiceCall<IdentifiableLanguages> listIdentifiableLanguages()

List identifiable languages. Lists the languages that the service can identify. Returns the language code (for example, `en` for English or `es` for Spanish) and name of each language.

Returns:

a ServiceCall with a response type of IdentifiableLanguages

createModel

public ServiceCall<TranslationModel> createModel(CreateModelOptions createModelOptions)

Create model. Uploads Translation Memory eXchange (TMX) files to customize a translation model. You can either customize a model with a forced glossary or with a corpus that contains parallel sentences. To create a model that is customized with a parallel corpus and a forced glossary, proceed in two steps: customize with a parallel corpus first and then customize the resulting model with a glossary. Depending on the type of customization and the size of the uploaded corpora, training can range from minutes for a glossary to several hours for a large parallel corpus. You can upload a single forced glossary file and this file must be less than 10 MB. You can upload multiple parallel corpora tmx files. The cumulative file size of all uploaded files is limited to 250 MB. To successfully train with a parallel corpus you must have at least 5,000 parallel sentences in your corpus. You can have a maxium of 10 custom models per language pair.

Parameters:

createModelOptions - the CreateModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of TranslationModel

deleteModel

public ServiceCall<java.lang.Void> deleteModel(DeleteModelOptions deleteModelOptions)

Delete model. Deletes a custom translation model.

Parameters:

deleteModelOptions - the DeleteModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getModel

public ServiceCall<TranslationModel> getModel(GetModelOptions getModelOptions)

Get model details. Gets information about a translation model, including training status for custom models. Use this API call to poll the status of your customization request. A successfully completed training will have a status of `available`.

Parameters:

getModelOptions - the GetModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of TranslationModel

listModels

public ServiceCall<TranslationModels> listModels(ListModelsOptions listModelsOptions)

List models. Lists available translation models.

Parameters:

listModelsOptions - the ListModelsOptions containing the options for the call

Returns:

a ServiceCall with a response type of TranslationModels

listModels

public ServiceCall<TranslationModels> listModels()

List models. Lists available translation models.

Returns:

a ServiceCall with a response type of TranslationModels