Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SynthesizeParams

Parameters for the synthesize operation.

Hierarchy

  • SynthesizeParams

Index

Properties

Optional accept

accept: Accept | string

The requested format (MIME type) of the audio. You can use the Accept header or the accept parameter to specify the audio format. For more information about specifying an audio format, see Audio formats (accept types) in the method description.

Optional customizationId

customizationId: string

The customization ID (GUID) of a custom model to use for the synthesis. If a custom model is specified, it works only if it matches the language of the indicated voice. You must make the request with credentials for the instance of the service that owns the custom model. Omit the parameter to use the specified voice with no customization.

Optional headers

headers: OutgoingHttpHeaders

text

text: string

The text to synthesize.

Optional voice

voice: Voice | string

The voice to use for synthesis. 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.

See also: See also Using languages and voices.

Generated using TypeDoc