Компонент Синтез речи (Yandex Cloud SpeechKit)

Описание

Осуществляет синтез речи по тексту и воспроизведение текущему абоненту.
Сервис предоставляется облаком Yandex Cloud SpeechKit по протоколу gRPC (API v3). Не имеет технических ограничений по производительности.

Порядок регистрации учетной записи Yandex-облака и стоимость сервиса см. на Яндексе.

Настройка токенов производится в разделе настройки домена, поле 'yandex_cloud'.

Позволяет воспроизводить результат, а также просто записывать его в аудио-файл.

В режиме воспроизведения речь начинает воспроизводиться при появлении в буфере данных длительностью 1.5 секунды, не дожидаясь окончания синтеза.
Текст длиннее 250 символов синтезируется по частям (режим unsafe_mode сервиса).

Настройки сценариев, созданных для API v1, применяются без изменений. Голос `Alyss`, отсутствующий в API v3, заменяется голосом `Dasha`. Эмоция, не поддерживаемая выбранным голосом, не передается сервису.

Table 1. Системные характеристики

Индекс

222

Краткое название

tts_yandex

Типы сценариев

IVR

Стартовый модуль

r_sip_ivr_script_component_tts_yandex_v3

Режим

Асинхронный

Иконка

222

Характер разветвления

Разветвляющий, прерывающий

Свойства

Table 2. Свойства
Спецификация Описание

Название: Аккаунт Яндекс
Код: accountKey
Усл. видимости: нет
По умолчанию: default

Указание на аккаунт Яндекса, опции которого берутся для подключения к яндексу.
В список попадает значение 'default', устанавливающее к использованию корневые поля 'speech' и 'storage' в объекте 'settings.yandex_cloud'.
Дополнительно в список попадают ключи объекта 'settings.yandex_cloud.accounts', за каждым из которых также находится объект с отдельно настроенными параметрами доступа.

Название: Режим
Код: mode
Усл. видимости: нет
По умолчанию: Воспроизведение

Режим работы компонента после получения ответа от сервиса TTS Yandex Cloud SpeechKit.
Возможные варианты:

  • Воспроизведение (play, 0) – Воспроизведение синтезированной речи абоненту с последующим удалением файла.

  • Генерация файла (file, 1) – Сохранение аудио-файла в локальный временный каталог и возврат пути к файлу в переменную.

Название: Текст
Код: text
Усл. видимости: нет
По умолчанию: — 

Текст, подлежащий синтезу и последующему воспроизведению. Текст длиннее 250 символов синтезируется по частям.
Поддерживается разметка TTS.

Название: Голос
Код: voice
Усл. видимости: нет
По умолчанию: Dasha (ж)

Параметр сервиса TTS Yandex Cloud SpeechKit: голос синтезируемой речи. Язык речи определяется голосом.
Возможные варианты:

  • Dasha (ж) (0) – в сценариях API v1 значение 0 означало голос Alyss, недоступный в API v3

  • Jane (ж) (1)

  • Oksana (ж) (2)

  • Omazh (ж) (3)

  • Zahar (м) (4)

  • Ermil (м) (5)

  • Alena (ж) (6)

  • Filipp (м) (7)

  • Alexander (м) (10), Anton (м) (11), Julia (ж) (13), Kirill (м) (14), Lera (ж) (15), Marina (ж) (16), Masha (ж) (17)

  • русская речь: Madi (м) (18), Saule (ж) (19), Zamira (ж) (20), Zhanar (ж) (21), Yulduz (ж) (22)

  • английский: John (м) (30); немецкий: Lea (ж) (31); иврит: Naomi (ж) (32)

  • казахский: Amira (ж) (33), Madi (м) (34), Saule (ж) (35), Zhanar (ж) (36)

  • узбекский: Nigora (ж) (37), Zamira (ж) (38), Yulduz (ж) (39)

  • Другой (other, 100) – Указание произвольного голоса через аргумент.

Название: Другой голос
Код: voiceOther
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий название голоса для сервиса TTS Yandex Cloud SpeechKit. Поддерживаемые голоса

Название: Эмоция
Код: emotion
Усл. видимости: нет
По умолчанию: Good

Параметр сервиса TTS Yandex Cloud SpeechKit: эмоциональная окраска (амплуа) синтезируемой речи.
Набор доступных амплуа зависит от голоса. Амплуа, не поддерживаемое выбранным голосом, не передается сервису: применяется манера голоса по умолчанию.
Возможные варианты:

  • Good (0)

  • Evil (1)

  • Neutral (2)

  • Friendly (3)

  • Strict (4)

  • Whisper (5)

  • По умолчанию (default, 6) – амплуа не передается сервису

  • Другая (other, 100) – Указание произвольного амплуа через аргумент.

