com.ibm.watson.developer_cloud.text_to_speech.v1

Class TextToSpeech

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.text_to_speech.v1.TextToSpeech

public class TextToSpeech
extends WatsonService

### Service Overview The IBM® Text to Speech service provides an API that uses 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 more information about the service, see the [IBM® Cloud documentation](https://console.bluemix.net/docs/services/text-to-speech/index.html). ### API usage guidelines * **Audio formats:** The service can produce audio in many formats (MIME types). See [Specifying an audio format](https://console.bluemix.net/docs/services/text-to-speech/http.html#format). * **SSML:** Many methods refer to the Speech Synthesis Markup Language (SSML). SSML is an XML-based markup language that provides text annotation for speech-synthesis applications. See [Using SSML](https://console.bluemix.net/docs/services/text-to-speech/SSML.html) and [Using IBM SPR](https://console.bluemix.net/docs/services/text-to-speech/SPRs.html). * **Word translations:** Many customization methods accept sounds-like or phonetic translations for words. 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 [Understanding customization](https://console.bluemix.net/docs/services/text-to-speech/custom-intro.html). * **WebSocket interface:** The service also offers a WebSocket interface for speech synthesis. The WebSocket interface supports both plain text and SSML input, including the SSML <mark> element and word timings. See [The WebSocket interface](https://console.bluemix.net/docs/services/text-to-speech/websockets.html). * **Customization IDs:** Many methods accept a customization ID, which is a Globally Unique Identifier (GUID). Customization IDs are hexadecimal strings that have the format `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. * **`X-Watson-Learning-Opt-Out`:** By default, all Watson services log requests and their results. Logging is done only to improve the services for future users. The logged data is not shared or made public. To prevent IBM from accessing your data for general service improvements, set the `X-Watson-Learning-Opt-Out` request header to `true` for all requests. You must set the header on each request that you do not want IBM to access for general service improvements. Methods of the customization interface do not log words and translations that you use to build custom voice models. Your training data is never used to improve the service's base models. However, the service does log such data when a custom model is used with a synthesize request. You must set the `X-Watson-Learning-Opt-Out` request header to `true` to prevent IBM from accessing the data to improve the service. * **`X-Watson-Metadata`:** This header allows you to associate a customer ID with data that is passed with a request. If necessary, you can use the **Delete labeled data** method to delete the data for a customer ID. See [Information security](https://console.bluemix.net/docs/services/text-to-speech/information-security.html).

See Also:

Text to Speech

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
TextToSpeech() Instantiates a new `TextToSpeech`.
TextToSpeech(IamOptions iamOptions) Instantiates a new `TextToSpeech` with IAM.
TextToSpeech(java.lang.String username, java.lang.String password) Instantiates a new `TextToSpeech` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<java.lang.Void>	addWord(AddWordOptions addWordOptions) Add a custom word.
ServiceCall<java.lang.Void>	addWords(AddWordsOptions addWordsOptions) Add custom words.
ServiceCall<VoiceModel>	createVoiceModel(CreateVoiceModelOptions createVoiceModelOptions) Create a custom model.
ServiceCall<java.lang.Void>	deleteUserData(DeleteUserDataOptions deleteUserDataOptions) Delete labeled data.
ServiceCall<java.lang.Void>	deleteVoiceModel(DeleteVoiceModelOptions deleteVoiceModelOptions) Delete a custom model.
ServiceCall<java.lang.Void>	deleteWord(DeleteWordOptions deleteWordOptions) Delete a custom word.
ServiceCall<Pronunciation>	getPronunciation(GetPronunciationOptions getPronunciationOptions) Get pronunciation.
ServiceCall<Voice>	getVoice(GetVoiceOptions getVoiceOptions) Get a voice.
ServiceCall<VoiceModel>	getVoiceModel(GetVoiceModelOptions getVoiceModelOptions) Get a custom model.
ServiceCall<Translation>	getWord(GetWordOptions getWordOptions) Get a custom word.
ServiceCall<VoiceModels>	listVoiceModels() List custom models.
ServiceCall<VoiceModels>	listVoiceModels(ListVoiceModelsOptions listVoiceModelsOptions) List custom models.
ServiceCall<Voices>	listVoices() List voices.
ServiceCall<Voices>	listVoices(ListVoicesOptions listVoicesOptions) List voices.
ServiceCall<Words>	listWords(ListWordsOptions listWordsOptions) List custom words.
ServiceCall<java.io.InputStream>	synthesize(SynthesizeOptions synthesizeOptions) Synthesize audio.
ServiceCall<java.lang.Void>	updateVoiceModel(UpdateVoiceModelOptions updateVoiceModelOptions) Update a custom model.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextToSpeech

