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.
  • Method Details

    • 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. All voices for the same language (for example, `en-US`) return the same translation. For more information about specifying a voice, see **Important voice updates for IBM Cloud** in the method description.

      **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are supported only for IBM Cloud.

      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