synthesize_speech(**kwargs)¶Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.
See also: AWS API Documentation
Request Syntax
response = client.synthesize_speech(
Engine='standard'|'neural',
LanguageCode='arb'|'cmn-CN'|'cy-GB'|'da-DK'|'de-DE'|'en-AU'|'en-GB'|'en-GB-WLS'|'en-IN'|'en-US'|'es-ES'|'es-MX'|'es-US'|'fr-CA'|'fr-FR'|'is-IS'|'it-IT'|'ja-JP'|'hi-IN'|'ko-KR'|'nb-NO'|'nl-NL'|'pl-PL'|'pt-BR'|'pt-PT'|'ro-RO'|'ru-RU'|'sv-SE'|'tr-TR'|'en-NZ'|'en-ZA'|'ca-ES'|'de-AT'|'yue-CN'|'ar-AE'|'fi-FI',
LexiconNames=[
'string',
],
OutputFormat='json'|'mp3'|'ogg_vorbis'|'pcm',
SampleRate='string',
SpeechMarkTypes=[
'sentence'|'ssml'|'viseme'|'word',
],
Text='string',
TextType='ssml'|'text',
VoiceId='Aditi'|'Amy'|'Astrid'|'Bianca'|'Brian'|'Camila'|'Carla'|'Carmen'|'Celine'|'Chantal'|'Conchita'|'Cristiano'|'Dora'|'Emma'|'Enrique'|'Ewa'|'Filiz'|'Gabrielle'|'Geraint'|'Giorgio'|'Gwyneth'|'Hans'|'Ines'|'Ivy'|'Jacek'|'Jan'|'Joanna'|'Joey'|'Justin'|'Karl'|'Kendra'|'Kevin'|'Kimberly'|'Lea'|'Liv'|'Lotte'|'Lucia'|'Lupe'|'Mads'|'Maja'|'Marlene'|'Mathieu'|'Matthew'|'Maxim'|'Mia'|'Miguel'|'Mizuki'|'Naja'|'Nicole'|'Olivia'|'Penelope'|'Raveena'|'Ricardo'|'Ruben'|'Russell'|'Salli'|'Seoyeon'|'Takumi'|'Tatyana'|'Vicki'|'Vitoria'|'Zeina'|'Zhiyu'|'Aria'|'Ayanda'|'Arlet'|'Hannah'|'Arthur'|'Daniel'|'Liam'|'Pedro'|'Kajal'|'Hiujin'|'Laura'|'Elin'|'Ida'|'Suvi'|'Ola'|'Hala'|'Andres'|'Sergio'|'Remi'|'Adriano'|'Thiago'|'Ruth'|'Stephen'|'Kazuha'|'Tomoko'
)
Specifies the engine ( standard or neural ) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural . If the engine is not specified, or is set to standard , this will result in an error.
Type: String
Valid Values: standard | neural
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard . If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.
Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.
[REQUIRED]
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
The type of speech marks returned for the input text.
[REQUIRED]
Input text to synthesize. If you specify ssml as the TextType , follow the SSML format for the input text.
[REQUIRED]
Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
dict
Response Syntax
{
'AudioStream': StreamingBody(),
'ContentType': 'string',
'RequestCharacters': 123
}
Response Structure
(dict) --
AudioStream (StreamingBody) --
Stream containing the synthesized speech.
ContentType (string) --
Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.
mp3 as the OutputFormat , the ContentType returned is audio/mpeg.ogg_vorbis as the OutputFormat , the ContentType returned is audio/ogg.pcm as the OutputFormat , the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.json as the OutputFormat , the ContentType returned is application/x-json-stream.RequestCharacters (integer) --
Number of characters synthesized.
Exceptions
Polly.Client.exceptions.TextLengthExceededExceptionPolly.Client.exceptions.InvalidSampleRateExceptionPolly.Client.exceptions.InvalidSsmlExceptionPolly.Client.exceptions.LexiconNotFoundExceptionPolly.Client.exceptions.ServiceFailureExceptionPolly.Client.exceptions.MarksNotSupportedForFormatExceptionPolly.Client.exceptions.SsmlMarksNotSupportedForTextTypeExceptionPolly.Client.exceptions.LanguageNotSupportedExceptionPolly.Client.exceptions.EngineNotSupportedExceptionExamples
Synthesizes plain text or SSML into a file of human-like speech.
response = client.synthesize_speech(
LexiconNames=[
'example',
],
OutputFormat='mp3',
SampleRate='8000',
Text='All Gaul is divided into three parts',
TextType='text',
VoiceId='Joanna',
)
print(response)
Expected Output:
{
'AudioStream': 'TEXT',
'ContentType': 'audio/mpeg',
'RequestCharacters': 37,
'ResponseMetadata': {
'...': '...',
},
}