/**
* (C) Copyright IBM Corp. 2025.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///
///
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
import { AbortSignal, BaseService, UserOptions } from 'ibm-cloud-sdk-core';
/**
* 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.
*
*
* 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 supports custom prompts only for US English custom
* models and voices.
*
* API Version: 1.0.0
* See: https://cloud.ibm.com/docs/text-to-speech
*/
declare class TextToSpeechV1 extends BaseService {
static DEFAULT_SERVICE_URL: string;
static DEFAULT_SERVICE_NAME: string;
/**
* Construct a TextToSpeechV1 object.
*
* @param {Object} options - Options for the service.
* @param {string} [options.serviceUrl] - The base URL for the service
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
* @param {string} [options.serviceName] - The name of the service to configure
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set
* @constructor
* @returns {TextToSpeechV1}
*/
constructor(options: UserOptions);
/*************************
* voices
************************/
/**
* 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](#getvoice).
*
*
* **See also:** [Listing all
* voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-list#list-all-voices).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listVoices(params?: TextToSpeechV1.ListVoicesParams): Promise>;
/**
* 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](#listvoices)
* method.
*
* **See also:** [Listing a specific
* voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-list#list-specific-voice).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.voice - The voice for which information is to be returned.
* @param {string} [params.customizationId] - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getVoice(params: TextToSpeechV1.GetVoiceParams): Promise>;
/*************************
* synthesis
************************/
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-usingHTTP#usingHTTP).
*
* ### 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/alaw`, `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/alaw` - You must specify the `rate` of the 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 24,000 Hz for
* Natural voices and 22,050 Hz for all other voices.
* * `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 24,000 Hz for
* Natural voices and 22,050 Hz for for all other voices.
* * `audio/mpeg` - You can optionally specify the `rate` of the audio. The default sampling rate is 24,000 Hz for
* Natural voices and 22,050 Hz for all other voices.
* * `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 48,000 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
* 48,000 Hz.
* * `audio/wav` - You can optionally specify the `rate` of the audio. The default sampling rate is 24,000 Hz for
* Natural voices and 22,050 Hz for all other voices.
* * `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
* 48,000 Hz.
*
* For more information about specifying an audio format, including additional details about some of the formats, see
* [Using audio formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audio-formats).
*
* **Note:** By default, the service returns audio in the Ogg audio format with the Opus codec
* (`audio/ogg;codecs=opus`). However, the Ogg audio format is not supported with the Safari browser. If you are using
* the service with the Safari browser, you must use the `Accept` request header or the `accept` query parameter
* specify a different format in which you want the service to return the audio.
*
* ### 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.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.text - The text to synthesize.
* @param {string} [params.accept] - 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.
* @param {string} [params.voice] - The voice to use for speech synthesis. If you omit the `voice` parameter, the
* service uses the US English `en-US_MichaelV3Voice` by default.
*
* _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:**
* * [Languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices)
* * [Using the default
* voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-use#specify-voice-default).
* @param {string} [params.customizationId] - 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.
* @param {string} [params.spellOutMode] - *For German voices,* indicates how the service is to spell out strings of
* individual letters. To indicate the pace of the spelling, specify one of the following values:
* * `default` - The service reads the characters at the rate at which it synthesizes speech for the request. You can
* also omit the parameter entirely to achieve the default behavior.
* * `singles` - The service reads the characters one at a time, with a brief pause between each character.
* * `pairs` - The service reads the characters two at a time, with a brief pause between each pair.
* * `triples` - The service reads the characters three at a time, with a brief pause between each triplet.
*
* For more information, see [Specifying how strings are spelled
* out](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-spell-out-mode).
* @param {number} [params.ratePercentage] - The percentage change from the default speaking rate of the voice that is
* used for speech synthesis. Each voice has a default speaking rate that is optimized to represent a normal rate of
* speech. The parameter accepts an integer that represents the percentage change from the voice's default rate:
* * Specify a signed negative integer to reduce the speaking rate by that percentage. For example, -10 reduces the
* rate by ten percent.
* * Specify an unsigned or signed positive integer to increase the speaking rate by that percentage. For example, 10
* and +10 increase the rate by ten percent.
* * Specify 0 or omit the parameter to get the default speaking rate for the voice.
*
* The parameter affects the rate for an entire request.
*
* For more information, see [Modifying the speaking
* rate](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-rate-percentage).
* @param {number} [params.pitchPercentage] - The percentage change from the default speaking pitch of the voice that
* is used for speech synthesis. Each voice has a default speaking pitch that is optimized to represent a normal tone
* of voice. The parameter accepts an integer that represents the percentage change from the voice's default tone:
* * Specify a signed negative integer to lower the voice's pitch by that percentage. For example, -5 reduces the tone
* by five percent.
* * Specify an unsigned or signed positive integer to increase the voice's pitch by that percentage. For example, 5
* and +5 increase the tone by five percent.
* * Specify 0 or omit the parameter to get the default speaking pitch for the voice.
*
* The parameter affects the pitch for an entire request.
*
* For more information, see [Modifying the speaking
* pitch](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-pitch-percentage).
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
synthesize(params: TextToSpeechV1.SynthesizeParams): Promise>;
/*************************
* pronunciation
************************/
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.text - The word for which the pronunciation is requested.
* @param {string} [params.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).
* @param {string} [params.format] - The phoneme format in which to return the pronunciation. Omit the parameter to
* obtain the pronunciation in the default format.
* @param {string} [params.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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPronunciation(params: TextToSpeechV1.GetPronunciationParams): Promise>;
/*************************
* customModels
************************/
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The name of the new custom model. Use a localized name that matches the language of
* the custom model. Use a name that describes the purpose of the custom model, such as `Medical custom model` or
* `Legal custom model`. Use a name that is unique among all custom models that you own.
*
* Include a maximum of 256 characters in the name. Do not use backslashes, slashes, colons, equal signs, ampersands,
* or question marks in the name.
* @param {string} [params.language] - 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`.
* @param {string} [params.description] - A recommended description of the new custom model. Use a localized
* description that matches the language of the custom model. Include a maximum of 128 characters in the description.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createCustomModel(params: TextToSpeechV1.CreateCustomModelParams): Promise>;
/**
* 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](#getcustommodel) 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQueryAll).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.language] - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listCustomModels(params?: TextToSpeechV1.ListCustomModelsParams): Promise>;
/**
* 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:**
* * [Updating a custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsUpdate)
* * [Adding words to a Japanese custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuJapaneseAdd)
* * [Understanding
* customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} [params.name] - A new name for the custom model.
* @param {string} [params.description] - A new description for the custom model.
* @param {Word[]} [params.words] - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateCustomModel(params: TextToSpeechV1.UpdateCustomModelParams): Promise>;
/**
* 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](#listcustommodels) method.
*
* **See also:** [Querying a custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQuery).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getCustomModel(params: TextToSpeechV1.GetCustomModelParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsDelete).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteCustomModel(params: TextToSpeechV1.DeleteCustomModelParams): Promise>;
/*************************
* customWords
************************/
/**
* 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:**
* * [Adding multiple words to a custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsAdd)
* * [Adding words to a Japanese custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuJapaneseAdd)
* * [Understanding
* customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {Word[]} params.words - 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.
*
* The [List custom words](#listwords) method returns an array of `Word` objects. Each object shows a word and its
* translation from the custom model. The words are listed in alphabetical order, with uppercase letters listed before
* lowercase letters. The array is empty if the custom model contains no words.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
addWords(params: TextToSpeechV1.AddWordsParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryModel).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listWords(params: TextToSpeechV1.ListWordsParams): Promise>;
/**
* 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:**
* * [Adding a single word to a custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordAdd)
* * [Adding words to a Japanese custom
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuJapaneseAdd)
* * [Understanding
* customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} params.word - The word that is to be added or updated for the custom model.
* @param {string} params.translation - 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. A sounds-like is one or more words that, when combined, sound like the word.
* @param {string} [params.partOfSpeech] - **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).
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
addWord(params: TextToSpeechV1.AddWordParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordQueryModel).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} params.word - The word that is to be queried from the custom model.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWord(params: TextToSpeechV1.GetWordParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordDelete).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} params.word - The word that is to be deleted from the custom model.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteWord(params: TextToSpeechV1.DeleteWordParams): Promise>;
/*************************
* customPrompts
************************/
/**
* 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](#getcustommodel) 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-list).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listCustomPrompts(params: TextToSpeechV1.ListCustomPromptsParams): Promise>;
/**
* 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](#getcustomprompt) 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`:
*
* ``
*
* 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:**
* * [Add a custom
* prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create#tbe-create-add-prompt)
* * [Evaluate a custom
* prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create#tbe-create-evaluate-prompt)
* * [Rules for creating custom
* prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rules#tbe-rules-prompts).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} params.promptId - 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.
* @param {PromptMetadata} params.metadata - 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:
*
* `{ "prompt_text": "Thank you and good-bye!", "speaker_id": "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }`.
* @param {NodeJS.ReadableStream | Buffer} params.file - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
addCustomPrompt(params: TextToSpeechV1.AddCustomPromptParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-list).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} params.promptId - The identifier (name) of the prompt.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getCustomPrompt(params: TextToSpeechV1.GetCustomPromptParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-delete).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customizationId - 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.
* @param {string} params.promptId - The identifier (name) of the prompt that is to be deleted.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteCustomPrompt(params: TextToSpeechV1.DeleteCustomPromptParams): Promise>;
/*************************
* speakerModels
************************/
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-list).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSpeakerModels(params?: TextToSpeechV1.ListSpeakerModelsParams): Promise>;
/**
* 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:**
* * [Create a speaker
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create#tbe-create-speaker-model)
* * [Rules for creating speaker
* models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rules#tbe-rules-speakers).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.speakerName - 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.
* @param {NodeJS.ReadableStream | Buffer} params.audio - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSpeakerModel(params: TextToSpeechV1.CreateSpeakerModelParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-list-prompts).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.speakerId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSpeakerModel(params: TextToSpeechV1.GetSpeakerModelParams): Promise>;
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-delete).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.speakerId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSpeakerModel(params: TextToSpeechV1.DeleteSpeakerModelParams): Promise>;
/*************************
* userData
************************/
/**
* 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](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-information-security#information-security).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customerId - The customer ID for which all data is to be deleted.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteUserData(params: TextToSpeechV1.DeleteUserDataParams): Promise>;
}
/*************************
* interfaces
************************/
declare namespace TextToSpeechV1 {
/** An operation response. */
export interface Response {
result: T;
status: number;
statusText: string;
headers: IncomingHttpHeaders;
}
/** The callback for a service request. */
export type Callback = (error: any, response?: Response) => void;
/** The body of a service request that returns no response data. */
export interface EmptyObject {
}
/** A standard JS object, defined to avoid the limitations of `Object` and `object` */
export interface JsonObject {
[key: string]: any;
}
/*************************
* request interfaces
************************/
interface DefaultParams {
headers?: OutgoingHttpHeaders;
signal?: AbortSignal;
}
/** Parameters for the `listVoices` operation. */
export interface ListVoicesParams extends DefaultParams {
}
/** Parameters for the `getVoice` operation. */
export interface GetVoiceParams extends DefaultParams {
/** The voice for which information is to be returned. */
voice: GetVoiceConstants.Voice | string;
/** 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.
*/
customizationId?: string;
}
/** Constants for the `getVoice` operation. */
export namespace GetVoiceConstants {
/** The voice for which information is to be returned. */
enum Voice {
DE_DE_BIRGITV3VOICE = "de-DE_BirgitV3Voice",
DE_DE_DIETERV3VOICE = "de-DE_DieterV3Voice",
DE_DE_ERIKAV3VOICE = "de-DE_ErikaV3Voice",
EN_AU_HEIDIEXPRESSIVE = "en-AU_HeidiExpressive",
EN_AU_JACKEXPRESSIVE = "en-AU_JackExpressive",
EN_CA_HANNAHNATURAL = "en-CA_HannahNatural",
EN_GB_CHARLOTTEV3VOICE = "en-GB_CharlotteV3Voice",
EN_GB_CHLOENATURAL = "en-GB_ChloeNatural",
EN_GB_GEORGEEXPRESSIVE = "en-GB_GeorgeExpressive",
EN_GB_JAMESV3VOICE = "en-GB_JamesV3Voice",
EN_GB_GEORGENATURAL = "en-GB_GeorgeNatural",
EN_GB_KATEV3VOICE = "en-GB_KateV3Voice",
EN_US_ALLISONEXPRESSIVE = "en-US_AllisonExpressive",
EN_US_ALLISONV3VOICE = "en-US_AllisonV3Voice",
EN_US_ELLIENATURAL = "en-US_EllieNatural",
EN_US_EMILYV3VOICE = "en-US_EmilyV3Voice",
EN_US_EMMAEXPRESSIVE = "en-US_EmmaExpressive",
EN_US_EMMANATURAL = "en-US_EmmaNatural",
EN_US_ETHANNATURAL = "en-US_EthanNatural",
EN_US_HENRYV3VOICE = "en-US_HenryV3Voice",
EN_US_JACKSONNATURAL = "en-US_JacksonNatural",
EN_US_KEVINV3VOICE = "en-US_KevinV3Voice",
EN_US_LISAEXPRESSIVE = "en-US_LisaExpressive",
EN_US_LISAV3VOICE = "en-US_LisaV3Voice",
EN_US_MICHAELEXPRESSIVE = "en-US_MichaelExpressive",
EN_US_MICHAELV3VOICE = "en-US_MichaelV3Voice",
EN_US_OLIVIAV3VOICE = "en-US_OliviaV3Voice",
EN_US_VICTORIANATURAL = "en-US_VictoriaNatural",
ES_ES_ENRIQUEV3VOICE = "es-ES_EnriqueV3Voice",
ES_ES_LAURAV3VOICE = "es-ES_LauraV3Voice",
ES_LA_DANIELAEXPRESSIVE = "es-LA_DanielaExpressive",
ES_LA_SOFIAV3VOICE = "es-LA_SofiaV3Voice",
ES_US_SOFIAV3VOICE = "es-US_SofiaV3Voice",
FR_CA_LOUISEV3VOICE = "fr-CA_LouiseV3Voice",
FR_FR_NICOLASV3VOICE = "fr-FR_NicolasV3Voice",
FR_FR_RENEEV3VOICE = "fr-FR_ReneeV3Voice",
IT_IT_FRANCESCAV3VOICE = "it-IT_FrancescaV3Voice",
JA_JP_EMIV3VOICE = "ja-JP_EmiV3Voice",
KO_KR_JINV3VOICE = "ko-KR_JinV3Voice",
NL_NL_MERELV3VOICE = "nl-NL_MerelV3Voice",
PT_BR_CAMILANATURAL = "pt-BR_CamilaNatural",
PT_BR_ISABELAV3VOICE = "pt-BR_IsabelaV3Voice",
PT_BR_LUCASEXPRESSIVE = "pt-BR_LucasExpressive",
PT_BR_LUCASNATURAL = "pt-BR_LucasNatural"
}
}
/** Parameters for the `synthesize` operation. */
export interface SynthesizeParams extends DefaultParams {
/** The text to synthesize. */
text: 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.
*/
accept?: SynthesizeConstants.Accept | string;
/** The voice to use for speech synthesis. If you omit the `voice` parameter, the service uses the US English
* `en-US_MichaelV3Voice` by default.
*
* _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:**
* * [Languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices)
* * [Using the default
* voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-use#specify-voice-default).
*/
voice?: SynthesizeConstants.Voice | 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.
*/
customizationId?: string;
/** *For German voices,* indicates how the service is to spell out strings of individual letters. To indicate
* the pace of the spelling, specify one of the following values:
* * `default` - The service reads the characters at the rate at which it synthesizes speech for the request. You
* can also omit the parameter entirely to achieve the default behavior.
* * `singles` - The service reads the characters one at a time, with a brief pause between each character.
* * `pairs` - The service reads the characters two at a time, with a brief pause between each pair.
* * `triples` - The service reads the characters three at a time, with a brief pause between each triplet.
*
* For more information, see [Specifying how strings are spelled
* out](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-spell-out-mode).
*/
spellOutMode?: SynthesizeConstants.SpellOutMode | string;
/** The percentage change from the default speaking rate of the voice that is used for speech synthesis. Each
* voice has a default speaking rate that is optimized to represent a normal rate of speech. The parameter accepts
* an integer that represents the percentage change from the voice's default rate:
* * Specify a signed negative integer to reduce the speaking rate by that percentage. For example, -10 reduces the
* rate by ten percent.
* * Specify an unsigned or signed positive integer to increase the speaking rate by that percentage. For example,
* 10 and +10 increase the rate by ten percent.
* * Specify 0 or omit the parameter to get the default speaking rate for the voice.
*
* The parameter affects the rate for an entire request.
*
* For more information, see [Modifying the speaking
* rate](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-rate-percentage).
*/
ratePercentage?: number;
/** The percentage change from the default speaking pitch of the voice that is used for speech synthesis. Each
* voice has a default speaking pitch that is optimized to represent a normal tone of voice. The parameter accepts
* an integer that represents the percentage change from the voice's default tone:
* * Specify a signed negative integer to lower the voice's pitch by that percentage. For example, -5 reduces the
* tone by five percent.
* * Specify an unsigned or signed positive integer to increase the voice's pitch by that percentage. For example,
* 5 and +5 increase the tone by five percent.
* * Specify 0 or omit the parameter to get the default speaking pitch for the voice.
*
* The parameter affects the pitch for an entire request.
*
* For more information, see [Modifying the speaking
* pitch](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-pitch-percentage).
*/
pitchPercentage?: number;
}
/** Constants for the `synthesize` operation. */
export namespace SynthesizeConstants {
/** 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. */
enum Accept {
AUDIO_ALAW = "audio/alaw",
AUDIO_BASIC = "audio/basic",
AUDIO_FLAC = "audio/flac",
AUDIO_L16 = "audio/l16",
AUDIO_OGG = "audio/ogg",
AUDIO_OGG_CODECS_OPUS = "audio/ogg;codecs=opus",
AUDIO_OGG_CODECS_VORBIS = "audio/ogg;codecs=vorbis",
AUDIO_MP3 = "audio/mp3",
AUDIO_MPEG = "audio/mpeg",
AUDIO_MULAW = "audio/mulaw",
AUDIO_WAV = "audio/wav",
AUDIO_WEBM = "audio/webm",
AUDIO_WEBM_CODECS_OPUS = "audio/webm;codecs=opus",
AUDIO_WEBM_CODECS_VORBIS = "audio/webm;codecs=vorbis"
}
/** The voice to use for speech synthesis. If you omit the `voice` parameter, the service uses the US English `en-US_MichaelV3Voice` by default. _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:** * [Languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices) * [Using the default voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-use#specify-voice-default). */
enum Voice {
DE_DE_BIRGITV3VOICE = "de-DE_BirgitV3Voice",
DE_DE_DIETERV3VOICE = "de-DE_DieterV3Voice",
DE_DE_ERIKAV3VOICE = "de-DE_ErikaV3Voice",
EN_AU_HEIDIEXPRESSIVE = "en-AU_HeidiExpressive",
EN_AU_JACKEXPRESSIVE = "en-AU_JackExpressive",
EN_CA_HANNAHNATURAL = "en-CA_HannahNatural",
EN_GB_CHARLOTTEV3VOICE = "en-GB_CharlotteV3Voice",
EN_GB_CHLOENATURAL = "en-GB_ChloeNatural",
EN_GB_GEORGEEXPRESSIVE = "en-GB_GeorgeExpressive",
EN_GB_JAMESV3VOICE = "en-GB_JamesV3Voice",
EN_GB_GEORGENATURAL = "en-GB_GeorgeNatural",
EN_GB_KATEV3VOICE = "en-GB_KateV3Voice",
EN_US_ALLISONEXPRESSIVE = "en-US_AllisonExpressive",
EN_US_ALLISONV3VOICE = "en-US_AllisonV3Voice",
EN_US_ELLIENATURAL = "en-US_EllieNatural",
EN_US_EMILYV3VOICE = "en-US_EmilyV3Voice",
EN_US_EMMAEXPRESSIVE = "en-US_EmmaExpressive",
EN_US_EMMANATURAL = "en-US_EmmaNatural",
EN_US_ETHANNATURAL = "en-US_EthanNatural",
EN_US_HENRYV3VOICE = "en-US_HenryV3Voice",
EN_US_JACKSONNATURAL = "en-US_JacksonNatural",
EN_US_KEVINV3VOICE = "en-US_KevinV3Voice",
EN_US_LISAEXPRESSIVE = "en-US_LisaExpressive",
EN_US_LISAV3VOICE = "en-US_LisaV3Voice",
EN_US_MICHAELEXPRESSIVE = "en-US_MichaelExpressive",
EN_US_MICHAELV3VOICE = "en-US_MichaelV3Voice",
EN_US_OLIVIAV3VOICE = "en-US_OliviaV3Voice",
EN_US_VICTORIANATURAL = "en-US_VictoriaNatural",
ES_ES_ENRIQUEV3VOICE = "es-ES_EnriqueV3Voice",
ES_ES_LAURAV3VOICE = "es-ES_LauraV3Voice",
ES_LA_DANIELAEXPRESSIVE = "es-LA_DanielaExpressive",
ES_LA_SOFIAV3VOICE = "es-LA_SofiaV3Voice",
ES_US_SOFIAV3VOICE = "es-US_SofiaV3Voice",
FR_CA_LOUISEV3VOICE = "fr-CA_LouiseV3Voice",
FR_FR_NICOLASV3VOICE = "fr-FR_NicolasV3Voice",
FR_FR_RENEEV3VOICE = "fr-FR_ReneeV3Voice",
IT_IT_FRANCESCAV3VOICE = "it-IT_FrancescaV3Voice",
JA_JP_EMIV3VOICE = "ja-JP_EmiV3Voice",
KO_KR_JINV3VOICE = "ko-KR_JinV3Voice",
NL_NL_MERELV3VOICE = "nl-NL_MerelV3Voice",
PT_BR_CAMILANATURAL = "pt-BR_CamilaNatural",
PT_BR_ISABELAV3VOICE = "pt-BR_IsabelaV3Voice",
PT_BR_LUCASEXPRESSIVE = "pt-BR_LucasExpressive",
PT_BR_LUCASNATURAL = "pt-BR_LucasNatural"
}
/** *For German voices,* indicates how the service is to spell out strings of individual letters. To indicate the pace of the spelling, specify one of the following values: * `default` - The service reads the characters at the rate at which it synthesizes speech for the request. You can also omit the parameter entirely to achieve the default behavior. * `singles` - The service reads the characters one at a time, with a brief pause between each character. * `pairs` - The service reads the characters two at a time, with a brief pause between each pair. * `triples` - The service reads the characters three at a time, with a brief pause between each triplet. For more information, see [Specifying how strings are spelled out](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-spell-out-mode). */
enum SpellOutMode {
DEFAULT = "default",
SINGLES = "singles",
PAIRS = "pairs",
TRIPLES = "triples"
}
}
/** Parameters for the `getPronunciation` operation. */
export interface GetPronunciationParams extends DefaultParams {
/** The word for which the pronunciation is requested. */
text: string;
/** 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).
*/
voice?: GetPronunciationConstants.Voice | string;
/** The phoneme format in which to return the pronunciation. Omit the parameter to obtain the pronunciation in
* the default format.
*/
format?: GetPronunciationConstants.Format | 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.
*/
customizationId?: string;
}
/** Constants for the `getPronunciation` operation. */
export namespace GetPronunciationConstants {
/** 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). */
enum Voice {
DE_DE_BIRGITV3VOICE = "de-DE_BirgitV3Voice",
DE_DE_DIETERV3VOICE = "de-DE_DieterV3Voice",
DE_DE_ERIKAV3VOICE = "de-DE_ErikaV3Voice",
EN_AU_HEIDIEXPRESSIVE = "en-AU_HeidiExpressive",
EN_AU_JACKEXPRESSIVE = "en-AU_JackExpressive",
EN_CA_HANNAHNATURAL = "en-CA_HannahNatural",
EN_GB_CHARLOTTEV3VOICE = "en-GB_CharlotteV3Voice",
EN_GB_CHLOENATURAL = "en-GB_ChloeNatural",
EN_GB_GEORGEEXPRESSIVE = "en-GB_GeorgeExpressive",
EN_GB_JAMESV3VOICE = "en-GB_JamesV3Voice",
EN_GB_GEORGENATURAL = "en-GB_GeorgeNatural",
EN_GB_KATEV3VOICE = "en-GB_KateV3Voice",
EN_US_ALLISONEXPRESSIVE = "en-US_AllisonExpressive",
EN_US_ALLISONV3VOICE = "en-US_AllisonV3Voice",
EN_US_ELLIENATURAL = "en-US_EllieNatural",
EN_US_EMILYV3VOICE = "en-US_EmilyV3Voice",
EN_US_EMMAEXPRESSIVE = "en-US_EmmaExpressive",
EN_US_EMMANATURAL = "en-US_EmmaNatural",
EN_US_ETHANNATURAL = "en-US_EthanNatural",
EN_US_HENRYV3VOICE = "en-US_HenryV3Voice",
EN_US_JACKSONNATURAL = "en-US_JacksonNatural",
EN_US_KEVINV3VOICE = "en-US_KevinV3Voice",
EN_US_LISAEXPRESSIVE = "en-US_LisaExpressive",
EN_US_LISAV3VOICE = "en-US_LisaV3Voice",
EN_US_MICHAELEXPRESSIVE = "en-US_MichaelExpressive",
EN_US_MICHAELV3VOICE = "en-US_MichaelV3Voice",
EN_US_OLIVIAV3VOICE = "en-US_OliviaV3Voice",
EN_US_VICTORIANATURAL = "en-US_VictoriaNatural",
ES_ES_ENRIQUEV3VOICE = "es-ES_EnriqueV3Voice",
ES_ES_LAURAV3VOICE = "es-ES_LauraV3Voice",
ES_LA_DANIELAEXPRESSIVE = "es-LA_DanielaExpressive",
ES_LA_SOFIAV3VOICE = "es-LA_SofiaV3Voice",
ES_US_SOFIAV3VOICE = "es-US_SofiaV3Voice",
FR_CA_LOUISEV3VOICE = "fr-CA_LouiseV3Voice",
FR_FR_NICOLASV3VOICE = "fr-FR_NicolasV3Voice",
FR_FR_RENEEV3VOICE = "fr-FR_ReneeV3Voice",
IT_IT_FRANCESCAV3VOICE = "it-IT_FrancescaV3Voice",
JA_JP_EMIV3VOICE = "ja-JP_EmiV3Voice",
KO_KR_JINV3VOICE = "ko-KR_JinV3Voice",
NL_NL_MERELV3VOICE = "nl-NL_MerelV3Voice",
PT_BR_CAMILANATURAL = "pt-BR_CamilaNatural",
PT_BR_ISABELAV3VOICE = "pt-BR_IsabelaV3Voice",
PT_BR_LUCASEXPRESSIVE = "pt-BR_LucasExpressive",
PT_BR_LUCASNATURAL = "pt-BR_LucasNatural"
}
/** The phoneme format in which to return the pronunciation. Omit the parameter to obtain the pronunciation in the default format. */
enum Format {
IBM = "ibm",
IPA = "ipa"
}
}
/** Parameters for the `createCustomModel` operation. */
export interface CreateCustomModelParams extends DefaultParams {
/** The name of the new custom model. Use a localized name that matches the language of the custom model. Use a
* name that describes the purpose of the custom model, such as `Medical custom model` or `Legal custom model`. Use
* a name that is unique among all custom models that you own.
*
* Include a maximum of 256 characters in the name. Do not use backslashes, slashes, colons, equal signs,
* ampersands, or question marks in the name.
*/
name: string;
/** 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`.
*/
language?: CreateCustomModelConstants.Language | string;
/** A recommended description of the new custom model. Use a localized description that matches the language of
* the custom model. Include a maximum of 128 characters in the description.
*/
description?: string;
}
/** Constants for the `createCustomModel` operation. */
export namespace CreateCustomModelConstants {
/** 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`. */
enum Language {
DE_DE = "de-DE",
EN_AU = "en-AU",
EN_GB = "en-GB",
EN_US = "en-US",
ES_ES = "es-ES",
ES_LA = "es-LA",
ES_US = "es-US",
FR_CA = "fr-CA",
FR_FR = "fr-FR",
IT_IT = "it-IT",
JA_JP = "ja-JP",
NL_NL = "nl-NL",
PT_BR = "pt-BR"
}
}
/** Parameters for the `listCustomModels` operation. */
export interface ListCustomModelsParams extends DefaultParams {
/** 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.
*/
language?: ListCustomModelsConstants.Language | string;
}
/** Constants for the `listCustomModels` operation. */
export namespace ListCustomModelsConstants {
/** 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. */
enum Language {
DE_DE = "de-DE",
EN_AU = "en-AU",
EN_GB = "en-GB",
EN_US = "en-US",
ES_ES = "es-ES",
ES_LA = "es-LA",
ES_US = "es-US",
FR_CA = "fr-CA",
FR_FR = "fr-FR",
IT_IT = "it-IT",
JA_JP = "ja-JP",
NL_NL = "nl-NL",
PT_BR = "pt-BR"
}
}
/** Parameters for the `updateCustomModel` operation. */
export interface UpdateCustomModelParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** A new name for the custom model. */
name?: string;
/** A new description for the custom model. */
description?: string;
/** 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.
*/
words?: Word[];
}
/** Parameters for the `getCustomModel` operation. */
export interface GetCustomModelParams extends DefaultParams {
/** 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.
*/
customizationId: string;
}
/** Parameters for the `deleteCustomModel` operation. */
export interface DeleteCustomModelParams extends DefaultParams {
/** 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.
*/
customizationId: string;
}
/** Parameters for the `addWords` operation. */
export interface AddWordsParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** 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.
*
* The [List custom words](#listwords) method returns an array of `Word` objects. Each object shows a word and its
* translation from the custom model. The words are listed in alphabetical order, with uppercase letters listed
* before lowercase letters. The array is empty if the custom model contains no words.
*/
words: Word[];
}
/** Parameters for the `listWords` operation. */
export interface ListWordsParams extends DefaultParams {
/** 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.
*/
customizationId: string;
}
/** Parameters for the `addWord` operation. */
export interface AddWordParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** The word that is to be added or updated for the custom model. */
word: 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. A
* sounds-like is one or more words that, when combined, sound like the word.
*/
translation: string;
/** **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).
*/
partOfSpeech?: AddWordConstants.PartOfSpeech | string;
}
/** Constants for the `addWord` operation. */
export namespace AddWordConstants {
/** **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). */
enum PartOfSpeech {
DOSI = "Dosi",
FUKU = "Fuku",
GOBI = "Gobi",
HOKA = "Hoka",
JODO = "Jodo",
JOSI = "Josi",
KATO = "Kato",
KEDO = "Kedo",
KEYO = "Keyo",
KIGO = "Kigo",
KOYU = "Koyu",
MESI = "Mesi",
RETA = "Reta",
STBI = "Stbi",
STTO = "Stto",
STZO = "Stzo",
SUJI = "Suji"
}
}
/** Parameters for the `getWord` operation. */
export interface GetWordParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** The word that is to be queried from the custom model. */
word: string;
}
/** Parameters for the `deleteWord` operation. */
export interface DeleteWordParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** The word that is to be deleted from the custom model. */
word: string;
}
/** Parameters for the `listCustomPrompts` operation. */
export interface ListCustomPromptsParams extends DefaultParams {
/** 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.
*/
customizationId: string;
}
/** Parameters for the `addCustomPrompt` operation. */
export interface AddCustomPromptParams extends DefaultParams {
/** 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.
*/
customizationId: 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.
*/
promptId: string;
/** 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:
*
* `{ "prompt_text": "Thank you and good-bye!", "speaker_id": "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }`.
*/
metadata: PromptMetadata;
/** 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.
*/
file: NodeJS.ReadableStream | Buffer;
}
/** Parameters for the `getCustomPrompt` operation. */
export interface GetCustomPromptParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** The identifier (name) of the prompt. */
promptId: string;
}
/** Parameters for the `deleteCustomPrompt` operation. */
export interface DeleteCustomPromptParams extends DefaultParams {
/** 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.
*/
customizationId: string;
/** The identifier (name) of the prompt that is to be deleted. */
promptId: string;
}
/** Parameters for the `listSpeakerModels` operation. */
export interface ListSpeakerModelsParams extends DefaultParams {
}
/** Parameters for the `createSpeakerModel` operation. */
export interface CreateSpeakerModelParams extends DefaultParams {
/** 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.
*/
speakerName: string;
/** 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.
*/
audio: NodeJS.ReadableStream | Buffer;
}
/** Parameters for the `getSpeakerModel` operation. */
export interface GetSpeakerModelParams extends DefaultParams {
/** 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.
*/
speakerId: string;
}
/** Parameters for the `deleteSpeakerModel` operation. */
export interface DeleteSpeakerModelParams extends DefaultParams {
/** 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.
*/
speakerId: string;
}
/** Parameters for the `deleteUserData` operation. */
export interface DeleteUserDataParams extends DefaultParams {
/** The customer ID for which all data is to be deleted. */
customerId: string;
}
/*************************
* model interfaces
************************/
/**
* Information about an existing custom model.
*/
export interface CustomModel {
/** The customization ID (GUID) of the custom model. The [Create a custom model](#createcustommodel) method
* returns only this field. It does not not return the other fields of this object.
*/
customization_id: string;
/** The name of the custom model. */
name?: string;
/** The language identifier of the custom model (for example, `en-US`). */
language?: string;
/** The GUID of the credentials for the instance of the service that owns the custom model. */
owner?: string;
/** The date and time in Coordinated Universal Time (UTC) at which the custom model was created. The value is
* provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`).
*/
created?: string;
/** The date and time in Coordinated Universal Time (UTC) at which the custom model was last modified. The
* `created` and `updated` fields are equal when a model is first added but has yet to be updated. The value is
* provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`).
*/
last_modified?: string;
/** The description of the custom model. */
description?: string;
/** An array of `Word` objects that lists the words and their translations from the custom model. The words are
* listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if no
* words are defined for the custom model. This field is returned only by the [Get a custom model](#getcustommodel)
* method.
*/
words?: Word[];
/** An array of `Prompt` objects that provides information about the prompts that are defined for the specified
* custom model. The array is empty if no prompts are defined for the custom model. This field is returned only by
* the [Get a custom model](#getcustommodel) method.
*/
prompts?: Prompt[];
}
/**
* Information about existing custom models.
*/
export interface CustomModels {
/** An array of `CustomModel` objects that provides information about each available custom model. The array is
* empty if the requesting credentials own no custom models (if no language is specified) or own no custom models
* for the specified language.
*/
customizations: CustomModel[];
}
/**
* Information about a custom prompt.
*/
export interface Prompt {
/** The user-specified text of the prompt. */
prompt: string;
/** The user-specified identifier (name) of the prompt. */
prompt_id: string;
/** The status of the prompt:
* * `processing`: The service received the request to add the prompt and is analyzing the validity of the prompt.
* * `available`: The service successfully validated the prompt, which is now ready for use in a speech synthesis
* request.
* * `failed`: The service's validation of the prompt failed. The status of the prompt includes an `error` field
* that describes the reason for the failure.
*/
status: string;
/** If the status of the prompt is `failed`, an error message that describes the reason for the failure. The
* field is omitted if no error occurred.
*/
error?: string;
/** The speaker ID (GUID) of the speaker for which the prompt was defined. The field is omitted if no speaker ID
* was specified.
*/
speaker_id?: string;
}
/**
* 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:
*
* `{ "prompt_text": "Thank you and good-bye!", "speaker_id": "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }`.
*/
export interface PromptMetadata {
/** The required written text of the spoken prompt. The length of a prompt's text is limited to a few sentences.
* Speaking one or two sentences of text is the recommended limit. A prompt cannot contain more than 1000
* characters of text. Escape any XML control characters (double quotes, single quotes, ampersands, angle brackets,
* and slashes) that appear in the text of the prompt.
*/
prompt_text: string;
/** The optional speaker ID (GUID) of a previously defined speaker model that is to be associated with the
* prompt.
*/
speaker_id?: string;
}
/**
* Information about the custom prompts that are defined for a custom model.
*/
export interface Prompts {
/** An array of `Prompt` objects that provides information about the prompts that are defined for the specified
* custom model. The array is empty if no prompts are defined for the custom model.
*/
prompts: Prompt[];
}
/**
* The pronunciation of the specified text.
*/
export interface Pronunciation {
/** The pronunciation of the specified text in the requested voice and format. If a custom model is specified,
* the pronunciation also reflects that custom model.
*/
pronunciation: string;
}
/**
* Information about a speaker model.
*/
export interface Speaker {
/** The speaker ID (GUID) of the speaker. */
speaker_id: string;
/** The user-defined name of the speaker. */
name: string;
}
/**
* A custom models for which the speaker has defined prompts.
*/
export interface SpeakerCustomModel {
/** The customization ID (GUID) of a custom model for which the speaker has defined one or more prompts. */
customization_id: string;
/** An array of `SpeakerPrompt` objects that provides information about each prompt that the user has defined
* for the custom model.
*/
prompts: SpeakerPrompt[];
}
/**
* Custom models for which the speaker has defined prompts.
*/
export interface SpeakerCustomModels {
/** An array of `SpeakerCustomModel` objects. Each object provides information about the prompts that are
* defined for a specified speaker in the custom models that are owned by a specified service instance. The array
* is empty if no prompts are defined for the speaker.
*/
customizations: SpeakerCustomModel[];
}
/**
* The speaker ID of the speaker model.
*/
export interface SpeakerModel {
/** The speaker ID (GUID) of the speaker model. */
speaker_id: string;
}
/**
* A prompt that a speaker has defined for a custom model.
*/
export interface SpeakerPrompt {
/** The user-specified text of the prompt. */
prompt: string;
/** The user-specified identifier (name) of the prompt. */
prompt_id: string;
/** The status of the prompt:
* * `processing`: The service received the request to add the prompt and is analyzing the validity of the prompt.
* * `available`: The service successfully validated the prompt, which is now ready for use in a speech synthesis
* request.
* * `failed`: The service's validation of the prompt failed. The status of the prompt includes an `error` field
* that describes the reason for the failure.
*/
status: string;
/** If the status of the prompt is `failed`, an error message that describes the reason for the failure. The
* field is omitted if no error occurred.
*/
error?: string;
}
/**
* Information about all speaker models for the service instance.
*/
export interface Speakers {
/** An array of `Speaker` objects that provides information about the speakers for the service instance. The
* array is empty if the service instance has no speakers.
*/
speakers: Speaker[];
}
/**
* Additional service features that are supported with the voice.
*/
export interface SupportedFeatures {
/** If `true`, the voice can be customized; if `false`, the voice cannot be customized. (Same as
* `customizable`.).
*/
custom_pronunciation: boolean;
/** If `true`, the voice can be transformed by using the SSML `` element; if `false`, the
* voice cannot be transformed. **Note:** The SSML `` element is obsolete. You can no longer
* use the element with any supported voice.
*/
voice_transformation: boolean;
}
/**
* Information about the translation for the specified text.
*/
export interface Translation {
/** 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. A
* sounds-like is one or more words that, when combined, sound like the word.
*/
translation: string;
/** **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).
*/
part_of_speech?: Translation.Constants.PartOfSpeech | string;
}
export namespace Translation {
namespace Constants {
/** **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). */
enum PartOfSpeech {
DOSI = "Dosi",
FUKU = "Fuku",
GOBI = "Gobi",
HOKA = "Hoka",
JODO = "Jodo",
JOSI = "Josi",
KATO = "Kato",
KEDO = "Kedo",
KEYO = "Keyo",
KIGO = "Kigo",
KOYU = "Koyu",
MESI = "Mesi",
RETA = "Reta",
STBI = "Stbi",
STTO = "Stto",
STZO = "Stzo",
SUJI = "Suji"
}
}
}
/**
* Information about an available voice.
*/
export interface Voice {
/** The URI of the voice. */
url: string;
/** The gender of the voice: `male` or `female`. */
gender: string;
/** The name of the voice. Use this as the voice identifier in all requests. */
name: string;
/** The language and region of the voice (for example, `en-US`). */
language: string;
/** A textual description of the voice. */
description: string;
/** If `true`, the voice can be customized; if `false`, the voice cannot be customized. (Same as
* `custom_pronunciation`; maintained for backward compatibility.).
*/
customizable: boolean;
/** Additional service features that are supported with the voice. */
supported_features: SupportedFeatures;
/** Returns information about a specified custom model. This field is returned only by the [Get a
* voice](#getvoice) method and only when you specify the customization ID of a custom model.
*/
customization?: CustomModel;
}
/**
* Information about all available voices.
*/
export interface Voices {
/** A list of available voices. */
voices: Voice[];
}
/**
* Information about a word for the custom model.
*/
export interface Word {
/** The word for the custom model. The maximum length of a word is 49 characters. */
word: 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 or IBM SPR translation. A sounds-like translation
* consists of one or more words that, when combined, sound like the word. The maximum length of a translation is
* 499 characters.
*/
translation: string;
/** **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).
*/
part_of_speech?: Word.Constants.PartOfSpeech | string;
}
export namespace Word {
namespace Constants {
/** **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). */
enum PartOfSpeech {
DOSI = "Dosi",
FUKU = "Fuku",
GOBI = "Gobi",
HOKA = "Hoka",
JODO = "Jodo",
JOSI = "Josi",
KATO = "Kato",
KEDO = "Kedo",
KEYO = "Keyo",
KIGO = "Kigo",
KOYU = "Koyu",
MESI = "Mesi",
RETA = "Reta",
STBI = "Stbi",
STTO = "Stto",
STZO = "Stzo",
SUJI = "Suji"
}
}
}
/**
* For the [Add custom words](#addwords) method, one or more words that are to be added or updated for the custom
* model and the translation for each specified word.
*
* For the [List custom words](#listwords) method, the words and their translations from the custom model.
*/
export interface Words {
/** 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.
*
* The [List custom words](#listwords) method returns an array of `Word` objects. Each object shows a word and its
* translation from the custom model. The words are listed in alphabetical order, with uppercase letters listed
* before lowercase letters. The array is empty if the custom model contains no words.
*/
words: Word[];
}
export {};
}
export = TextToSpeechV1;