Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetPronunciationParams

Parameters for the getPronunciation operation.

Hierarchy

  • GetPronunciationParams

Index

Properties

Optional customizationId

customizationId: string

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.

Optional format

format: Format | string

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.

Optional headers

headers: OutgoingHttpHeaders

text

text: string

The word for which the pronunciation is requested.

Optional voice

voice: Voice | string

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.

Generated using TypeDoc