com.ibm.watson.text_to_speech.v1.model

Class GetPronunciationOptions

java.lang.Object

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

com.ibm.watson.text_to_speech.v1.model.GetPronunciationOptions

All Implemented Interfaces:

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

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

The getPronunciation options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetPronunciationOptions.Builder Builder.
static interface	GetPronunciationOptions.Format The phoneme format in which to return the pronunciation.
static interface	GetPronunciationOptions.Voice A voice that specifies the language in which the pronunciation is to be returned.

Method Summary

Modifier and Type	Method and Description
String	customizationId() Gets the customizationId.
String	format() Gets the format.
GetPronunciationOptions.Builder	newBuilder() New builder.
String	text() Gets the text.
String	voice() Gets the voice.

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 GetPronunciationOptions.Builder newBuilder()

New builder.

Returns:

a GetPronunciationOptions builder

text

public String text()

Gets the text.

The word for which the pronunciation is requested.

Returns:

the text

voice

public String voice()

Gets the voice.

A voice that specifies the language in which the pronunciation is to be returned. If you omit the `voice` parameter, the service uses the US English `en-US_MichaelV3Voice` by default. All voices for the same language (for example, `en-US`) return the same translation.

_For IBM Cloud Pak for Data,_ if you do not install the `en-US_MichaelV3Voice`, you must either specify a voice with the request or specify a new default voice for your installation of the service.

**See also:** [Using the default voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-use#specify-voice-default).

Returns:

the voice

format

public String format()

Gets the format.

The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, Australian English, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in the default format.

Returns:

the format

customizationId

public String customizationId()

Gets the customizationId.

The customization ID (GUID) of a custom model for which the pronunciation is to be returned. The language of a specified custom model must match the language of the specified voice. If the word is not defined in the specified custom model, the service returns the default translation for the custom model's language. You must make the request with credentials for the instance of the service that owns the custom model. Omit the parameter to see the translation for the specified voice with no customization.

Returns:

the customizationId