Skip to content

Commit 40cd035

Browse files
committed
feat(text-to-speech-v1): add voices and update comments
1 parent 4211f51 commit 40cd035

File tree

6 files changed

+101
-143
lines changed

6 files changed

+101
-143
lines changed

text-to-speech/src/main/java/com/ibm/watson/text_to_speech/v1/TextToSpeech.java

+21-84
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2019, 2021.
2+
* (C) Copyright IBM Corp. 2022.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -12,7 +12,7 @@
1212
*/
1313

1414
/*
15-
* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
15+
* IBM OpenAPI SDK Code Generator Version: 3.46.0-a4e29da0-20220224-210428
1616
*/
1717

1818
package com.ibm.watson.text_to_speech.v1;
@@ -91,16 +91,13 @@
9191
* when combined, sound like the word. A phonetic translation is based on the SSML phoneme format
9292
* for representing a word. You can specify a phonetic translation in standard International
9393
* Phonetic Alphabet (IPA) representation or in the proprietary IBM Symbolic Phonetic Representation
94-
* (SPR).
94+
* (SPR). For phonetic translation, the Arabic, Chinese, Dutch, Australian English, Korean, and
95+
* Swedish voices support only IPA, not SPR.
9596
*
9697
* <p>The service also offers a Tune by Example feature that lets you define custom prompts. You can
9798
* also define speaker models to improve the quality of your custom prompts. The service support
9899
* custom prompts only for US English custom models and voices.
99100
*
100-
* <p>**IBM Cloud&amp;reg;.** The Arabic, Chinese, Dutch, Australian English, and Korean languages
101-
* and voices are supported only for IBM Cloud. For phonetic translation, they support only IPA, not
102-
* SPR.
103-
*
104101
* <p>API Version: 1.0.0 See: https://cloud.ibm.com/docs/text-to-speech
105102
*/
106103
public class TextToSpeech extends BaseService {
@@ -209,25 +206,10 @@ public ServiceCall<Voices> listVoices() {
209206
* <p>**See also:** [Listing a specific
210207
* voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#listVoice).
211208
*
212-
* <p>### Important voice updates for IBM Cloud
213-
*
214-
* <p>The service's voices underwent significant change on 2 December 2020. * The Arabic, Chinese,
215-
* Dutch, Australian English, and Korean voices are now neural instead of concatenative. * The
216-
* `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead. * The `ar-AR`
217-
* language identifier cannot be used to create a custom model. Use the `ar-MS` identifier
218-
* instead. * The standard concatenative voices for the following languages are now deprecated:
219-
* Brazilian Portuguese, United Kingdom and United States English, French, German, Italian,
220-
* Japanese, and Spanish (all dialects). * The features expressive SSML, voice transformation
221-
* SSML, and use of the `volume` attribute of the `&lt;prosody&gt;` element are deprecated and are
222-
* not supported with any of the service's neural voices. * All of the service's voices are now
223-
* customizable and generally available (GA) for production use.
224-
*
225-
* <p>The deprecated voices and features will continue to function for at least one year but might
226-
* be removed at a future date. You are encouraged to migrate to the equivalent neural voices at
227-
* your earliest convenience. For more information about all voice updates, see the [2 December
228-
* 2020 service
229-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
230-
* in the release notes for IBM Cloud.
209+
* <p>**Note:** The Arabic, Chinese, Czech, Dutch (Belgian and Netherlands), Australian English,
210+
* Korean, and Swedish languages and voices are supported only for IBM Cloud; they are deprecated
211+
* for IBM Cloud Pak for Data. Also, the `ar-AR_OmarVoice` voice is deprecated; use the
212+
* `ar-MS_OmarVoice` voice instead.
231213
*
232214
* @param getVoiceOptions the {@link GetVoiceOptions} containing the options for the call
233215
* @return a {@link ServiceCall} with a result of type {@link Voice}
@@ -268,6 +250,11 @@ public ServiceCall<Voice> getVoice(GetVoiceOptions getVoiceOptions) {
268250
* <p>**See also:** [The HTTP
269251
* interface](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-usingHTTP#usingHTTP).
270252
*
253+
* <p>**Note:** The Arabic, Chinese, Czech, Dutch (Belgian and Netherlands), Australian English,
254+
* Korean, and Swedish languages and voices are supported only for IBM Cloud; they are deprecated
255+
* for IBM Cloud Pak for Data. Also, the `ar-AR_OmarVoice` voice is deprecated; use the
256+
* `ar-MS_OmarVoice` voice instead.
257+
*
271258
* <p>### Audio formats (accept types)
272259
*
273260
* <p>The service can return audio in the following formats (MIME types). * Where indicated, you
@@ -303,26 +290,6 @@ public ServiceCall<Voice> getVoice(GetVoiceOptions getVoiceOptions) {
303290
* some of the formats, see [Using audio
304291
* formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audio-formats).
305292
*
306-
* <p>### Important voice updates for IBM Cloud
307-
*
308-
* <p>The service's voices underwent significant change on 2 December 2020. * The Arabic, Chinese,
309-
* Dutch, Australian English, and Korean voices are now neural instead of concatenative. * The
310-
* `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead. * The `ar-AR`
311-
* language identifier cannot be used to create a custom model. Use the `ar-MS` identifier
312-
* instead. * The standard concatenative voices for the following languages are now deprecated:
313-
* Brazilian Portuguese, United Kingdom and United States English, French, German, Italian,
314-
* Japanese, and Spanish (all dialects). * The features expressive SSML, voice transformation
315-
* SSML, and use of the `volume` attribute of the `&lt;prosody&gt;` element are deprecated and are
316-
* not supported with any of the service's neural voices. * All of the service's voices are now
317-
* customizable and generally available (GA) for production use.
318-
*
319-
* <p>The deprecated voices and features will continue to function for at least one year but might
320-
* be removed at a future date. You are encouraged to migrate to the equivalent neural voices at
321-
* your earliest convenience. For more information about all voice updates, see the [2 December
322-
* 2020 service
323-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
324-
* in the release notes for IBM Cloud.
325-
*
326293
* <p>### Warning messages
327294
*
328295
* <p>If a request includes invalid query parameters, the service returns a `Warnings` response
@@ -417,25 +384,10 @@ public WebSocket synthesizeUsingWebSocket(
417384
* <p>**See also:** [Querying a word from a
418385
* language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage).
419386
*
420-
* <p>### Important voice updates for IBM Cloud
421-
*
422-
* <p>The service's voices underwent significant change on 2 December 2020. * The Arabic, Chinese,
423-
* Dutch, Australian English, and Korean voices are now neural instead of concatenative. * The
424-
* `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead. * The `ar-AR`
425-
* language identifier cannot be used to create a custom model. Use the `ar-MS` identifier
426-
* instead. * The standard concatenative voices for the following languages are now deprecated:
427-
* Brazilian Portuguese, United Kingdom and United States English, French, German, Italian,
428-
* Japanese, and Spanish (all dialects). * The features expressive SSML, voice transformation
429-
* SSML, and use of the `volume` attribute of the `&lt;prosody&gt;` element are deprecated and are
430-
* not supported with any of the service's neural voices. * All of the service's voices are now
431-
* customizable and generally available (GA) for production use.
432-
*
433-
* <p>The deprecated voices and features will continue to function for at least one year but might
434-
* be removed at a future date. You are encouraged to migrate to the equivalent neural voices at
435-
* your earliest convenience. For more information about all voice updates, see the [2 December
436-
* 2020 service
437-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
438-
* in the release notes for IBM Cloud.
387+
* <p>**Note:** The Arabic, Chinese, Czech, Dutch (Belgian and Netherlands), Australian English,
388+
* Korean, and Swedish languages and voices are supported only for IBM Cloud; they are deprecated
389+
* for IBM Cloud Pak for Data. Also, the `ar-AR_OmarVoice` voice is deprecated; use the
390+
* `ar-MS_OmarVoice` voice instead.
439391
*
440392
* @param getPronunciationOptions the {@link GetPronunciationOptions} containing the options for
441393
* the call
@@ -479,25 +431,10 @@ public ServiceCall<Pronunciation> getPronunciation(
479431
* <p>**See also:** [Creating a custom
480432
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate).
481433
*
482-
* <p>### Important voice updates for IBM Cloud
483-
*
484-
* <p>The service's voices underwent significant change on 2 December 2020. * The Arabic, Chinese,
485-
* Dutch, Australian English, and Korean voices are now neural instead of concatenative. * The
486-
* `ar-AR_OmarVoice` voice is deprecated. Use `ar-MS_OmarVoice` voice instead. * The `ar-AR`
487-
* language identifier cannot be used to create a custom model. Use the `ar-MS` identifier
488-
* instead. * The standard concatenative voices for the following languages are now deprecated:
489-
* Brazilian Portuguese, United Kingdom and United States English, French, German, Italian,
490-
* Japanese, and Spanish (all dialects). * The features expressive SSML, voice transformation
491-
* SSML, and use of the `volume` attribute of the `&lt;prosody&gt;` element are deprecated and are
492-
* not supported with any of the service's neural voices. * All of the service's voices are now
493-
* customizable and generally available (GA) for production use.
494-
*
495-
* <p>The deprecated voices and features will continue to function for at least one year but might
496-
* be removed at a future date. You are encouraged to migrate to the equivalent neural voices at
497-
* your earliest convenience. For more information about all voice updates, see the [2 December
498-
* 2020 service
499-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020)
500-
* in the release notes for IBM Cloud.
434+
* <p>**Note:** The Arabic, Chinese, Czech, Dutch (Belgian and Netherlands), Australian English,
435+
* Korean, and Swedish languages and voices are supported only for IBM Cloud; they are deprecated
436+
* for IBM Cloud Pak for Data. Also, the `ar-AR` language identifier cannot be used to create a
437+
* custom model; use the `ar-MS` identifier instead.
501438
*
502439
* @param createCustomModelOptions the {@link CreateCustomModelOptions} containing the options for
503440
* the call

text-to-speech/src/main/java/com/ibm/watson/text_to_speech/v1/model/CreateCustomModelOptions.java

+17-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2020, 2021.
2+
* (C) Copyright IBM Corp. 2022.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -20,17 +20,22 @@ public class CreateCustomModelOptions extends GenericModel {
2020
/**
2121
* The language of the new custom model. You create a custom model for a specific language, not
2222
* for a specific voice. A custom model can be used with any voice for its specified language.
23-
* Omit the parameter to use the the default language, `en-US`. **Note:** The `ar-AR` language
24-
* identifier cannot be used to create a custom model. Use the `ar-MS` identifier instead.
23+
* Omit the parameter to use the the default language, `en-US`.
2524
*
26-
* <p>**IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and
27-
* voices are supported only for IBM Cloud.
25+
* <p>**Important:** If you are using the service on IBM Cloud Pak for Data _and_ you install the
26+
* neural voices, the `language`parameter is required. You must specify the language for the
27+
* custom model in the indicated format (for example, `en-AU` for Australian English). The request
28+
* fails if you do not specify a language.
2829
*/
2930
public interface Language {
3031
/** ar-MS. */
3132
String AR_MS = "ar-MS";
33+
/** cs-CZ. */
34+
String CS_CZ = "cs-CZ";
3235
/** de-DE. */
3336
String DE_DE = "de-DE";
37+
/** en-AU. */
38+
String EN_AU = "en-AU";
3439
/** en-GB. */
3540
String EN_GB = "en-GB";
3641
/** en-US. */
@@ -57,6 +62,8 @@ public interface Language {
5762
String NL_NL = "nl-NL";
5863
/** pt-BR. */
5964
String PT_BR = "pt-BR";
65+
/** sv-SE. */
66+
String SV_SE = "sv-SE";
6067
/** zh-CN. */
6168
String ZH_CN = "zh-CN";
6269
}
@@ -164,11 +171,12 @@ public String name() {
164171
*
165172
* <p>The language of the new custom model. You create a custom model for a specific language, not
166173
* for a specific voice. A custom model can be used with any voice for its specified language.
167-
* Omit the parameter to use the the default language, `en-US`. **Note:** The `ar-AR` language
168-
* identifier cannot be used to create a custom model. Use the `ar-MS` identifier instead.
174+
* Omit the parameter to use the the default language, `en-US`.
169175
*
170-
* <p>**IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and
171-
* voices are supported only for IBM Cloud.
176+
* <p>**Important:** If you are using the service on IBM Cloud Pak for Data _and_ you install the
177+
* neural voices, the `language`parameter is required. You must specify the language for the
178+
* custom model in the indicated format (for example, `en-AU` for Australian English). The request
179+
* fails if you do not specify a language.
172180
*
173181
* @return the language
174182
*/

text-to-speech/src/main/java/com/ibm/watson/text_to_speech/v1/model/GetPronunciationOptions.java

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2018, 2021.
2+
* (C) Copyright IBM Corp. 2022.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -19,18 +19,15 @@ public class GetPronunciationOptions extends GenericModel {
1919

2020
/**
2121
* A voice that specifies the language in which the pronunciation is to be returned. All voices
22-
* for the same language (for example, `en-US`) return the same translation. For more information
23-
* about specifying a voice, see **Important voice updates for IBM Cloud** in the method
24-
* description.
25-
*
26-
* <p>**IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and
27-
* voices are supported only for IBM Cloud.
22+
* for the same language (for example, `en-US`) return the same translation.
2823
*/
2924
public interface Voice {
3025
/** ar-AR_OmarVoice. */
3126
String AR_AR_OMARVOICE = "ar-AR_OmarVoice";
3227
/** ar-MS_OmarVoice. */
3328
String AR_MS_OMARVOICE = "ar-MS_OmarVoice";
29+
/** cs-CZ_AlenaVoice. */
30+
String CS_CZ_ALENAVOICE = "cs-CZ_AlenaVoice";
3431
/** de-DE_BirgitVoice. */
3532
String DE_DE_BIRGITVOICE = "de-DE_BirgitVoice";
3633
/** de-DE_BirgitV3Voice. */
@@ -41,10 +38,12 @@ public interface Voice {
4138
String DE_DE_DIETERV3VOICE = "de-DE_DieterV3Voice";
4239
/** de-DE_ErikaV3Voice. */
4340
String DE_DE_ERIKAV3VOICE = "de-DE_ErikaV3Voice";
44-
/** en-AU-CraigVoice. */
45-
String EN_AU_CRAIGVOICE = "en-AU-CraigVoice";
46-
/** en-AU-MadisonVoice. */
47-
String EN_AU_MADISONVOICE = "en-AU-MadisonVoice";
41+
/** en-AU_CraigVoice. */
42+
String EN_AU_CRAIGVOICE = "en-AU_CraigVoice";
43+
/** en-AU_MadisonVoice. */
44+
String EN_AU_MADISONVOICE = "en-AU_MadisonVoice";
45+
/** en-AU_SteveVoice. */
46+
String EN_AU_STEVEVOICE = "en-AU_SteveVoice";
4847
/** en-GB_CharlotteV3Voice. */
4948
String EN_GB_CHARLOTTEV3VOICE = "en-GB_CharlotteV3Voice";
5049
/** en-GB_JamesV3Voice. */
@@ -115,6 +114,8 @@ public interface Voice {
115114
String KO_KR_YUNAVOICE = "ko-KR_YunaVoice";
116115
/** nl-BE_AdeleVoice. */
117116
String NL_BE_ADELEVOICE = "nl-BE_AdeleVoice";
117+
/** nl-BE_BramVoice. */
118+
String NL_BE_BRAMVOICE = "nl-BE_BramVoice";
118119
/** nl-NL_EmmaVoice. */
119120
String NL_NL_EMMAVOICE = "nl-NL_EmmaVoice";
120121
/** nl-NL_LiamVoice. */
@@ -123,6 +124,8 @@ public interface Voice {
123124
String PT_BR_ISABELAVOICE = "pt-BR_IsabelaVoice";
124125
/** pt-BR_IsabelaV3Voice. */
125126
String PT_BR_ISABELAV3VOICE = "pt-BR_IsabelaV3Voice";
127+
/** sv-SE_IngridVoice. */
128+
String SV_SE_INGRIDVOICE = "sv-SE_IngridVoice";
126129
/** zh-CN_LiNaVoice. */
127130
String ZH_CN_LINAVOICE = "zh-CN_LiNaVoice";
128131
/** zh-CN_WangWeiVoice. */
@@ -260,12 +263,7 @@ public String text() {
260263
* Gets the voice.
261264
*
262265
* <p>A voice that specifies the language in which the pronunciation is to be returned. All voices
263-
* for the same language (for example, `en-US`) return the same translation. For more information
264-
* about specifying a voice, see **Important voice updates for IBM Cloud** in the method
265-
* description.
266-
*
267-
* <p>**IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and
268-
* voices are supported only for IBM Cloud.
266+
* for the same language (for example, `en-US`) return the same translation.
269267
*
270268
* @return the voice
271269
*/

text-to-speech/src/main/java/com/ibm/watson/text_to_speech/v1/model/GetVoiceOptions.java

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2018, 2021.
2+
* (C) Copyright IBM Corp. 2022.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -17,18 +17,14 @@
1717
/** The getVoice options. */
1818
public class GetVoiceOptions extends GenericModel {
1919

20-
/**
21-
* The voice for which information is to be returned. For more information about specifying a
22-
* voice, see **Important voice updates for IBM Cloud** in the method description.
23-
*
24-
* <p>**IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and
25-
* voices are supported only for IBM Cloud.
26-
*/
20+
/** The voice for which information is to be returned. */
2721
public interface Voice {
2822
/** ar-AR_OmarVoice. */
2923
String AR_AR_OMARVOICE = "ar-AR_OmarVoice";
3024
/** ar-MS_OmarVoice. */
3125
String AR_MS_OMARVOICE = "ar-MS_OmarVoice";
26+
/** cs-CZ_AlenaVoice. */
27+
String CS_CZ_ALENAVOICE = "cs-CZ_AlenaVoice";
3228
/** de-DE_BirgitVoice. */
3329
String DE_DE_BIRGITVOICE = "de-DE_BirgitVoice";
3430
/** de-DE_BirgitV3Voice. */
@@ -39,10 +35,12 @@ public interface Voice {
3935
String DE_DE_DIETERV3VOICE = "de-DE_DieterV3Voice";
4036
/** de-DE_ErikaV3Voice. */
4137
String DE_DE_ERIKAV3VOICE = "de-DE_ErikaV3Voice";
42-
/** en-AU-CraigVoice. */
43-
String EN_AU_CRAIGVOICE = "en-AU-CraigVoice";
44-
/** en-AU-MadisonVoice. */
45-
String EN_AU_MADISONVOICE = "en-AU-MadisonVoice";
38+
/** en-AU_CraigVoice. */
39+
String EN_AU_CRAIGVOICE = "en-AU_CraigVoice";
40+
/** en-AU_MadisonVoice. */
41+
String EN_AU_MADISONVOICE = "en-AU_MadisonVoice";
42+
/** en-AU_SteveVoice. */
43+
String EN_AU_STEVEVOICE = "en-AU_SteveVoice";
4644
/** en-GB_CharlotteV3Voice. */
4745
String EN_GB_CHARLOTTEV3VOICE = "en-GB_CharlotteV3Voice";
4846
/** en-GB_JamesV3Voice. */
@@ -113,6 +111,8 @@ public interface Voice {
113111
String KO_KR_YUNAVOICE = "ko-KR_YunaVoice";
114112
/** nl-BE_AdeleVoice. */
115113
String NL_BE_ADELEVOICE = "nl-BE_AdeleVoice";
114+
/** nl-BE_BramVoice. */
115+
String NL_BE_BRAMVOICE = "nl-BE_BramVoice";
116116
/** nl-NL_EmmaVoice. */
117117
String NL_NL_EMMAVOICE = "nl-NL_EmmaVoice";
118118
/** nl-NL_LiamVoice. */
@@ -121,6 +121,8 @@ public interface Voice {
121121
String PT_BR_ISABELAVOICE = "pt-BR_IsabelaVoice";
122122
/** pt-BR_IsabelaV3Voice. */
123123
String PT_BR_ISABELAV3VOICE = "pt-BR_IsabelaV3Voice";
124+
/** sv-SE_IngridVoice. */
125+
String SV_SE_INGRIDVOICE = "sv-SE_IngridVoice";
124126
/** zh-CN_LiNaVoice. */
125127
String ZH_CN_LINAVOICE = "zh-CN_LiNaVoice";
126128
/** zh-CN_WangWeiVoice. */
@@ -204,11 +206,7 @@ public Builder newBuilder() {
204206
/**
205207
* Gets the voice.
206208
*
207-
* <p>The voice for which information is to be returned. For more information about specifying a
208-
* voice, see **Important voice updates for IBM Cloud** in the method description.
209-
*
210-
* <p>**IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and
211-
* voices are supported only for IBM Cloud.
209+
* <p>The voice for which information is to be returned.
212210
*
213211
* @return the voice
214212
*/

0 commit comments

Comments
 (0)