Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextToSpeechV1

The IBM Watson™ Text to Speech service provides APIs that use IBM's speech-synthesis capabilities to synthesize text into natural-sounding speech in a variety of languages, dialects, and voices. The service supports at least one male or female voice, sometimes both, for each language. The audio is streamed back to the client with minimal delay. interfaces

For speech synthesis, the service supports a synchronous HTTP Representational State Transfer (REST) interface and a WebSocket interface. Both interfaces support plain text and SSML input. SSML is an XML-based markup language that provides text annotation for speech-synthesis applications. The WebSocket interface also supports the SSML <mark> element and word timings.

The service offers a customization interface that you can use to define sounds-like or phonetic translations for words. A sounds-like translation consists of one or more words that, when combined, sound like the word. A phonetic translation is based on the SSML phoneme format for representing a word. You can specify a phonetic translation in standard International Phonetic Alphabet (IPA) representation or in the proprietary IBM Symbolic Phonetic Representation (SPR).

The service also offers a Tune by Example feature that lets you define custom prompts. You can also define speaker models to improve the quality of your custom prompts. The service support custom prompts only for US English custom models and voices.

IBM Cloud®. The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are supported only for IBM Cloud. For phonetic translation, they support only IPA, not SPR.

API Version: 1.0.0 See: https://cloud.ibm.com/docs/text-to-speech

Hierarchy

  • BaseService
    • TextToSpeechV1

Index

Namespaces

Constructors

Properties

Methods

Constructors

constructor

Properties

Static DEFAULT_SERVICE_NAME

DEFAULT_SERVICE_NAME: string = "text_to_speech"

Static DEFAULT_SERVICE_URL

DEFAULT_SERVICE_URL: string = "https://api.us-south.text-to-speech.watson.cloud.ibm.com"

Methods

addCustomPrompt

  • Add a custom prompt.

    Adds a custom prompt to a custom model. A prompt is defined by the text that is to be spoken, the audio for that text, a unique user-specified ID for the prompt, and an optional speaker ID. The information is used to generate prosodic data that is not visible to the user. This data is used by the service to produce the synthesized audio upon request. You must use credentials for the instance of the service that owns a custom model to add a prompt to it. You can add a maximum of 1000 custom prompts to a single custom model.

    You are recommended to assign meaningful values for prompt IDs. For example, use goodbye to identify a prompt that speaks a farewell message. Prompt IDs must be unique within a given custom model. You cannot define two prompts with the same name for the same custom model. If you provide the ID of an existing prompt, the previously uploaded prompt is replaced by the new information. The existing prompt is reprocessed by using the new text and audio and, if provided, new speaker model, and the prosody data associated with the prompt is updated.

    The quality of a prompt is undefined if the language of a prompt does not match the language of its custom model. This is consistent with any text or SSML that is specified for a speech synthesis request. The service makes a best-effort attempt to render the specified text for the prompt; it does not validate that the language of the text matches the language of the model.

    Adding a prompt is an asynchronous operation. Although it accepts less audio than speaker enrollment, the service must align the audio with the provided text. The time that it takes to process a prompt depends on the prompt itself. The processing time for a reasonably sized prompt generally matches the length of the audio (for example, it takes 20 seconds to process a 20-second prompt).

    For shorter prompts, you can wait for a reasonable amount of time and then check the status of the prompt with the Get a custom prompt method. For longer prompts, consider using that method to poll the service every few seconds to determine when the prompt becomes available. No prompt can be used for speech synthesis if it is in the processing or failed state. Only prompts that are in the available state can be used for speech synthesis.

    When it processes a request, the service attempts to align the text and the audio that are provided for the prompt. The text that is passed with a prompt must match the spoken audio as closely as possible. Optimally, the text and audio match exactly. The service does its best to align the specified text with the audio, and it can often compensate for mismatches between the two. But if the service cannot effectively align the text and the audio, possibly because the magnitude of mismatches between the two is too great, processing of the prompt fails.

    Evaluating a prompt

    Always listen to and evaluate a prompt to determine its quality before using it in production. To evaluate a prompt, include only the single prompt in a speech synthesis request by using the following SSML extension, in this case for a prompt whose ID is goodbye:

    <ibm:prompt id="goodbye"/>

    In some cases, you might need to rerecord and resubmit a prompt as many as five times to address the following possible problems:

    • The service might fail to detect a mismatch between the prompt’s text and audio. The longer the prompt, the greater the chance for misalignment between its text and audio. Therefore, multiple shorter prompts are preferable to a single long prompt.
    • The text of a prompt might include a word that the service does not recognize. In this case, you can create a custom word and pronunciation pair to tell the service how to pronounce the word. You must then re-create the prompt.
    • The quality of the input audio might be insufficient or the service’s processing of the audio might fail to detect the intended prosody. Submitting new audio for the prompt can correct these issues.

    If a prompt that is created without a speaker ID does not adequately reflect the intended prosody, enrolling the speaker and providing a speaker ID for the prompt is one recommended means of potentially improving the quality of the prompt. This is especially important for shorter prompts such as "good-bye" or "thank you," where less audio data makes it more difficult to match the prosody of the speaker. Custom prompts are supported only for use with US English custom models and voices.

    See also:

    Parameters

    Name Type Attribute Description
    params AddCustomPromptParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    file ReadableStream | Buffer An audio file that speaks the text of the prompt with intonation and prosody that matches how you would like the prompt to be spoken. * The prompt audio must be in WAV format and must have a minimum sampling rate of 16 kHz. The service accepts audio with higher sampling rates. The service transcodes all audio to 16 kHz before processing it. * The length of the prompt audio is limited to 30 seconds.
    metadata PromptMetadata Information about the prompt that is to be added to a custom model. The following example of a `PromptMetadata` object includes both the required prompt text and an optional speaker model ID:
    promptId string The identifier of the prompt that is to be added to the custom model: * Include a maximum of 49 characters in the ID. * Include only alphanumeric characters and `_` (underscores) in the ID. * Do not include XML sensitive characters (double quotes, single quotes, ampersands, angle brackets, and slashes) in the ID. * To add a new prompt, the ID must be unique for the specified custom model. Otherwise, the new information for the prompt overwrites the existing prompt that has that ID.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Prompt>>

