com.ibm.watson.text_to_speech.v1.model

Class AddWordsOptions

java.lang.Object

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

com.ibm.watson.text_to_speech.v1.model.AddWordsOptions

All Implemented Interfaces:

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

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

The addWords options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	customizationId
protected java.util.List<Word>	words

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	customizationId() Gets the customizationId.
AddWordsOptions.Builder	newBuilder() New builder.
java.util.List<Word>	words() Gets the words.

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

customizationId

protected java.lang.String customizationId

words

protected java.util.List<Word> words

Constructor Detail

AddWordsOptions

protected AddWordsOptions(AddWordsOptions.Builder builder)

Method Detail

newBuilder

public AddWordsOptions.Builder newBuilder()

New builder.

Returns:

a AddWordsOptions builder

customizationId

public java.lang.String customizationId()

Gets the customizationId.

The customization ID (GUID) of the custom voice model. You must make the request with credentials for the instance of the service that owns the custom model.

Returns:

the customizationId

words

public java.util.List<Word> words()

Gets the words.

The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be added or updated for the custom voice model and the word's translation.

The **List custom words** method returns an array of `Word` objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

Returns:

the words