Polly / Client / synthesize_speech

synthesize_speech#

Polly.Client.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'|'long-form'|'generative',
    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'|'en-IE'|'nl-BE'|'fr-BE',
    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'|'Niamh'|'Sofie'|'Lisa'|'Isabelle'|'Zayd'|'Danielle'|'Gregory'|'Burcu'
)
Parameters:

  • Engine (string) –

    Specifies the engine ( standard, neural, long-form, or generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don’t provide an engine, the standard engine is selected by default. If a chosen voice isn’t supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.

    Type: String

    Valid Values: standard | neural | long-form | generative

    Required: Yes

  • LanguageCode (string) –

    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.

  • LexiconNames (list) –

    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.

    • (string) –

  • OutputFormat (string) –

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

  • SampleRate (string) –

    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”. The default value for long-form voices is “24000”. The default value for generative voices is “24000”.

    Valid values for pcm are “8000” and “16000” The default value is “16000”.

  • SpeechMarkTypes (list) –

    The type of speech marks returned for the input text.

    • (string) –

  • Text (string) –

    [REQUIRED]

    Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

  • TextType (string) – Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

  • VoiceId (string) –

    [REQUIRED]

    Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Return type:

dict

Returns:

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.

      • If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg.

      • If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg.

      • If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

      • If you request json as the OutputFormat, the ContentType returned is application/x-json-stream.

    • RequestCharacters (integer) –

      Number of characters synthesized.

Exceptions

  • Polly.Client.exceptions.TextLengthExceededException

  • Polly.Client.exceptions.InvalidSampleRateException

  • Polly.Client.exceptions.InvalidSsmlException

  • Polly.Client.exceptions.LexiconNotFoundException

  • Polly.Client.exceptions.ServiceFailureException

  • Polly.Client.exceptions.MarksNotSupportedForFormatException

  • Polly.Client.exceptions.SsmlMarksNotSupportedForTextTypeException

  • Polly.Client.exceptions.LanguageNotSupportedException

  • Polly.Client.exceptions.EngineNotSupportedException

Examples

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': {
        '...': '...',
    },
}