Supported fields and defaults
Neural TTSaaS supports a subset of the messages and fields in the Synthesizer API file. Some fields are ignored and others are not allowed, meaning they trigger an error if included.
Supported in GetVoicesRequest
These fields are supported in GetVoicesRequest.
| Field in GetVoicesRequest | Supported and default |
|---|---|
| voice (Voice) | Default: all voices |
| name | Default: all names |
| language | Default: all languages |
| gender (EnumGender) | Default: all genders |
| sample_rate_hz | Default: all sample rates |
| foreign_languages | Default: all foreign languages |
| styles | Default: all styles |
Supported in SynthesisRequest
These fields are supported in SynthesisRequest.
| Field in SynthesisRequest | Supported and default |
|---|---|
| voice (voice) | |
| name | Mandatory for plain text, optional for SSML input. |
| audio_params (AudioParameters) | |
| audio_format (AudioFormat) | Default: PCM 22050 Hz |
| pcm | Signed 16-bit little endian PCM |
| alaw | G.711 A-law, 8 kHz |
| ulaw | G.711 Mu-law, 8 kHz |
| ogg_opus | Ogg Opus, 16 kHz or 24 kHz |
| ogg | Opus, 16 kHz or 24 kHz |
| input (Input) | |
| text (Text) | Either text or SSML is mandatory |
| ssml (SSML) | Either text or SSML is mandatory |
| event_params (EventParameters) | |
| send_bookmark_marker_events | Default is false: Do not send |
| send_visemes | Default is false: Do not send |
| suppress_input | Default is false: Include input |
| client_data | Default is blank |
| user_id | Default is blank |
Not allowed
These fields are not supported in SynthesisRequest and return an error when included.
| Message in SynthesisRequest | Fields not allowed |
|---|---|
| input (Input) | text.uri ssml.uri tokenized_sequence |
Ignored
These fields are ignored. They may be included without error but have no effect.
| Item | Ignored |
|---|---|
| UnarySynthesize | UnarySynthesisResponse |
| voice (Voice) | model age_group language_tls restricted versions |
| enum_gender (EnumGender) | NEUTRAL |
| audio_params (AudioParameters) | volume_percentage (set to 80) speaking_rate_factor (set to 1.0) audio_chunk_duration_ms target_audio_length_ms disable_early_emisssion |
| ogg_opus (OggOpus) | bit_rate_bps max_frame_duration_ms complexity vbr |
| opus (Opus) | max_frame_duration_ms complexity vbr |
| input (Input) | resources lid_params download_parameters |
| ssml (SSML) | ssml_validation_mode |
| event_params (EventParameters) | send_sentence_marker_events send_word_marker_events send_phoneme_marker_events send_paragraph_marker_events send_log_events |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.