public TextToSpeech()

Instantiates a new `TextToSpeech`.

TextToSpeech

public TextToSpeech(java.lang.String username,
            java.lang.String password)

Instantiates a new `TextToSpeech` with username and password.

Parameters:

username - the username

password - the password

TextToSpeech

public TextToSpeech(IamOptions iamOptions)

Instantiates a new `TextToSpeech` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

Parameters:

iamOptions - the options for authenticating through IAM

Method Detail

getVoice

public ServiceCall<Voice> getVoice(GetVoiceOptions getVoiceOptions)

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 that custom voice model of the specified voice. To list information about all available voices, use the **List voices** method. **See also:** [Specifying a voice](https://console.bluemix.net/docs/services/text-to-speech/http.html#voices).

Parameters:

getVoiceOptions - the GetVoiceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Voice

listVoices

public ServiceCall<Voices> listVoices(ListVoicesOptions listVoicesOptions)

List voices. Lists all voices available for use with the service. The information includes the name, language, gender, and other details about the voice. To see information about a specific voice, use the **Get a voice** method. **See also:** [Specifying a voice](https://console.bluemix.net/docs/services/text-to-speech/http.html#voices).

Parameters:

listVoicesOptions - the ListVoicesOptions containing the options for the call

Returns:

a ServiceCall with a response type of Voices

listVoices

public ServiceCall<Voices> listVoices()

List voices. Lists all voices available for use with the service. The information includes the name, language, gender, and other details about the voice. To see information about a specific voice, use the **Get a voice** method. **See also:** [Specifying a voice](https://console.bluemix.net/docs/services/text-to-speech/http.html#voices).

Returns:

a ServiceCall with a response type of Voices

synthesize

public ServiceCall<java.io.InputStream> synthesize(SynthesizeOptions synthesizeOptions)

Synthesize audio. Synthesizes text to spoken audio, returning the synthesized audio stream as an array of bytes. You can pass a maximum of 5 KB of text. Use the `Accept` header or the `accept` query parameter to specify the requested format (MIME type) of the response audio. By default, the service uses `audio/ogg;codecs=opus`. 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. **See also:** [Synthesizing text to audio](https://console.bluemix.net/docs/services/text-to-speech/http.html#synthesize).

Parameters:

synthesizeOptions - the SynthesizeOptions containing the options for the call

Returns:

a ServiceCall with a response type of InputStream

getPronunciation

public ServiceCall<Pronunciation> getPronunciation(GetPronunciationOptions getPronunciationOptions)

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 voice model to see the translation for that voice model. **Note:** This method is currently a beta release. **See also:** [Querying a word from a language](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordsQueryLanguage).

Parameters:

getPronunciationOptions - the GetPronunciationOptions containing the options for the call

Returns:

a ServiceCall with a response type of Pronunciation

createVoiceModel

public ServiceCall<VoiceModel> createVoiceModel(CreateVoiceModelOptions createVoiceModelOptions)

Create a custom model. Creates a new empty custom voice 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. **Note:** This method is currently a beta release. **See also:** [Creating a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsCreate).

Parameters:

createVoiceModelOptions - the CreateVoiceModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of VoiceModel

deleteVoiceModel

public ServiceCall<java.lang.Void> deleteVoiceModel(DeleteVoiceModelOptions deleteVoiceModelOptions)

Delete a custom model. Deletes the specified custom voice model. You must use credentials for the instance of the service that owns a model to delete it. **Note:** This method is currently a beta release. **See also:** [Deleting a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsDelete).

Parameters:

deleteVoiceModelOptions - the DeleteVoiceModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getVoiceModel

public ServiceCall<VoiceModel> getVoiceModel(GetVoiceModelOptions getVoiceModelOptions)

Get a custom model. Gets all information about a specified custom voice model. In addition to metadata such as the name and description of the voice model, the output includes the words and their translations as defined in the model. To see just the metadata for a voice model, use the **List custom models** method. **Note:** This method is currently a beta release. **See also:** [Querying a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsQuery).

Parameters:

getVoiceModelOptions - the GetVoiceModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of VoiceModel

listVoiceModels

public ServiceCall<VoiceModels> listVoiceModels(ListVoiceModelsOptions listVoiceModelsOptions)

List custom models. Lists metadata such as the name and description for all custom voice models that are owned by an instance of the service. Specify a language to list the voice models for that language only. To see the words in addition to the metadata for a specific voice model, use the **List a custom model** method. You must use credentials for the instance of the service that owns a model to list information about it. **Note:** This method is currently a beta release. **See also:** [Querying all custom models](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsQueryAll).

Parameters:

listVoiceModelsOptions - the ListVoiceModelsOptions containing the options for the call

Returns:

a ServiceCall with a response type of VoiceModels

listVoiceModels

public ServiceCall<VoiceModels> listVoiceModels()

List custom models. Lists metadata such as the name and description for all custom voice models that are owned by an instance of the service. Specify a language to list the voice models for that language only. To see the words in addition to the metadata for a specific voice model, use the **List a custom model** method. You must use credentials for the instance of the service that owns a model to list information about it. **Note:** This method is currently a beta release. **See also:** [Querying all custom models](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsQueryAll).

Returns:

a ServiceCall with a response type of VoiceModels

updateVoiceModel

public ServiceCall<java.lang.Void> updateVoiceModel(UpdateVoiceModelOptions updateVoiceModelOptions)

Update a custom model. Updates information for the specified custom voice model. You can update metadata such as the name and description of the voice 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. **Note:** This method is currently a beta release. **See also:** [Updating a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-models.html#cuModelsUpdate).

Parameters:

updateVoiceModelOptions - the UpdateVoiceModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

addWord

public ServiceCall<java.lang.Void> addWord(AddWordOptions addWordOptions)

Add a custom word. Adds a single word and its translation to the specified custom voice 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. **Note:** This method is currently a beta release. **See also:** * [Adding a single word to a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordAdd) * [Adding words to a Japanese custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuJapaneseAdd).

Parameters:

addWordOptions - the AddWordOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

addWords

public ServiceCall<java.lang.Void> addWords(AddWordsOptions addWordsOptions)

Add custom words. Adds one or more words and their translations to the specified custom voice 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. **Note:** This method is currently a beta release. **See also:** * [Adding multiple words to a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordsAdd) * [Adding words to a Japanese custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuJapaneseAdd).

Parameters:

addWordsOptions - the AddWordsOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

deleteWord

public ServiceCall<java.lang.Void> deleteWord(DeleteWordOptions deleteWordOptions)

Delete a custom word. Deletes a single word from the specified custom voice model. You must use credentials for the instance of the service that owns a model to delete its words. **Note:** This method is currently a beta release. **See also:** [Deleting a word from a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordDelete).

Parameters:

deleteWordOptions - the DeleteWordOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getWord

public ServiceCall<Translation> getWord(GetWordOptions getWordOptions)

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. **Note:** This method is currently a beta release. **See also:** [Querying a single word from a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordQueryModel).

Parameters:

getWordOptions - the GetWordOptions containing the options for the call

Returns:

a ServiceCall with a response type of Translation

listWords

public ServiceCall<Words> listWords(ListWordsOptions listWordsOptions)

List custom words. Lists all of the words and their translations for the specified custom voice 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. **Note:** This method is currently a beta release. **See also:** [Querying all words from a custom model](https://console.bluemix.net/docs/services/text-to-speech/custom-entries.html#cuWordsQueryModel).

Parameters:

listWordsOptions - the ListWordsOptions containing the options for the call

Returns:

a ServiceCall with a response type of Words

deleteUserData

public ServiceCall<java.lang.Void> deleteUserData(DeleteUserDataOptions deleteUserDataOptions)

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. **See also:** [Information security](https://console.bluemix.net/docs/services/text-to-speech/information-security.html).

Parameters:

deleteUserDataOptions - the DeleteUserDataOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void