addWord

  • Add a custom word.

    Adds a single word and its translation to the specified custom model. Adding a new translation for a word that already exists in a custom model overwrites the word's existing translation. A custom model can contain no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add a word to it.

    You can define sounds-like or phonetic translations for words. A sounds-like translation consists of one or more words that, when combined, sound like the word. Phonetic translations are based on the SSML phoneme format for representing a word. You can specify them in standard International Phonetic Alphabet (IPA) representation

    <phoneme alphabet="ipa" ph="təmˈɑto"></phoneme>

    or in the proprietary IBM Symbolic Phonetic Representation (SPR)

    <phoneme alphabet="ibm" ph="1gAstroEntxrYFXs"></phoneme>

    See also:

    Parameters

    Name Type Attribute Description
    params AddWordParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    translation string 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. The Arabic, Chinese, Dutch, Australian English, and Korean languages support only IPA. A sounds-like is one or more words that, when combined, sound like the word.
    word string The word that is to be added or updated for the custom model.
    headers OutgoingHttpHeaders Optional
    partOfSpeech PartOfSpeech | string Optional *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 Promise<Response<Empty>>

addWords

  • Add custom words.

    Adds one or more words and their translations to the specified custom model. Adding a new translation for a word that already exists in a custom model overwrites the word's existing translation. A custom model can contain no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add words to it.

    You can define sounds-like or phonetic translations for words. A sounds-like translation consists of one or more words that, when combined, sound like the word. Phonetic translations are based on the SSML phoneme format for representing a word. You can specify them in standard International Phonetic Alphabet (IPA) representation

    <phoneme alphabet="ipa" ph="təmˈɑto"></phoneme>

    or in the proprietary IBM Symbolic Phonetic Representation (SPR)

    <phoneme alphabet="ibm" ph="1gAstroEntxrYFXs"></phoneme>

    See also:

    Parameters

    Name Type Attribute Description
    params AddWordsParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    words Word[] The [Add custom words](#addwords) method accepts an array of `Word` objects. Each object provides a word that is to be added or updated for the custom model and the word's translation.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Empty>>

createCustomModel

  • Create a custom model.

    Creates a new empty custom model. You must specify a name for the new custom model. You can optionally specify the language and a description for the new model. The model is owned by the instance of the service whose credentials are used to create it.

    See also: Creating a custom model.

    Important voice updates for IBM Cloud

    The service's voices underwent significant change on 2 December 2020.

    • The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative.
    • The ar-AR_OmarVoice voice is deprecated. Use ar-MS_OmarVoice voice instead.
    • The ar-AR language identifier cannot be used to create a custom model. Use the ar-MS identifier instead.
    • The standard concatenative voices for the following languages are now deprecated: Brazilian Portuguese, United Kingdom and United States English, French, German, Italian, Japanese, and Spanish (all dialects).
    • The features expressive SSML, voice transformation SSML, and use of the volume attribute of the <prosody> element are deprecated and are not supported with any of the service's neural voices.
    • All of the service's voices are now customizable and generally available (GA) for production use.

    The deprecated voices and features will continue to function for at least one year but might be removed at a future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For more information about all voice updates, see the 2 December 2020 service update in the release notes for IBM Cloud.

    Parameters

    Name Type Attribute Description
    params CreateCustomModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    name string The name of the new custom model.
    description string Optional A description of the new custom model. Specifying a description is recommended.
    headers OutgoingHttpHeaders Optional
    language Language | string Optional The language of the new custom model. You create a custom model for a specific language, not for a specific voice. A custom model can be used with any voice for its specified language. Omit the parameter to use the the default language, `en-US`. **Note:** The `ar-AR` language identifier cannot be used to create a custom model. Use the `ar-MS` identifier instead.

    Returns Promise<Response<CustomModel>>

createSpeakerModel

  • Create a speaker model.

    Creates a new speaker model, which is an optional enrollment token for users who are to add prompts to custom models. A speaker model contains information about a user's voice. The service extracts this information from a WAV audio sample that you pass as the body of the request. Associating a speaker model with a prompt is optional, but the information that is extracted from the speaker model helps the service learn about the speaker's voice.

    A speaker model can make an appreciable difference in the quality of prompts, especially short prompts with relatively little audio, that are associated with that speaker. A speaker model can help the service produce a prompt with more confidence; the lack of a speaker model can potentially compromise the quality of a prompt.

    The gender of the speaker who creates a speaker model does not need to match the gender of a voice that is used with prompts that are associated with that speaker model. For example, a speaker model that is created by a male speaker can be associated with prompts that are spoken by female voices.

    You create a speaker model for a given instance of the service. The new speaker model is owned by the service instance whose credentials are used to create it. That same speaker can then be used to create prompts for all custom models within that service instance. No language is associated with a speaker model, but each custom model has a single specified language. You can add prompts only to US English models.

    You specify a name for the speaker when you create it. The name must be unique among all speaker names for the owning service instance. To re-create a speaker model for an existing speaker name, you must first delete the existing speaker model that has that name.

    Speaker enrollment is a synchronous operation. Although it accepts more audio data than a prompt, the process of adding a speaker is very fast. The service simply extracts information about the speaker’s voice from the audio. Unlike prompts, speaker models neither need nor accept a transcription of the audio. When the call returns, the audio is fully processed and the speaker enrollment is complete.

    The service returns a speaker ID with the request. A speaker ID is globally unique identifier (GUID) that you use to identify the speaker in subsequent requests to the service. Speaker models and the custom prompts with which they are used are supported only for use with US English custom models and voices.

    See also:

    Parameters

    Name Type Attribute Description
    params CreateSpeakerModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    audio ReadableStream | Buffer An enrollment audio file that contains a sample of the speaker’s voice. * The enrollment audio must be in WAV format and must have a minimum sampling rate of 16 kHz. The service accepts audio with higher sampling rates. It transcodes all audio to 16 kHz before processing it. * The length of the enrollment audio is limited to 1 minute. Speaking one or two paragraphs of text that include five to ten sentences is recommended.
    speakerName string The name of the speaker that is to be added to the service instance. * Include a maximum of 49 characters in the name. * Include only alphanumeric characters and `_` (underscores) in the name. * Do not include XML sensitive characters (double quotes, single quotes, ampersands, angle brackets, and slashes) in the name. * Do not use the name of an existing speaker that is already defined for the service instance.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<SpeakerModel>>

deleteCustomModel

  • Delete a custom model.

    Deletes the specified custom model. You must use credentials for the instance of the service that owns a model to delete it.

    See also: Deleting a custom model.

    Parameters

    Name Type Attribute Description
    params DeleteCustomModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Empty>>

deleteCustomPrompt

  • Delete a custom prompt.

    Deletes an existing custom prompt from a custom model. The service deletes the prompt with the specified ID. You must use credentials for the instance of the service that owns the custom model from which the prompt is to be deleted.

    Caution: Deleting a custom prompt elicits a 400 response code from synthesis requests that attempt to use the prompt. Make sure that you do not attempt to use a deleted prompt in a production application. Custom prompts are supported only for use with US English custom models and voices.

    See also: Deleting a custom prompt.

    Parameters

    Name Type Attribute Description
    params DeleteCustomPromptParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    promptId string The identifier (name) of the prompt that is to be deleted.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Empty>>

deleteSpeakerModel

  • Delete a speaker model.

    Deletes an existing speaker model from the service instance. The service deletes the enrolled speaker with the specified speaker ID. You must use credentials for the instance of the service that owns a speaker model to delete the speaker.

    Any prompts that are associated with the deleted speaker are not affected by the speaker's deletion. The prosodic data that defines the quality of a prompt is established when the prompt is created. A prompt is static and remains unaffected by deletion of its associated speaker. However, the prompt cannot be resubmitted or updated with its original speaker once that speaker is deleted. Speaker models and the custom prompts with which they are used are supported only for use with US English custom models and voices.

    See also: Deleting a speaker model.

    Parameters

    Name Type Attribute Description
    params DeleteSpeakerModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    speakerId string The speaker ID (GUID) of the speaker model. You must make the request with service credentials for the instance of the service that owns the speaker model.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Empty>>

deleteUserData

  • Delete labeled data.

    Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to associate the customer ID with the data. You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes the data.

    Note: If you delete an instance of the service from the service console, all data associated with that service instance is automatically deleted. This includes all custom models and word/translation pairs, and all data related to speech synthesis requests.

    See also: Information security.

    Parameters

    Name Type Attribute Description
    params DeleteUserDataParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customerId string The customer ID for which all data is to be deleted.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Empty>>

deleteWord

  • Delete a custom word.

    Deletes a single word from the specified custom model. You must use credentials for the instance of the service that owns a model to delete its words.

    See also: Deleting a word from a custom model.

    Parameters

    Name Type Attribute Description
    params DeleteWordParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    word string The word that is to be deleted from the custom model.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Empty>>

disableRetries

  • disableRetries(): void

  • Disables retries.

    Returns void

enableRetries

  • enableRetries(retryOptions?: RetryOptions): void

  • Enable retries for unfulfilled requests.

    Parameters

    Name Type Attribute Description
    retryOptions RetryOptions Optional

    configuration for retries

    Returns void

getAuthenticator

  • getAuthenticator(): any

  • Get the instance of the authenticator set on the service.

    Returns any

getCustomModel

  • Get a custom model.

    Gets all information about a specified custom model. In addition to metadata such as the name and description of the custom model, the output includes the words and their translations that are defined for the model, as well as any prompts that are defined for the model. To see just the metadata for a model, use the List custom models method.

    See also: Querying a custom model.

    Parameters

    Name Type Attribute Description
    params GetCustomModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<CustomModel>>

getCustomPrompt

  • Get a custom prompt.

    Gets information about a specified custom prompt for a specified custom model. The information includes the prompt ID, prompt text, status, and optional speaker ID for each prompt of the custom model. You must use credentials for the instance of the service that owns the custom model. Custom prompts are supported only for use with US English custom models and voices.

    See also: Listing custom prompts.

    Parameters

    Name Type Attribute Description
    params GetCustomPromptParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    promptId string The identifier (name) of the prompt.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Prompt>>

getHttpClient

  • getHttpClient(): AxiosInstance

  • Get the Axios instance set on the service. All requests will be made using this instance.

    Returns AxiosInstance

getPronunciation

  • Get pronunciation.

    Gets the phonetic pronunciation for the specified word. You can request the pronunciation for a specific format. You can also request the pronunciation for a specific voice to see the default translation for the language of that voice or for a specific custom model to see the translation for that model.

    See also: Querying a word from a language.

    Important voice updates for IBM Cloud

    The service's voices underwent significant change on 2 December 2020.

    • The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative.
    • The ar-AR_OmarVoice voice is deprecated. Use ar-MS_OmarVoice voice instead.
    • The ar-AR language identifier cannot be used to create a custom model. Use the ar-MS identifier instead.
    • The standard concatenative voices for the following languages are now deprecated: Brazilian Portuguese, United Kingdom and United States English, French, German, Italian, Japanese, and Spanish (all dialects).
    • The features expressive SSML, voice transformation SSML, and use of the volume attribute of the <prosody> element are deprecated and are not supported with any of the service's neural voices.
    • All of the service's voices are now customizable and generally available (GA) for production use.

    The deprecated voices and features will continue to function for at least one year but might be removed at a future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For more information about all voice updates, see the 2 December 2020 service update in the release notes for IBM Cloud.

    Parameters

    Name Type Attribute Description
    params GetPronunciationParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    text string The word for which the pronunciation is requested.
    customizationId string Optional 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.
    format Format | string Optional 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.
    headers OutgoingHttpHeaders Optional
    voice Voice | string Optional 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.

    Returns Promise<Response<Pronunciation>>

getSpeakerModel

  • Get a speaker model.

    Gets information about all prompts that are defined by a specified speaker for all custom models that are owned by a service instance. The information is grouped by the customization IDs of the custom models. For each custom model, the information lists information about each prompt that is defined for that custom model by the speaker. You must use credentials for the instance of the service that owns a speaker model to list its prompts. Speaker models and the custom prompts with which they are used are supported only for use with US English custom models and voices.

    See also: Listing the custom prompts for a speaker model.

    Parameters

    Name Type Attribute Description
    params GetSpeakerModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    speakerId string The speaker ID (GUID) of the speaker model. You must make the request with service credentials for the instance of the service that owns the speaker model.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<SpeakerCustomModels>>

getVoice

  • Get a voice.

    Gets information about the specified voice. The information includes the name, language, gender, and other details about the voice. Specify a customization ID to obtain information for a custom model that is defined for the language of the specified voice. To list information about all available voices, use the List voices method.

    See also: Listing a specific voice.

    Important voice updates for IBM Cloud

    The service's voices underwent significant change on 2 December 2020.

    • The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative.
    • The ar-AR_OmarVoice voice is deprecated. Use ar-MS_OmarVoice voice instead.
    • The ar-AR language identifier cannot be used to create a custom model. Use the ar-MS identifier instead.
    • The standard concatenative voices for the following languages are now deprecated: Brazilian Portuguese, United Kingdom and United States English, French, German, Italian, Japanese, and Spanish (all dialects).
    • The features expressive SSML, voice transformation SSML, and use of the volume attribute of the <prosody> element are deprecated and are not supported with any of the service's neural voices.
    • All of the service's voices are now customizable and generally available (GA) for production use.

    The deprecated voices and features will continue to function for at least one year but might be removed at a future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For more information about all voice updates, see the 2 December 2020 service update in the release notes for IBM Cloud.

    Parameters

    Name Type Attribute Description
    params GetVoiceParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    voice Voice | string The voice for which information is to be returned. For more information about specifying a voice, see **Important voice updates for IBM Cloud** in the method description.
    customizationId string Optional The customization ID (GUID) of a custom model for which information is to be returned. You must make the request with credentials for the instance of the service that owns the custom model. Omit the parameter to see information about the specified voice with no customization.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Voice>>

getWord

  • Get a custom word.

    Gets the translation for a single word from the specified custom model. The output shows the translation as it is defined in the model. You must use credentials for the instance of the service that owns a model to list its words.

    See also: Querying a single word from a custom model.

    Parameters

    Name Type Attribute Description
    params GetWordParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    word string The word that is to be queried from the custom model.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Translation>>

listCustomModels

  • List custom models.

    Lists metadata such as the name and description for all custom models that are owned by an instance of the service. Specify a language to list the custom models for that language only. To see the words and prompts in addition to the metadata for a specific custom model, use the Get a custom model method. You must use credentials for the instance of the service that owns a model to list information about it.

    See also: Querying all custom models.

    Parameters

    Name Type Attribute Description
    params ListCustomModelsParams Optional

    Properties

    Name Type Attributes Description
    headers OutgoingHttpHeaders Optional
    language Language | string Optional The language for which custom models that are owned by the requesting credentials are to be returned. Omit the parameter to see all custom models that are owned by the requester.

    Returns Promise<Response<CustomModels>>

listCustomPrompts

  • List custom prompts.

    Lists information about all custom prompts that are defined for a custom model. The information includes the prompt ID, prompt text, status, and optional speaker ID for each prompt of the custom model. You must use credentials for the instance of the service that owns the custom model. The same information about all of the prompts for a custom model is also provided by the Get a custom model method. That method provides complete details about a specified custom model, including its language, owner, custom words, and more. Custom prompts are supported only for use with US English custom models and voices.

    See also: Listing custom prompts.

    Parameters

    Name Type Attribute Description
    params ListCustomPromptsParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Prompts>>

listSpeakerModels

  • List speaker models.

    Lists information about all speaker models that are defined for a service instance. The information includes the speaker ID and speaker name of each defined speaker. You must use credentials for the instance of a service to list its speakers. Speaker models and the custom prompts with which they are used are supported only for use with US English custom models and voices.

    See also: Listing speaker models.

    Parameters

    Name Type Attribute Description
    params ListSpeakerModelsParams Optional

    Properties

    Name Type Attributes Description
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Speakers>>

listVoices

  • List voices.

    Lists all voices available for use with the service. The information includes the name, language, gender, and other details about the voice. The ordering of the list of voices can change from call to call; do not rely on an alphabetized or static list of voices. To see information about a specific voice, use the Get a voice.

    See also: Listing all available voices.

    Parameters

    Name Type Attribute Description
    params ListVoicesParams Optional

    Properties

    Name Type Attributes Description
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Voices>>

listWords

  • List custom words.

    Lists all of the words and their translations for the specified custom model. The output shows the translations as they are defined in the model. You must use credentials for the instance of the service that owns a model to list its words.

    See also: Querying all words from a custom model.

    Parameters

    Name Type Attribute Description
    params ListWordsParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    headers OutgoingHttpHeaders Optional

    Returns Promise<Response<Words>>

setEnableGzipCompression

  • setEnableGzipCompression(setting: boolean): void

  • Turn request body compression on or off.

    Parameters

    Name Type Attribute Description
    setting boolean

    Will turn it on if 'true', off if 'false'.

    Returns void

setServiceUrl

  • setServiceUrl(url: string): void

  • Set the service URL to send requests to.

    Parameters

    Name Type Attribute Description
    url string

    The base URL for the service.

    Returns void

synthesize

  • Synthesize audio.

    Synthesizes text to audio that is spoken in the specified voice. The service bases its understanding of the language for the input text on the specified voice. Use a voice that matches the language of the input text.

    The method accepts a maximum of 5 KB of input text in the body of the request, and 8 KB for the URL and headers. The 5 KB limit includes any SSML tags that you specify. The service returns the synthesized audio stream as an array of bytes.

    See also: The HTTP interface.

    Audio formats (accept types)

    The service can return audio in the following formats (MIME types).

    • Where indicated, you can optionally specify the sampling rate (rate) of the audio. You must specify a sampling rate for the audio/l16 and audio/mulaw formats. A specified sampling rate must lie in the range of 8 kHz to 192 kHz. Some formats restrict the sampling rate to certain values, as noted.
    • For the audio/l16 format, you can optionally specify the endianness (endianness) of the audio: endianness=big-endian or endianness=little-endian.

    Use the Accept header or the accept parameter to specify the requested format of the response audio. If you omit an audio format altogether, the service returns the audio in Ogg format with the Opus codec (audio/ogg;codecs=opus). The service always returns single-channel audio.

    • audio/basic - The service returns audio with a sampling rate of 8000 Hz.
    • audio/flac - You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.
    • audio/l16 - You must specify the rate of the audio. You can optionally specify the endianness of the audio. The default endianness is little-endian.
    • audio/mp3 - You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.
    • audio/mpeg - You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.
    • audio/mulaw - You must specify the rate of the audio.
    • audio/ogg - The service returns the audio in the vorbis codec. You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.
    • audio/ogg;codecs=opus - You can optionally specify the rate of the audio. Only the following values are valid sampling rates: 48000, 24000, 16000, 12000, or 8000. If you specify a value other than one of these, the service returns an error. The default sampling rate is 48,000 Hz.
    • audio/ogg;codecs=vorbis - You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.
    • audio/wav - You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.
    • audio/webm - The service returns the audio in the opus codec. The service returns audio with a sampling rate of 48,000 Hz.
    • audio/webm;codecs=opus - The service returns audio with a sampling rate of 48,000 Hz.
    • audio/webm;codecs=vorbis - You can optionally specify the rate of the audio. The default sampling rate is 22,050 Hz.

    For more information about specifying an audio format, including additional details about some of the formats, see Using audio formats.

    Important voice updates for IBM Cloud

    The service's voices underwent significant change on 2 December 2020.

    • The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative.
    • The ar-AR_OmarVoice voice is deprecated. Use ar-MS_OmarVoice voice instead.
    • The ar-AR language identifier cannot be used to create a custom model. Use the ar-MS identifier instead.
    • The standard concatenative voices for the following languages are now deprecated: Brazilian Portuguese, United Kingdom and United States English, French, German, Italian, Japanese, and Spanish (all dialects).
    • The features expressive SSML, voice transformation SSML, and use of the volume attribute of the <prosody> element are deprecated and are not supported with any of the service's neural voices.
    • All of the service's voices are now customizable and generally available (GA) for production use.

    The deprecated voices and features will continue to function for at least one year but might be removed at a future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For more information about all voice updates, see the 2 December 2020 service update in the release notes for IBM Cloud.

    Warning messages

    If a request includes invalid query parameters, the service returns a Warnings response header that provides messages about the invalid parameters. The warning includes a descriptive message and a list of invalid argument strings. For example, a message such as "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form "{invalid_arg_1}, {invalid_arg_2}." The request succeeds despite the warnings.

    Parameters

    Name Type Attribute Description
    params SynthesizeParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    text string The text to synthesize.
    accept Accept | string Optional 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.
    customizationId string Optional 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.
    headers OutgoingHttpHeaders Optional
    voice Voice | string Optional The voice to use for synthesis. For more information about specifying a voice, see **Important voice updates for IBM Cloud** in the method description.

    Returns Promise<Response<ReadableStream>>

updateCustomModel

  • Update a custom model.

    Updates information for the specified custom model. You can update metadata such as the name and description of the model. You can also update the words in the model and their translations. Adding a new translation for a word that already exists in a custom model overwrites the word's existing translation. A custom model can contain no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to update it.

    You can define sounds-like or phonetic translations for words. A sounds-like translation consists of one or more words that, when combined, sound like the word. Phonetic translations are based on the SSML phoneme format for representing a word. You can specify them in standard International Phonetic Alphabet (IPA) representation

    <phoneme alphabet="ipa" ph="təmˈɑto"></phoneme>

    or in the proprietary IBM Symbolic Phonetic Representation (SPR)

    <phoneme alphabet="ibm" ph="1gAstroEntxrYFXs"></phoneme>

    See also:

    Parameters

    Name Type Attribute Description
    params UpdateCustomModelParams

    The parameters to send to the service.

    Properties

    Name Type Attributes Description
    customizationId string 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.
    description string Optional A new description for the custom model.
    headers OutgoingHttpHeaders Optional
    name string Optional A new name for the custom model.
    words Word[] Optional An array of `Word` objects that provides the words and their translations that are to be added or updated for the custom model. Pass an empty array to make no additions or updates.

    Returns Promise<Response<Empty>>

Generated using TypeDoc