Skip to content

Commit dad6e0e

Browse files
committed
feat(text-to-speech-v1): new voices and languages added
new voices: ZH_CN_LINAVOICE, ZH_CN_WANGWEIVOICE, ZH_CN_ZHANGJINGVOICE, KO_KR_YOUNGMIVOICE, KO_KR_YUNAVOICE, NL_NL_EMMAVOICE, NL_NL_LIAMVOICE, EN_US_OLIVIAV3VOICE, EN_US_EMILYV3VOICE, EN_US_HENRYV3VOICE, EN_US_KEVINV3VOICE, DE_DE_ERIKAV3VOICE, AR_AR_OMARVOICE new languages: ZH_CN, KO_KR, NL_NL, AR_AR
1 parent 7bc2ccd commit dad6e0e

File tree

1 file changed

+75
-28
lines changed

1 file changed

+75
-28
lines changed

text-to-speech/v1-generated.ts

Lines changed: 75 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import { getSdkHeaders } from '../lib/common';
3333
* translations for words. A sounds-like translation consists of one or more words that, when combined, sound like the
3434
* word. A phonetic translation is based on the SSML phoneme format for representing a word. You can specify a phonetic
3535
* translation in standard International Phonetic Alphabet (IPA) representation or in the proprietary IBM Symbolic
36-
* Phonetic Representation (SPR).
36+
* Phonetic Representation (SPR). The Arabic, Chinese, Dutch, and Korean languages support only IPA.
3737
*/
3838

