Class ZCL_IBMC_TEXT_TO_SPEECH

Class ZCL_IBMC_TEXT_TO_SPEECH_V1

public inheriting from zcl_ibmc_service_ext create public

Documentation

Text to Speech

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 <code><mark></code> 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). For phonetic translation, the Arabic, Chinese, Dutch, Australian English, Korean, and Swedish voices support only IPA, not SPR.

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

Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural voices or expressive neural voices are deprecated.*<br/><br/> For more information, see the [1 March 2023 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release- notes#text-to-speech-1march2023) in the release notes for {{site.data.keyword.texttospeechshort}} for {{site.data.keyword.cloud_notm}}.{: deprecated}

Types

Visibility and Level	Name	Documentation
public	t_create_custom_model (structured type)	Information about the new custom model.
public	t_custom_model (structured type)	Information about an existing custom model.
public	t_custom_models (structured type)	Information about existing custom models.
public	t_empty_response_body type jsonobject	The empty response from a request.
public	t_error_model (structured type)	The error response from a failed request.
public	t_inline_object (structured type)	No documentation available.
public	t_prompt (structured type)	Information about a custom prompt.
public	t_prompts (structured type)	Information about the custom prompts that are defined for a custom model.
public	t_prompt_metadata (structured type)	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" }`.
public	t_pronunciation (structured type)	The pronunciation of the specified text.
public	t_speaker (structured type)	Information about a speaker model.
public	t_speakers (structured type)	Information about all speaker models for the service instance.
public	t_speaker_custom_model (structured type)	A custom models for which the speaker has defined prompts.
public	t_speaker_custom_models (structured type)	Custom models for which the speaker has defined prompts.
public	t_speaker_model (structured type)	The speaker ID of the speaker model.
public	t_speaker_prompt (structured type)	A prompt that a speaker has defined for a custom model.
public	t_supported_features (structured type)	Additional service features that are supported with the voice.
public	t_text (structured type)	The text to synthesize. Specify either plain text or a subset of SSML. SSML is an XML-based markup language that provides text annotation for speech-synthesis applications. Pass a maximum of 5 KB of input text. For more information, see * [Specifying input text](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-usingHTTP# input) * [Understanding SSML](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-ssml).
public	t_translation (structured type)	Information about the translation for the specified text.
public	t_update_custom_model (structured type)	Information about the updated custom model.
public	t_voice (structured type)	Information about an available voice.
public	t_voices (structured type)	Information about all available voices.
public	t_word (structured type)	Information about a word for the custom model.
public	t_words (structured type)	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.

Constants

Visibility and Level	Name	Documentation
public static	c_abapname_dictionary (structured type)	Map ABAP identifiers to service identifiers.
public static	c_required_fields (structured type)	List of required fields per type.

Methods

Visibility and Level

Name

Documentation

public instance

add_custom_prompt
importing	i_customization_id	type string
	i_prompt_id	type string
	i_metadata	type t_prompt_metadata
	i_file	type file
	i_file_ct	type string default zif_ibmc_service_arch~c_mediatype-all
	i_contenttype	type string default 'multipart/form-data'
	i_accept	type string default 'application/json'
exporting	e_response	type t_prompt
raising	zcx_ibmc_service_exception

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`:

`<ibm:prompt id="goodbye"/>`

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

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

**See also:**
* [Add a custom prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-crea te#tbe-create-add-prompt)
* [Evaluate a custom prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-crea te#tbe-create-evaluate-prompt)
* [Rules for creating custom prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rul es#tbe-rules-prompts)

Parameters

i_customization_id	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.
i_prompt_id	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.
i_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" }`.
i_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.
e_response	Service return value of type T_PROMPT

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

add_word
importing	i_customization_id	type string
	i_word	type string
	i_translation	type t_translation
	i_contenttype	type string default 'application/json'
raising	zcx_ibmc_service_exception

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

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

or in the proprietary IBM Symbolic Phonetic Representation (SPR)

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

**See also:**
* [Adding a single word to a custom model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor ds#cuWordAdd)
* [Adding words to a Japanese custom model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor ds#cuJapaneseAdd)
* [Understanding customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c ustomIntro#customIntro)

Parameters

i_customization_id	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.
i_word	The word that is to be added or updated for the custom model.
i_translation	The translation for the word that is to be added or updated.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

add_words
importing	i_customization_id	type string
	i_custom_words	type t_words
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

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

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

or in the proprietary IBM Symbolic Phonetic Representation (SPR)

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

**See also:**
* [Adding multiple words to a custom model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor ds#cuWordsAdd)
* [Adding words to a Japanese custom model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor ds#cuJapaneseAdd)
* [Understanding customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c ustomIntro#customIntro)

Parameters

i_customization_id	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.
i_custom_words	No documentation available.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_custom_model
importing	i_create_voice_model	type t_create_custom_model
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_custom_model
raising	zcx_ibmc_service_exception

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-customMod els#cuModelsCreate).

**Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release- notes#text-to-speech-1march2023) in the release notes.

Parameters

i_create_voice_model	A `CreateCustomModel` object that contains information about the new custom model.
e_response	Service return value of type T_CUSTOM_MODEL

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_speaker_model
importing	i_speaker_name	type string
	i_audio	type file
	i_contenttype	type string default 'audio/wav'
	i_accept	type string default 'application/json'
exporting	e_response	type t_speaker_model
raising	zcx_ibmc_service_exception

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-creat e#tbe-create-speaker-model)
* [Rules for creating speaker models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rule s#tbe-rules-speakers)

Parameters

i_speaker_name	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.
i_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.
e_response	Service return value of type T_SPEAKER_MODEL

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_custom_model
importing	i_customization_id	type string
raising	zcx_ibmc_service_exception

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-customMod els#cuModelsDelete).

Parameters

i_customization_id

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.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_custom_prompt
importing	i_customization_id	type string
	i_prompt_id	type string
raising	zcx_ibmc_service_exception

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-cust om-prompts#tbe-custom-prompts-delete).

Parameters

i_customization_id	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.
i_prompt_id	The identifier (name) of the prompt that is to be deleted.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_speaker_model
importing	i_speaker_id	type string
raising	zcx_ibmc_service_exception

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-speak er-models#tbe-speaker-models-delete).

Parameters

i_speaker_id

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.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_user_data
importing	i_customer_id	type string
raising	zcx_ibmc_service_exception

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-inform ation-security#information-security).

Parameters

i_customer_id

The customer ID for which all data is to be deleted.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_word
importing	i_customization_id	type string
	i_word	type string
raising	zcx_ibmc_service_exception

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-customWor ds#cuWordDelete).

Parameters

i_customization_id	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.
i_word	The word that is to be deleted from the custom model.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_appname redefinition

public instance

get_custom_model
importing	i_customization_id	type string
	i_accept	type string default 'application/json'
exporting	e_response	type t_custom_model
raising	zcx_ibmc_service_exception

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-customMod els#cuModelsQuery).

Parameters

i_customization_id	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.
e_response	Service return value of type T_CUSTOM_MODEL

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_custom_prompt
importing	i_customization_id	type string
	i_prompt_id	type string
	i_accept	type string default 'application/json'
exporting	e_response	type t_prompt
raising	zcx_ibmc_service_exception

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-cus tom-prompts#tbe-custom-prompts-list).

Parameters

i_customization_id	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.
i_prompt_id	The identifier (name) of the prompt.
e_response	Service return value of type T_PROMPT

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_pronunciation
importing	i_text	type string
	i_voice	type string default 'en-US_MichaelV3Voice'
	i_format	type string default 'ipa'
	i_customization_id	type string optional
	i_accept	type string default 'application/json'
exporting	e_response	type t_pronunciation
raising	zcx_ibmc_service_exception

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.

**Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release- notes#text-to-speech-1march2023) in the release notes.

**See also:** [Querying a word from a language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-custom Words#cuWordsQueryLanguage).

Parameters

i_text	The word for which the pronunciation is requested.
i_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-us e#specify-voice-default).
i_format	The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, Australian English, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in the default format.
i_customization_id	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.
e_response	Service return value of type T_PRONUNCIATION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_request_prop redefinition

public instance

get_sdk_version_date redefinition

public instance

get_speaker_model
importing	i_speaker_id	type string
	i_accept	type string default 'application/json'
exporting	e_response	type t_speaker_custom_models
raising	zcx_ibmc_service_exception

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-speak er-models#tbe-speaker-models-list-prompts).

Parameters

i_speaker_id	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.
e_response	Service return value of type T_SPEAKER_CUSTOM_MODELS

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_voice
importing	i_voice	type string
	i_customization_id	type string optional
	i_accept	type string default 'application/json'
exporting	e_response	type t_voice
raising	zcx_ibmc_service_exception

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-li st#list-specific-voice).

**Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release- notes#text-to-speech-1march2023) in the release notes.

Parameters

i_voice	The voice for which information is to be returned.
i_customization_id	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.
e_response	Service return value of type T_VOICE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_word
importing	i_customization_id	type string
	i_word	type string
	i_accept	type string default 'application/json'
exporting	e_response	type t_translation
raising	zcx_ibmc_service_exception

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-customWor ds#cuWordQueryModel).

Parameters

i_customization_id	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.
i_word	The word that is to be queried from the custom model.
e_response	Service return value of type T_TRANSLATION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_custom_models
importing	i_language	type string optional
	i_accept	type string default 'application/json'
exporting	e_response	type t_custom_models
raising	zcx_ibmc_service_exception

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-customMo dels#cuModelsQueryAll).

Parameters

i_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.
e_response	Service return value of type T_CUSTOM_MODELS

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_custom_prompts
importing	i_customization_id	type string
	i_accept	type string default 'application/json'
exporting	e_response	type t_prompts
raising	zcx_ibmc_service_exception

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-cus tom-prompts#tbe-custom-prompts-list).

Parameters

i_customization_id	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.
e_response	Service return value of type T_PROMPTS

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_speaker_models
importing	i_accept	type string default 'application/json'
exporting	e_response	type t_speakers
raising	zcx_ibmc_service_exception

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-spea ker-models#tbe-speaker-models-list).

Parameters

e_response

Service return value of type T_SPEAKERS

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_voices
importing	i_accept	type string default 'application/json'
exporting	e_response	type t_voices
raising	zcx_ibmc_service_exception

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).

**Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release- notes#text-to-speech-1march2023) in the release notes.

**See also:** [Listing all voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-l ist#list-all-voices)

Parameters

e_response

Service return value of type T_VOICES

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_words
importing	i_customization_id	type string
	i_accept	type string default 'application/json'
exporting	e_response	type t_words
raising	zcx_ibmc_service_exception

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-customWor ds#cuWordsQueryModel).

Parameters

i_customization_id	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.
e_response	Service return value of type T_WORDS

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

synthesize
importing	i_text	type t_text
	i_accept	type string default 'audio/ogg;codecs=opus'
	i_voice	type string default 'en-US_MichaelV3Voice'
	i_customization_id	type string optional
	i_spell_out_mode	type string default 'default'
	i_rate_percentage	type integer default 0
	i_pitch_percentage	type integer default 0
	i_contenttype	type string default 'application/json'
exporting	e_response	type file
raising	zcx_ibmc_service_exception

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-using HTTP#usingHTTP).

**Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release- notes#text-to-speech-1march2023) in the release notes.

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

For more information about specifying an audio format, including additional details about some of the formats, see [Using audio formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audio-f ormats).

**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.

Parameters

i_text	No documentation available.
i_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.
i_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)< br/> * [Using the default voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-us e#specify-voice-default).
i_customization_id	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.
i_spell_out_mode	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-p arams#params-spell-out-mode).
i_rate_percentage	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).
i_pitch_percentage	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).
e_response	Service return value of type FILE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_custom_model
importing	i_customization_id	type string
	i_update_voice_model	type t_update_custom_model
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

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

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

or in the proprietary IBM Symbolic Phonetic Representation (SPR)

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

**See also:**
* [Updating a custom model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod els#cuModelsUpdate)
* [Adding words to a Japanese custom model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor ds#cuJapaneseAdd)
* [Understanding customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c ustomIntro#customIntro)

Parameters

i_customization_id	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.
i_update_voice_model	An `UpdateCustomModel` object that contains information that is to be updated for the custom model.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.