Speech Synthesis component (Yandex Cloud SpeechKit)

Table of Contents

Description
Properties
See also

Description

Performs text-to-speech synthesis and playback to the current caller.
The service is provided by Yandex Cloud SpeechKit over the protocol HTTP (APIv1 REST). It has no technical limitations in terms of performance.

For the procedure of registering a Yandex-cloud account and the cost of the service, see Yandex.

The tokens are configured in domain settings, field 'yandex_cloud'.

Allows you to play back the result, as well as simply record it to an audio file.

In playback mode, the file is first synthesized and pumped out completely, then playback begins.
Speech synthesis speed is approximately 10 times faster than the real time of its reproduction.

Table 1. System Characteristics

Index	`222`
Short title	`tts_yandex`
Types of scenarios	`IVR`
Starter module	`r_sip_ivr_script_component_tts_yandex`
Mode	Asynchronous
Icon
Branching pattern	Branching, interrupting

Properties

Table 2. Properties
Specification	Description
Title: `Yandex Account` Code: `accountKey` Visibility: `no` Default: `default`	Specifies the Yandex account whose options are taken to connect to yandex. The list includes the value 'default', which sets the root fields 'speech' and 'storage' in the object to be used 'settings.yandex_cloud'. Additionally, the list includes the keys of the 'settings.yandex_cloud.accounts' object, each of which is also followed by an object with separately configured access parameters.
Title: `Mode` Code: `mode` Visibility: `no` Default: `Play'	Component operation mode after receiving a response from the service TTS Yandex Cloud SpeechKit. Possible options: `Play` (`play`, `0`) - Play the synthesized speech to the subscriber and then delete the file. `Generate File` (`file`, `1`) - Saves the audio file to a local temporary directory and returns the file path to a variable.
Title: `Text` Code: `text` Visibility: `no` Default: —	Text to be synthesized and subsequently reproduced. Line length limit: 5000 characters.
Title: `Language` Code: `lang` Visibility: `no` Default: `Russian`	TTS Yandex Cloud SpeechKit service parameter: synthesis language. Possible options: `ru-RU` (`0`) – Russian `en-US` (`1`) – English `de-DE` (`2`) – German `he-IL` (`6`) – Hebrew `kk-KZ` (`8`) – Kazakh `uz-UZ` (`15`) – Uzbek
Title: `Voice` Code: `voice` Visibility: `no` Default: `Alyss (f)`	TTS Yandex Cloud SpeechKit service parameter: synthesized speech voice. Possible options: `Alyss (f)` (`0`) `Jane (f)` (`1`) `Oksana (f)` (`2`) `Omazh (f)` (`3`) `Zahar (m)` (`4`) `Ermil (m)` (`5`) `Alena (f)` (`6`) `Filipp (m)` (`7`) `Other` (`other`, `100`) - Specifies an arbitrary voice via argument.
Title: `Another Voice` Code: `voiceOther` Visibility: `no` Default: —	Argument containing the name of the voice for the TTS Yandex Cloud SpeechKit service. Supported voices
Title: `Emotion` Code: `emotion` Visibility: `no` Default: `Good`	TTS Yandex Cloud SpeechKit service parameter: emotional effect of synthesized speech, amp. Possible options: `Good` (`0`) `Evil` (`1`) `Neutral` (`2`)
Title: `Tempo of Speech (0.1 – 3.0)` Code: `speed` Visibility: `no` Default: `1.0`	TTS Yandex Cloud SpeechKit service parameter: rate of synthesized speech. Fractional value from `0.1` to `3.0` with dimensionality `0.1`
Title: `Break by DTMF` Code: `checkDTMF` Visibility: `no` Default: `None'	DTMF detector switch. Opens the settings for the character save and operation interrupt modes.
Title: `Buffer for DTMF` Code: `dtmfBuffer` Visibility: `yes` Default: —	Variable to store received DTMF characters.
Title: `Clear buffer DTMF` Code: `clearDtmfBuffer` Visibility: `yes` Default: `Yes'	Buffer pre-clearance switch DTMF.
Title: `Number of characters` Code: `maxSymbolCount` Visibility: `yes` Default: —	An argument containing a limit on the number of characters that can be entered. When the specified number of DTMF characters is received during component execution, playback operation is completed.
Title: `Interrupt Symbols` Code: `interruptSymbols` Visibility: `yes` Default: —	A string containing sequences of interrupt characters separated by commas. When a character sequence matching one of the specified interrupt sequences is detected at the end of the DTMF buffer, the playback operation is completed. For example, `*, 7, 123, 9395`.
Title: `Response timeout, s` Code: `responseTimeoutSec` Visibility: `no` Default: —	Timeout for waiting for a response from the TTS Yandex Cloud SpeechKit service after sending a request to it. When the timeout expires, control is passed to the next component on the `Time branch`.
Title: `Response code to variable` Code: `varHttpCode` Visibility: `no` Default: —	Variable to store the HTTP response code of the recognition service.
Title: `File path to a variable` Code: `varFile` Visibility: `yes` Default: —	Variable to save the path to the synthesized speech audio file in the local temporary directory. Long-term file retention requires the script to further move the file to a stationary storage location.
Title: `Transition` Code: `transfer` Visibility: `no` Default: —	The component to which control is passed if the operation is successfully completed.
Title: `Transition, Time` Code: `transferTimeout` Visibility: `no` Default: —	The component to which control is passed when the time to wait for an HTTP response from the service has expired.
Title: `Transition, Error` Code: `transferError` Visibility: `no` Default: —	The component to which control is passed if an error occurs.

Speech Synthesis component (Yandex Cloud SpeechKit)

Description

Properties

See also