3939
class TextToSpeechV1 extends BaseService {
@@ -265,9 +265,9 @@ class TextToSpeechV1 extends BaseService {
265265
* **Audio formats (accept types)** in the method description.
266266
* @param {string} [params.voice] - The voice to use for synthesis.
267267
* @param {string} [params.customizationId] - The customization ID (GUID) of a custom voice model to use for the
268-
* synthesis. If a custom voice model is specified, it is guaranteed to work only if it matches the language of the
269-
* indicated voice. You must make the request with credentials for the instance of the service that owns the custom
270-
* model. Omit the parameter to use the specified voice with no customization.
268+
* synthesis. If a custom voice model is specified, it works only if it matches the language of the indicated voice.
269+
* You must make the request with credentials for the instance of the service that owns the custom model. Omit the
270+
* parameter to use the specified voice with no customization.
271271
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
272272
* @param {Function} [callback] - The callback that handles the response
273273
* @returns {Promise<TextToSpeechV1.Response<NodeJS.ReadableStream|Buffer>>}
@@ -343,8 +343,7 @@ class TextToSpeechV1 extends BaseService {
343343
* You can also request the pronunciation for a specific voice to see the default translation for the language of that
344344
* voice or for a specific custom voice model to see the translation for that voice model.
345345
*
346-
* **Note:** This method is currently a beta release. The method does not support the Arabic, Chinese, and Dutch
347-
* languages.
346+
* **Note:** This method is currently a beta release.
348347
*
349348
* **See also:** [Querying a word from a
350349
* language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage).
@@ -353,8 +352,8 @@ class TextToSpeechV1 extends BaseService {
353352
* @param {string} params.text - The word for which the pronunciation is requested.
354353
* @param {string} [params.voice] - A voice that specifies the language in which the pronunciation is to be returned.
355354
* All voices for the same language (for example, `en-US`) return the same translation.
356-
* @param {string} [params.format] - The phoneme format in which to return the pronunciation. Omit the parameter to
357-
* obtain the pronunciation in the default format.
355+
* @param {string} [params.format] - The phoneme format in which to return the pronunciation. The Arabic, Chinese,
356+
* Dutch, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in the default format.
358357
* @param {string} [params.customizationId] - The customization ID (GUID) of a custom voice model for which the
359358
* pronunciation is to be returned. The language of a specified custom model must match the language of the specified
360359
* voice. If the word is not defined in the specified custom model, the service returns the default translation for
@@ -430,16 +429,16 @@ class TextToSpeechV1 extends BaseService {
430429
* specify the language and a description for the new model. The model is owned by the instance of the service whose
431430
* credentials are used to create it.
432431
*
433-
* **Note:** This method is currently a beta release. The service does not support voice model customization for the
434-
* Arabic, Chinese, and Dutch languages.
432+
* **Note:** This method is currently a beta release.
435433
*
436434
* **See also:** [Creating a custom
437435
* model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate).
438436
*
439437
* @param {Object} params - The parameters to send to the service.
440438
* @param {string} params.name - The name of the new custom voice model.
441-
* @param {string} [params.language] - The language of the new custom voice model. Omit the parameter to use the the
442-
* default language, `en-US`.
439+
* @param {string} [params.language] - The language of the new custom voice model. You create a custom voice model for
440+
* a specific language, not for a specific voice. A custom model can be used with any voice, standard or neural, for
441+
* its specified language. Omit the parameter to use the the default language, `en-US`.
443442
* @param {string} [params.description] - A description of the new custom voice model. Specifying a description is
444443
* recommended.
445444
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
@@ -1011,7 +1010,8 @@ class TextToSpeechV1 extends BaseService {
10111010
* @param {string} params.word - The word that is to be added or updated for the custom voice model.
10121011
* @param {string} params.translation - The phonetic or sounds-like translation for the word. A phonetic translation
10131012
* is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an
1014-
* IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.
1013+
* IBM SPR translation. The Arabic, Chinese, Dutch, and Korean languages support only IPA. A sounds-like is one or
1014+
* more words that, when combined, sound like the word.
10151015
* @param {string} [params.partOfSpeech] - **Japanese only.** The part of speech for the word. The service uses the
10161016
* value to produce the correct intonation for the word. You can create only a single entry, with or without a single
10171017
* part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word.
@@ -1351,18 +1351,24 @@ namespace TextToSpeechV1 {
13511351
export namespace GetVoiceConstants {
13521352
/** The voice for which information is to be returned. */
13531353
export enum Voice {
1354+
AR_AR_OMARVOICE = 'ar-AR_OmarVoice',
13541355
DE_DE_BIRGITVOICE = 'de-DE_BirgitVoice',
13551356
DE_DE_BIRGITV3VOICE = 'de-DE_BirgitV3Voice',
13561357
DE_DE_DIETERVOICE = 'de-DE_DieterVoice',
13571358
DE_DE_DIETERV3VOICE = 'de-DE_DieterV3Voice',
1359+
DE_DE_ERIKAV3VOICE = 'de-DE_ErikaV3Voice',
13581360
EN_GB_KATEVOICE = 'en-GB_KateVoice',
13591361
EN_GB_KATEV3VOICE = 'en-GB_KateV3Voice',
13601362
EN_US_ALLISONVOICE = 'en-US_AllisonVoice',
13611363
EN_US_ALLISONV3VOICE = 'en-US_AllisonV3Voice',
1364+
EN_US_EMILYV3VOICE = 'en-US_EmilyV3Voice',
1365+
EN_US_HENRYV3VOICE = 'en-US_HenryV3Voice',
1366+
EN_US_KEVINV3VOICE = 'en-US_KevinV3Voice',
13621367
EN_US_LISAVOICE = 'en-US_LisaVoice',
13631368
EN_US_LISAV3VOICE = 'en-US_LisaV3Voice',
13641369
EN_US_MICHAELVOICE = 'en-US_MichaelVoice',
13651370
EN_US_MICHAELV3VOICE = 'en-US_MichaelV3Voice',
1371+
EN_US_OLIVIAV3VOICE = 'en-US_OliviaV3Voice',
13661372
ES_ES_ENRIQUEVOICE = 'es-ES_EnriqueVoice',
13671373
ES_ES_ENRIQUEV3VOICE = 'es-ES_EnriqueV3Voice',
13681374
ES_ES_LAURAVOICE = 'es-ES_LauraVoice',
@@ -1377,8 +1383,15 @@ namespace TextToSpeechV1 {
13771383
IT_IT_FRANCESCAV3VOICE = 'it-IT_FrancescaV3Voice',
13781384
JA_JP_EMIVOICE = 'ja-JP_EmiVoice',
13791385
JA_JP_EMIV3VOICE = 'ja-JP_EmiV3Voice',
1386+
KO_KR_YOUNGMIVOICE = 'ko-KR_YoungmiVoice',
1387+
KO_KR_YUNAVOICE = 'ko-KR_YunaVoice',
1388+
NL_NL_EMMAVOICE = 'nl-NL_EmmaVoice',
1389+
NL_NL_LIAMVOICE = 'nl-NL_LiamVoice',
13801390
PT_BR_ISABELAVOICE = 'pt-BR_IsabelaVoice',
13811391
PT_BR_ISABELAV3VOICE = 'pt-BR_IsabelaV3Voice',
1392+
ZH_CN_LINAVOICE = 'zh-CN_LiNaVoice',
1393+
ZH_CN_WANGWEIVOICE = 'zh-CN_WangWeiVoice',
1394+
ZH_CN_ZHANGJINGVOICE = 'zh-CN_ZhangJingVoice',
13821395
}
13831396
}
13841397

@@ -1394,9 +1407,9 @@ namespace TextToSpeechV1 {
13941407
/** The voice to use for synthesis. */
13951408
voice?: SynthesizeConstants.Voice | string;
13961409
/** The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is
1397-
* specified, it is guaranteed to work only if it matches the language of the indicated voice. You must make the
1398-
* request with credentials for the instance of the service that owns the custom model. Omit the parameter to use
1399-
* the specified voice with no customization.
1410+
* specified, it works only if it matches the language of the indicated voice. You must make the request with
1411+
* credentials for the instance of the service that owns the custom model. Omit the parameter to use the specified
1412+
* voice with no customization.
14001413
*/
14011414
customizationId?: string;
14021415
headers?: OutgoingHttpHeaders;
@@ -1427,14 +1440,19 @@ namespace TextToSpeechV1 {
14271440
DE_DE_BIRGITV3VOICE = 'de-DE_BirgitV3Voice',
14281441
DE_DE_DIETERVOICE = 'de-DE_DieterVoice',
14291442
DE_DE_DIETERV3VOICE = 'de-DE_DieterV3Voice',
1443+
DE_DE_ERIKAV3VOICE = 'de-DE_ErikaV3Voice',
14301444
EN_GB_KATEVOICE = 'en-GB_KateVoice',
14311445
EN_GB_KATEV3VOICE = 'en-GB_KateV3Voice',
14321446
EN_US_ALLISONVOICE = 'en-US_AllisonVoice',
14331447
EN_US_ALLISONV3VOICE = 'en-US_AllisonV3Voice',
1448+
EN_US_EMILYV3VOICE = 'en-US_EmilyV3Voice',
1449+
EN_US_HENRYV3VOICE = 'en-US_HenryV3Voice',
1450+
EN_US_KEVINV3VOICE = 'en-US_KevinV3Voice',
14341451
EN_US_LISAVOICE = 'en-US_LisaVoice',
14351452
EN_US_LISAV3VOICE = 'en-US_LisaV3Voice',
14361453
EN_US_MICHAELVOICE = 'en-US_MichaelVoice',
14371454
EN_US_MICHAELV3VOICE = 'en-US_MichaelV3Voice',
1455+
EN_US_OLIVIAV3VOICE = 'en-US_OliviaV3Voice',
14381456
ES_ES_ENRIQUEVOICE = 'es-ES_EnriqueVoice',
14391457
ES_ES_ENRIQUEV3VOICE = 'es-ES_EnriqueV3Voice',
14401458
ES_ES_LAURAVOICE = 'es-ES_LauraVoice',
@@ -1449,6 +1467,8 @@ namespace TextToSpeechV1 {
14491467
IT_IT_FRANCESCAV3VOICE = 'it-IT_FrancescaV3Voice',
14501468
JA_JP_EMIVOICE = 'ja-JP_EmiVoice',
14511469
JA_JP_EMIV3VOICE = 'ja-JP_EmiV3Voice',
1470+
KO_KR_YOUNGMIVOICE = 'ko-KR_YoungmiVoice',
1471+
KO_KR_YUNAVOICE = 'ko-KR_YunaVoice',
14521472
NL_NL_EMMAVOICE = 'nl-NL_EmmaVoice',
14531473
NL_NL_LIAMVOICE = 'nl-NL_LiamVoice',
14541474
PT_BR_ISABELAVOICE = 'pt-BR_IsabelaVoice',
@@ -1467,8 +1487,8 @@ namespace TextToSpeechV1 {
14671487
* language (for example, `en-US`) return the same translation.
14681488
*/
14691489
voice?: GetPronunciationConstants.Voice | string;
1470-
/** The phoneme format in which to return the pronunciation. Omit the parameter to obtain the pronunciation in
1471-
* the default format.
1490+
/** The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, and Korean languages
1491+
* support only IPA. Omit the parameter to obtain the pronunciation in the default format.
14721492
*/
14731493
format?: GetPronunciationConstants.Format | string;
14741494
/** The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The
@@ -1485,18 +1505,24 @@ namespace TextToSpeechV1 {
14851505
export namespace GetPronunciationConstants {
14861506
/** A voice that specifies the language in which the pronunciation is to be returned. All voices for the same language (for example, `en-US`) return the same translation. */
14871507
export enum Voice {
1508+
AR_AR_OMARVOICE = 'ar-AR_OmarVoice',
14881509
DE_DE_BIRGITVOICE = 'de-DE_BirgitVoice',
14891510
DE_DE_BIRGITV3VOICE = 'de-DE_BirgitV3Voice',
14901511
DE_DE_DIETERVOICE = 'de-DE_DieterVoice',
14911512
DE_DE_DIETERV3VOICE = 'de-DE_DieterV3Voice',
1513+
DE_DE_ERIKAV3VOICE = 'de-DE_ErikaV3Voice',
14921514
EN_GB_KATEVOICE = 'en-GB_KateVoice',
14931515
EN_GB_KATEV3VOICE = 'en-GB_KateV3Voice',
14941516
EN_US_ALLISONVOICE = 'en-US_AllisonVoice',
14951517
EN_US_ALLISONV3VOICE = 'en-US_AllisonV3Voice',
1518+
EN_US_EMILYV3VOICE = 'en-US_EmilyV3Voice',
1519+
EN_US_HENRYV3VOICE = 'en-US_HenryV3Voice',
1520+
EN_US_KEVINV3VOICE = 'en-US_KevinV3Voice',
14961521
EN_US_LISAVOICE = 'en-US_LisaVoice',
14971522
EN_US_LISAV3VOICE = 'en-US_LisaV3Voice',
14981523
EN_US_MICHAELVOICE = 'en-US_MichaelVoice',
14991524
EN_US_MICHAELV3VOICE = 'en-US_MichaelV3Voice',
1525+
EN_US_OLIVIAV3VOICE = 'en-US_OliviaV3Voice',
15001526
ES_ES_ENRIQUEVOICE = 'es-ES_EnriqueVoice',
15011527
ES_ES_ENRIQUEV3VOICE = 'es-ES_EnriqueV3Voice',
15021528
ES_ES_LAURAVOICE = 'es-ES_LauraVoice',
@@ -1511,10 +1537,17 @@ namespace TextToSpeechV1 {
15111537
IT_IT_FRANCESCAV3VOICE = 'it-IT_FrancescaV3Voice',
15121538
JA_JP_EMIVOICE = 'ja-JP_EmiVoice',
15131539
JA_JP_EMIV3VOICE = 'ja-JP_EmiV3Voice',
1540+
KO_KR_YOUNGMIVOICE = 'ko-KR_YoungmiVoice',
1541+
KO_KR_YUNAVOICE = 'ko-KR_YunaVoice',
1542+
NL_NL_EMMAVOICE = 'nl-NL_EmmaVoice',
1543+
NL_NL_LIAMVOICE = 'nl-NL_LiamVoice',
15141544
PT_BR_ISABELAVOICE = 'pt-BR_IsabelaVoice',
15151545
PT_BR_ISABELAV3VOICE = 'pt-BR_IsabelaV3Voice',
1546+
ZH_CN_LINAVOICE = 'zh-CN_LiNaVoice',
1547+
ZH_CN_WANGWEIVOICE = 'zh-CN_WangWeiVoice',
1548+
ZH_CN_ZHANGJINGVOICE = 'zh-CN_ZhangJingVoice',
15161549
}
1517-
/** The phoneme format in which to return the pronunciation. Omit the parameter to obtain the pronunciation in the default format. */
1550+
/** The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in the default format. */
15181551
export enum Format {
15191552
IBM = 'ibm',
15201553
IPA = 'ipa',
@@ -1525,7 +1558,10 @@ namespace TextToSpeechV1 {
15251558
export interface CreateVoiceModelParams {
15261559
/** The name of the new custom voice model. */
15271560
name: string;
1528-
/** The language of the new custom voice model. Omit the parameter to use the the default language, `en-US`. */
1561+
/** The language of the new custom voice model. You create a custom voice model for a specific language, not for
1562+
* a specific voice. A custom model can be used with any voice, standard or neural, for its specified language.
1563+
* Omit the parameter to use the the default language, `en-US`.
1564+
*/
15291565
language?: CreateVoiceModelConstants.Language | string;
15301566
/** A description of the new custom voice model. Specifying a description is recommended. */
15311567
description?: string;
@@ -1534,8 +1570,9 @@ namespace TextToSpeechV1 {
15341570

15351571
/** Constants for the `createVoiceModel` operation. */
15361572
export namespace CreateVoiceModelConstants {
1537-
/** The language of the new custom voice model. Omit the parameter to use the the default language, `en-US`. */
1573+
/** The language of the new custom voice model. You create a custom voice model for a specific language, not for a specific voice. A custom model can be used with any voice, standard or neural, for its specified language. Omit the parameter to use the the default language, `en-US`. */
15381574
export enum Language {
1575+
AR_AR = 'ar-AR',
15391576
DE_DE = 'de-DE',
15401577
EN_GB = 'en-GB',
15411578
EN_US = 'en-US',
@@ -1545,7 +1582,10 @@ namespace TextToSpeechV1 {
15451582
FR_FR = 'fr-FR',
15461583
IT_IT = 'it-IT',
15471584
JA_JP = 'ja-JP',
1585+
KO_KR = 'ko-KR',
1586+
NL_NL = 'nl-NL',
15481587
PT_BR = 'pt-BR',
1588+
ZH_CN = 'zh-CN',
15491589
}
15501590
}
15511591

@@ -1562,6 +1602,7 @@ namespace TextToSpeechV1 {
15621602
export namespace ListVoiceModelsConstants {
15631603
/** The language for which custom voice models that are owned by the requesting credentials are to be returned. Omit the parameter to see all custom voice models that are owned by the requester. */
15641604
export enum Language {
1605+
AR_AR = 'ar-AR',
15651606
DE_DE = 'de-DE',
15661607
EN_GB = 'en-GB',
15671608
EN_US = 'en-US',
@@ -1571,7 +1612,10 @@ namespace TextToSpeechV1 {
15711612
FR_FR = 'fr-FR',
15721613
IT_IT = 'it-IT',
15731614
JA_JP = 'ja-JP',
1615+
KO_KR = 'ko-KR',
1616+
NL_NL = 'nl-NL',
15741617
PT_BR = 'pt-BR',
1618+
ZH_CN = 'zh-CN',
15751619
}
15761620
}
15771621

@@ -1645,8 +1689,9 @@ namespace TextToSpeechV1 {
16451689
/** The word that is to be added or updated for the custom voice model. */
16461690
word: string;
16471691
/** The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for
1648-
* representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A
1649-
* sounds-like is one or more words that, when combined, sound like the word.
1692+
* representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. The
1693+
* Arabic, Chinese, Dutch, and Korean languages support only IPA. A sounds-like is one or more words that, when
1694+
* combined, sound like the word.
16501695
*/
16511696
translation: string;
16521697
/** **Japanese only.** The part of speech for the word. The service uses the value to produce the correct
@@ -1739,8 +1784,9 @@ namespace TextToSpeechV1 {
17391784
/** Information about the translation for the specified text. */
17401785
export interface Translation {
17411786
/** The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for
1742-
* representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A
1743-
* sounds-like is one or more words that, when combined, sound like the word.
1787+
* representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. The
1788+
* Arabic, Chinese, Dutch, and Korean languages support only IPA. A sounds-like is one or more words that, when
1789+
* combined, sound like the word.
17441790
*/
17451791
translation: string;
17461792
/** **Japanese only.** The part of speech for the word. The service uses the value to produce the correct
@@ -1824,11 +1870,12 @@ namespace TextToSpeechV1 {
18241870

18251871
/** Information about a word for the custom voice model. */
18261872
export interface Word {
1827-
/** The word for the custom voice model. */
1873+
/** The word for the custom voice model. The maximum length of a word is 49 characters. */
18281874
word: string;
18291875
/** The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for
1830-
* representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation
1831-
* consists of one or more words that, when combined, sound like the word.
1876+
* representing the phonetic string of a word either as an IPA or IBM SPR translation. The Arabic, Chinese, Dutch,
1877+
* and Korean languages support only IPA. A sounds-like translation consists of one or more words that, when
1878+
* combined, sound like the word. The maximum length of a translation is 499 characters.
18321879
*/
18331880
translation: string;
18341881
/** **Japanese only.** The part of speech for the word. The service uses the value to produce the correct

0 commit comments

Comments
 (0)