Название: Другая эмоция
Код: emotionOther
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий название амплуа для сервиса TTS Yandex Cloud SpeechKit.

Название: Темп речи (0.1 – 3.0)
Код: speed
Усл. видимости: нет
По умолчанию: 1.0

Параметр сервиса TTS Yandex Cloud SpeechKit: темп синтезируемой речи.
Дробное значение от 0.1 до 3.0 с размерностью 0.1

Название: Громкость (LUFS: -145..0)
Код: volume
Усл. видимости: нет
По умолчанию: — 

Параметр сервиса TTS Yandex Cloud SpeechKit: уровень нормализации громкости в LUFS, от -145 до 0. По умолчанию сервис применяет -19.

Название: Сдвиг высоты голоса, Гц (-1000..1000)
Код: pitchShift
Усл. видимости: нет
По умолчанию: — 

Параметр сервиса TTS Yandex Cloud SpeechKit: сдвиг высоты голоса в герцах, от -1000 до 1000.

Название: Модель
Код: model
Усл. видимости: нет
По умолчанию: — 

Параметр сервиса TTS Yandex Cloud SpeechKit: модель синтеза. По умолчанию применяется модель сервиса.

Название: Кэширование
Код: useCache
Усл. видимости: нет
По умолчанию: Выключено

Режим кэширования результатов синтеза речи.

Кэширование призвано при частом обращении с одними и теми же заданиями к сервису синтеза ускорить выдачу результата, а также сократить нагрузку на сервис синтеза.
Если данные синтеза регулярно изменяются, такие операции вредно кэшировать, поскольку придется определять и настраивать процедуру их периодической очистки.

Первый раз при отсутствии значения файл генерируется с помощью сервиса и сохраняется в папку ':GlobalShare/domains/DOMAIN/cache/yandex_v3_tts/…​'.
В дальнейшем при обнаружении в кэше файла обращений к сервису TTS Yandex Cloud SpeechKit не происходит, файл копируется из кэша.

В уникальном имени файла скрывается отображение параметров синтеза: текст, голос, амплуа, темп, громкость, сдвиг высоты, модель.
Файлы из кэша автоматически не удаляются. Необходимо отдельно настраивать процедуру удаления устаревающих данных. Критерием может являться, например, время последнего обращения к файлу.

Название: Прерывать по DTMF
Код: checkDTMF
Усл. видимости: нет
По умолчанию: Нет

Выключатель детектора DTMF. Открывает настройки режимов сохранения символов и прерывания операции.

Название: Буфер для DTMF
Код: dtmfBuffer
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения получаемых DTMF-символов.

Название: Очистить буфер DTMF
Код: clearDtmfBuffer
Усл. видимости: да
По умолчанию: Да

Выключатель предварительной очистки буфера DTMF.

Название: Количество символов
Код: maxSymbolCount
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий ограничение на количество вводимых символов.
После получения во время исполнения компонента указанного количества символов DTMF завершается операции воспроизведения.

Название: Символы прерывания
Код: interruptSymbols
Усл. видимости: да
По умолчанию: — 

Строка, содержащая последовательности символов прерывания через запятую.
После обнаружения на конце буфера DTMF последовательности символов, совпадающей с одной из указанных последовательностей прерывания, завершается операция воспроизведения.
Например, *, 7, 123, 9395.

Название: Таймаут ожидания ответа, с
Код: responseTimeoutSec
Усл. видимости: нет
По умолчанию: 10

Таймаут ожидания ответа от сервиса TTS Yandex Cloud SpeechKit после отправки ему запроса.
По истечении таймаута управление передается следующему компоненту по ветке Время.

Название: Код ответа в переменную
Код: varHttpCode
Усл. видимости: нет
По умолчанию: — 

Переменная для сохранения кода ответа сервиса синтеза в виде кода HTTP: 200 – успех, 408 – истек таймаут ожидания ответа.
Ошибки сервиса приводятся к кодам HTTP: 400 – некорректный запрос (например, неизвестный голос), 401 – ошибка авторизации, 403 – нет доступа, 429 – превышена квота, 503 – сервис недоступен, 500 – прочие ошибки.

Название: Путь к файлу в переменную
Код: varFile
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения пути к аудио-файлу с синтезированной речью в локальном временном каталоге.
Для длительного сохранения файла требуется дальнейшее перемещение файла сценарием в место стационарного хранения.

Название: Переход
Код: transfer
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае успешного завершения операции.

Название: Переход, время
Код: transferTimeout
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае истечения времени ожидания ответа от сервиса.

Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае возникновения ошибки.

См. также

  • Роль ivr

  • Роль mg