com.ibm.watson.language_translator.v3

Class LanguageTranslator

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.language_translator.v3.LanguageTranslator

public class LanguageTranslator
extends com.ibm.cloud.sdk.core.service.BaseService

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.cloud.sdk.core.service.BaseService

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
LanguageTranslator(java.lang.String versionDate) Constructs a new `LanguageTranslator` client using the DEFAULT_SERVICE_NAME.
LanguageTranslator(java.lang.String versionDate, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `LanguageTranslator` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
LanguageTranslator(java.lang.String versionDate, java.lang.String serviceName) Constructs a new `LanguageTranslator` client with the specified serviceName.
LanguageTranslator(java.lang.String versionDate, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `LanguageTranslator` client with the specified Authenticator and serviceName.

Method Summary

Methods

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<TranslationModel>	createModel(CreateModelOptions createModelOptions) Create model.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteDocument(DeleteDocumentOptions deleteDocumentOptions) Delete document.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResult>	deleteModel(DeleteModelOptions deleteModelOptions) Delete model.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentStatus>	getDocumentStatus(GetDocumentStatusOptions getDocumentStatusOptions) Get document status.
com.ibm.cloud.sdk.core.http.ServiceCall<TranslationModel>	getModel(GetModelOptions getModelOptions) Get model details.
com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream>	getTranslatedDocument(GetTranslatedDocumentOptions getTranslatedDocumentOptions) Get translated document.
com.ibm.cloud.sdk.core.http.ServiceCall<IdentifiedLanguages>	identify(IdentifyOptions identifyOptions) Identify language.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentList>	listDocuments() List documents.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentList>	listDocuments(ListDocumentsOptions listDocumentsOptions) List documents.
com.ibm.cloud.sdk.core.http.ServiceCall<IdentifiableLanguages>	listIdentifiableLanguages() List identifiable languages.
com.ibm.cloud.sdk.core.http.ServiceCall<IdentifiableLanguages>	listIdentifiableLanguages(ListIdentifiableLanguagesOptions listIdentifiableLanguagesOptions) List identifiable languages.
com.ibm.cloud.sdk.core.http.ServiceCall<TranslationModels>	listModels() List models.
com.ibm.cloud.sdk.core.http.ServiceCall<TranslationModels>	listModels(ListModelsOptions listModelsOptions) List models.
com.ibm.cloud.sdk.core.http.ServiceCall<TranslationResult>	translate(TranslateOptions translateOptions) Translate.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentStatus>	translateDocument(TranslateDocumentOptions translateDocumentOptions) Translate document.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureHttpClient, configureService, createServiceCall, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, 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)

Constructs a new `LanguageTranslator` client using the DEFAULT_SERVICE_NAME.

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,
                  com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `LanguageTranslator` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.

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.

authenticator - the Authenticator instance to be configured for this service

LanguageTranslator

public LanguageTranslator(java.lang.String versionDate,
                  java.lang.String serviceName)

Constructs a new `LanguageTranslator` client with the specified serviceName.

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.

serviceName - The name of the service to configure.

LanguageTranslator

public LanguageTranslator(java.lang.String versionDate,
                  java.lang.String serviceName,
                  com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `LanguageTranslator` client with the specified Authenticator and serviceName.

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.

serviceName - The name of the service to configure.

authenticator - the Authenticator instance to be configured for this service

Method Detail

translate

public com.ibm.cloud.sdk.core.http.ServiceCall<TranslationResult> translate(TranslateOptions translateOptions)

Translate.

Translates the input text from the source language to the target language. A target language or translation model ID is required. The service attempts to detect the language of the source text if it is not specified.

Parameters:

translateOptions - the TranslateOptions containing the options for the call

Returns:

a ServiceCall with a response type of TranslationResult

listIdentifiableLanguages

public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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

identify

public com.ibm.cloud.sdk.core.http.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

listModels

public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.ServiceCall<TranslationModels> listModels()

List models.

Lists available translation models.

Returns:

a ServiceCall with a response type of TranslationModels

createModel

public com.ibm.cloud.sdk.core.http.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 maximum 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 com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResult> 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 DeleteModelResult

getModel

public com.ibm.cloud.sdk.core.http.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

listDocuments

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentList> listDocuments(ListDocumentsOptions listDocumentsOptions)

List documents.

Lists documents that have been submitted for translation.

Parameters:

listDocumentsOptions - the ListDocumentsOptions containing the options for the call

Returns:

a ServiceCall with a response type of DocumentList

listDocuments

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentList> listDocuments()

List documents.

Lists documents that have been submitted for translation.

Returns:

a ServiceCall with a response type of DocumentList

translateDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentStatus> translateDocument(TranslateDocumentOptions translateDocumentOptions)

Translate document.

Submit a document for translation. You can submit the document contents in the `file` parameter, or you can reference a previously submitted document by document ID.

Parameters:

translateDocumentOptions - the TranslateDocumentOptions containing the options for the call

Returns:

a ServiceCall with a response type of DocumentStatus

getDocumentStatus

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentStatus> getDocumentStatus(GetDocumentStatusOptions getDocumentStatusOptions)

Get document status.

Gets the translation status of a document.

Parameters:

getDocumentStatusOptions - the GetDocumentStatusOptions containing the options for the call

Returns:

a ServiceCall with a response type of DocumentStatus

deleteDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteDocument(DeleteDocumentOptions deleteDocumentOptions)

Delete document.

Deletes a document.

Parameters:

deleteDocumentOptions - the DeleteDocumentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getTranslatedDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getTranslatedDocument(GetTranslatedDocumentOptions getTranslatedDocumentOptions)

Get translated document.

Gets the translated document associated with the given document ID.

Parameters:

getTranslatedDocumentOptions - the GetTranslatedDocumentOptions containing the options for the call

Returns:

a ServiceCall with a response type of InputStream