Просмотр кода страницы TTS. Руководство пользователя

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.


====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени




===== '''Описание методов API''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом TTS. По умолчанию используется порт 6186/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл. 

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6186 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/'''
! colspan="2" style="width: 85%" |<small>Вывод списка моделей (голосов синтеза).</small>
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
| style="width: 50%" |<small><code>{ models: [model1,...,modelN] }</code></small>
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="2" style="width: 85%" |<small>Выгрузка пользовательского словаря ударений.</small>
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
| style="width: 50%" |<small>простой текст - строки с словом и его интерперетацией с ударением</small>
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="2" style="width: 85%" |<small>Выгрузка пользовательского словаря ударений в виде json.</small>
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
| style="width: 50%" |<small><code>[</code></small>  <small><code>[   "слово",   "замена слова с удар+ением"],</code></small>

<small><code>[   "слово2",   "замена слова2 с удар+ением"],</code></small>

<small><code>...</code></small>

<small><code>]</code></small>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="2" style="width: 85%" |<small>Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.</small>
|-
| colspan="2" style="width: 50%" |
* <small>'''csv''' — файл строк со словом и его интерпретацией с ударением.</small>
| style="width: 50%" |<small><code>{</code></small>

<small><code>  "error": 0,</code></small>

<small><code>  "message": "сообщение о статусе результата"</code></small>

<small><code>}</code></small>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="2" style="width: 85%" |<small>Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.</small>
|-
| colspan="2" style="width: 50%" |
* <small>'''json''' — строка следующего вида:</small>

<small><code>[</code></small>

<small><code>[   "слово",   "замена слова с удар+ением" ],</code></small>

<small><code>[ "слово2",   "замена слова2 с удар+ением" ],</code></small>

<small><code>...</code></small>

<small><code>]</code></small>
| style="width: 50%" |<small><code>{</code></small>

<small><code>  "error": 0,</code></small>

<small><code>  "message": "сообщение о статусе результата"</code></small>

<small><code>}</code></small>
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="2" style="width: 85%" |<small>Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».</small>
|-
| colspan="2" style="width: 50%" |
* <small>'''text''' — фраза для нормализации.</small>
| style="width: 50%" |<small><code>{</code></small>

<small><code>  "error": 0,</code></small>

<small><code>  "message": "success",</code></small>

<small><code>  "text": "нормализованный текст"</code></small>

<small><code>}</code></small>
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="2" style="width: 85%" |<small>Модификация или искажение голоса</small>
|-
| colspan="2" style="width: 50%" |
* <small>'''wav''' — аудиофайл для обработки.</small>
* <small>'''revoicer''' — модель модификации голоса.</small>
| style="width: 50%" |<small>wav файл с модифицированным (искаженным) голосом.</small>
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="2" style="width: 85%" |<small>Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.</small>
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
| style="width: 50%" |<small>[  "distortion" ]</small>
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! colspan="2" style="width: 85%" |<small>Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.</small>
|-
| colspan="2" style="width: 50%" |
* <small>'''text''' - текст для обработки</small>
| style="width: 50%" |<small>{  "error": 0,</small>

<small>  "message": "success",</small>

<small>  "phrases": [ "фраза 1", "фраза 2", ....  "фраза N"  ] }</small>
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="2" style="width: 85%" |<small>Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.</small><small><small>'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.</small>
|-
| colspan="2" style="width: 50%" |
* <small>'''ID''' — имя модели</small>
* <small>'''text''' — текст синтезируемой фразы</small>
* <small>'''rate''' — скорость речи</small>
* <small>'''pitch''' — высота (тон)</small>
* <small>'''volume''' — громкость</small>
* <small>'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)</small>
* <small>'''format''' - формат файла результата (wav, opus, ogg, mp3)</small>
* <small>'''link''' - если 1, то вернуть только ссылку на файл</small>
| style="width: 50%" |<small>файл с синтезированой фразой</small>
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="2" |<small>Проверка лицензии</small>
|-
| colspan="2" |<small>Входные параметры отсутствуют</small>
|<small>Пример '''неограниченной''' лицензии:
</small><code><small>{</small></code>

    <code><small>"error": 0,</small></code>

    <code><small>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</small></code>    

    <code><small>"remaining_licenses": "infinity",</small></code>

    <code><small>"threshold": 0</small></code>

<code><small>}</small></code>

<small>Пример '''ограниченной''' лицензии:
<code><small>{</small></code>    

    <code><small>"error": 0,</small></code>

    <code><small>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</small></code>    

    <code><small>"remaining_licenses": 100,</small></code>

    <code><small>"threshold": 100</small></code>

<code><small>}</small></code>
|}