com.ibm.watson.text_to_speech.v1.model

Class AddWordOptions

java.lang.Object

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

com.ibm.watson.text_to_speech.v1.model.AddWordOptions

All Implemented Interfaces:

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

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

The addWord options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddWordOptions.Builder Builder.
static interface	AddWordOptions.PartOfSpeech **Japanese only.** The part of speech for the word.

Method Summary

Modifier and Type	Method and Description
String	customizationId() Gets the customizationId.
AddWordOptions.Builder	newBuilder() New builder.
String	partOfSpeech() Gets the partOfSpeech.
String	translation() Gets the translation.
String	word() Gets the word.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public AddWordOptions.Builder newBuilder()

New builder.

Returns:

a AddWordOptions builder

customizationId

public String customizationId()

Gets the customizationId.

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

Returns:

the customizationId

word

public String word()

Gets the word.

The word that is to be added or updated for the custom model.

Returns:

the word

translation

public String translation()

Gets the translation.

The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

Returns:

the translation

partOfSpeech

public String partOfSpeech()

Gets the partOfSpeech.

**Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-rules#jaNotes).

Returns:

the partOfSpeech