com.ibm.watson.language_translator.v3.model

Class TranslateOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.language_translator.v3.model.TranslateOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class TranslateOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The translate options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TranslateOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	modelId
protected java.lang.String	source
protected java.lang.String	target
protected java.util.List<java.lang.String>	text

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TranslateOptions(TranslateOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	modelId() Gets the modelId.
TranslateOptions.Builder	newBuilder() New builder.
java.lang.String	source() Gets the source.
java.lang.String	target() Gets the target.
java.util.List<java.lang.String>	text() Gets the text.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

text

protected java.util.List<java.lang.String> text

modelId

protected java.lang.String modelId

source

protected java.lang.String source

target

protected java.lang.String target

Constructor Detail

TranslateOptions

protected TranslateOptions(TranslateOptions.Builder builder)

Method Detail

newBuilder

public TranslateOptions.Builder newBuilder()

New builder.

Returns:

a TranslateOptions builder

text

public java.util.List<java.lang.String> text()

Gets the text.

Input text in UTF-8 encoding. Multiple entries result in multiple translations in the response.

Returns:

the text

modelId

public java.lang.String modelId()

Gets the modelId.

The model to use for translation. For example, `en-de` selects the IBM-provided base model for English-to-German translation. A model ID overrides the `source` and `target` parameters and is required if you use a custom model. If no model ID is specified, you must specify at least a target language.

Returns:

the modelId

source

public java.lang.String source()

Gets the source.

Language code that specifies the language of the input text. If omitted, the service derives the source language from the input text. The input must contain sufficient text for the service to identify the language reliably.

Returns:

the source

target

public java.lang.String target()

Gets the target.

Language code that specifies the target language for translation. Required if model ID is not specified.

Returns:

the target