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

===== '''Общее описание''' =====
Сервис Short phrase recognizer предназначен для преобразования речи в текст. Принимает на вход аудиофайл в формате wav и возвращает структурированные данные в формате JSON.  


===== '''Термины и определения''' =====
Short Phrase Recognizer (SPR) - сервис распознавания речи.

Модель — предварительно обученная специализированная нейронная сеть для распознавания естественной речи в аудиозаписях.

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

 

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

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

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

{| class="wikitable" style="width: 110%"
|+
|-
! style="color:blue;width: 15%"|'''GET:/spr/'''
! colspan="3" |<small>Вывод списка моделей.</small>
|-
| colspan="3" |<small>Без входных параметров</small>
|<small><code>{ models: [model1,...,modelN] }</code></small>
|-
! style="color:blue;width: 15%"|'''GET:/spr/audio/{taskID}'''
! colspan="3" |<small>Получение файла аудиозаписи отложенного задания.</small>
|-
| colspan="3" |<small>'''taskID''' - идентификатор задания</small>
|<small>Файл аудиозаписи или</small> <small><code>{ error: INT , message: DESCRIPTION }</code></small>
|-
! style="color:blue;width: 15%"|'''GET:/spr/data/{id}'''
! colspan="3" |<small>Получение архива модели.</small>
|-
| colspan="3" |<small>'''id''' - идентификатор модели</small>
|<small>ZIP-файл с моделью, либо <code>{ error: INT , message: DESCRIPTION }</code></small>
|-
!style="color:green;width: 15%"|'''POST:/spr/data/{id}'''
! colspan="3" |<small>Добавление модели. Может быть добавлена как из файла архива, так и переименованием существующей модели.</small>
|-
| colspan="3" |'''<small>id</small>''' <small>- идентификатор модели, обязательный параметр.</small>

'''<small>zip-model</small>''' <small>- zip-архив с файлами модели</small>

<small>или</small>

'''<small>from-existing-model</small>''' <small>- название модели, которая должна перемещена на место '''id'''</small>
|<small><code>{ error: INT, message: DESCRIPTION }</code></small>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/data/{id}'''
! colspan="3" |<small>Удаление модели.</small>
|-
| colspan="3" |<small>id - идентификатор модели</small>
|<small><code>{ error: INT, message: DESCRIPTION }</code></small>
|-
! style="color:blue;width: 15%"|'''GET:/spr/queue'''
! colspan="3" |<small>Получение очереди отложенных заданий на распознавание.</small>
|-
| colspan="3" |<small>Без входных параметров</small>
|<small><code>{</code></small>

<small><code>"id задания":</code></small>

<small><code>{</code></small>

<small><code>      "created": "ХХХХ-ХХ-ХХ ХХ:ХХ:ХХ",</code></small>

<small><code>      "status": "waiting", # ready | waiting | failed</code></small>

<small><code>      "filename": "wav"</code></small>

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

<small><code>}</code></small> 
|-
!style="color:red;width: 15%"|'''DELETE:/spr/queue/{taskID}'''
! colspan="3" |<small>Удаление отложенных заданий на распознавание.</small>
|-
| colspan="3" |<small>taskID - идентификатор задания в очереди</small>
|<small><code>{</code></small>

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

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

<small><code>}</code></small>
|-
!style="color:green;width: 15%"|'''POST:/spr/stt/{id}'''
! colspan="3" |<small>Отправка файла на распознавание речи. Моно-файлы до 30 секунд распознаются без разбивки на фрагменты. Многоканальные файлы и файлы длиннее 30 секунд предварительно разбиваются на фрагменты по отсутствию речи. Настройка данных параметров описана в [[SPR. Руководство администратора.|руководстве администратора]].</small>
|-
| colspan="3" style="width: 50%" |
* <small>'''id''' - идентификатор модели</small>

* <small>'''wav''' - файл для распознавания</small>

* <small>'''speakers''' - опция поиска говорящих по базе SBS</small>

* <small>'''punctuation''' - опция для расстановки знаков препинания</small>

* <small>'''normalization''' - опция обратной нормализации текста</small>

* <small>'''vad''' - используемый VAD, по умолчанию webrtc</small>

* <small>'''preset''' - используемая модель для vad = neuro</small>

* <small>'''toxicity''' - анализировать распознанный текст на токсичность</small>

* <small>'''emotion''' - выявить эмоции из распознанного текста</small>

* <small>'''voice_analyzer''' - анализировать аудиофрагменты каждого из говорящих на эмоции, возраст и пол</small>

* <small>'''speaker_counter''' - количество докладчиков, по умолчанию - 0, автоматическое определение количества</small>

* <small>'''async''' - отложенный запуск распознавания</small>



<small>В случае отправки переменной '''speakers=1''', дополнительно производится поиск говорящих и получение метаданных по каждому говорящему. (используется сервис sbs с предварительно обученными слепками метаданных говорящих) В случае отправки переменной '''punctuation'''=1, дополнительно вызывает метод punctuate в SMC, и расставляет знаки препинания в распознанном тексте (значение по умолчанию берётся из файлы конфигурации). '''normalization'''=1 для обратной нормализации текста.</small> <small>В случае использования модели big параметры '''punctuation''' и '''normalization''' игнорируются - модель всегда расставляет знаки препинания и нормализует текст.</small>

<small>При установке параметра '''toxicity''' запрашивается в smc метод GET/smc/toxicity</small>

<small>Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:</small>

<small>"оскорбление": 0.13,</small>

<small>"непристойность": 0,</small>

<small>"угроза": 0,</small>

<small>"вежливость": 0.53</small>

<small>При установке параметра '''emotion''' запрашивается в smc метод GET/smc/emotion</small>

<small>Высказывание анализируется на эмоциональность (negative, neutral, positive)</small>

<small>При установке параметра '''voice_analyzer''' запрашивается в sbs метод POST/sbs/analyze.</small>

<small>Аудио говорящего анализируется на возраст (child adult old)</small> 

<small>эмоции (ANGER BORE DISAPPOINTMENT DISGUST EXCITEMENT FEAR NEUTRAL PAIN PLEASURE SADNESS SUPRISE)</small>

<small>пол (male female)</small>
| style="width: 50%" |<small>В случае '''async=1''' возвращается только '''taskID''', результат по taskID смотреть в методе /spr/result.</small>
<small>'''Для коротких файлов''':</small>

<small><code>{</code></small>

<small><code>  "model": "call",</code></small>

<small><code>  "text": "текст фрагментв",</code></small>

<code><small>  "words": [</small><small> </small></code>

<code><small>{</small><small> "word": "текст",</small></code>

<small><code>      "start": 520,</code></small>

<code><small>      "stop": 1240</small><small> },</small></code>

<code><small>    {</small><small> "word": "фрагмента",</small></code>

<small><code>      "start": 1240,</code></small>

<code><small>      "stop": 1920</small><small>  }</small></code>

<code><small>]</small></code> 

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

<small>'''Для транскрибации больших файлов:'''</small>

<small><code>{</code></small>

<small><code>"speakers": [</code></small>

<small><code>    { </code></small>

<small><code>"id": null,</code></small>

<small><code>      "duration": 18980,</code></small>

<small><code>      "fragments": 3,</code></small>

<small><code>      "age": "old", # только для voice_analyzer=1</code></small>

<small><code>      "gender": "female" # только для voice_analyzer=1</code></small>

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

<small><code>],</code></small>

<small><code>"splitted": [</code></small>

<small><code>    {</code></small>

<small><code>"start": "00:00:01.870",</code></small>

<small><code>      "text": "текст.",</code></small>

<small><code>      "words": [</code></small>

<small><code>        { </code></small>

<small><code>"word": "текст.",</code></small>

<small><code>          "start": 1870,</code></small>

<small><code>          "stop": 2710,</code></small>

<small><code>          "confidence": 0.95263671875</code></small>

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

<small><code>],</code></small>

<small><code>      "stop": "00:00:05.510",</code></small>

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

<small><code>      "duration": "00:00:03.640",</code></small>

<small><code>      "start_ms": 1870,</code></small>

<small><code>      "stop_ms": 5510,</code></small>

<small><code>      "duration_ms": 3640,</code></small>

<small><code>      "speaker": 4,</code></small>

<small><code>      "speakerConfidence": 0.87,</code></small>

<small><code>      "toxicity": { # только для toxicity=1</code></small>

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

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

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

<small><code>        "politeness": 0.99</code></small>

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

<small><code>      "emotion": { "neutral": -0.3315 }, # только для emotion=1</code></small>

<small><code>      "voice_analysis": { # только для voice_analyzer=1</code></small>

<small><code>        "emotion": {</code></small>

<small><code>          "class": "NEUTRAL",</code></small>

<small><code>          "confidence": 0.7554781436920166  } </code></small>

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

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

<small><code>]</code></small>

<small><code>}</code></small> 
|-
! style="color:blue;width: 15%"|'''GET:/spr/result/{taskID}'''
! colspan="3" |<small>Получение результата отложенного распознавания.</small>
|-
| colspan="2" |<small>'''taskID''' - идентификатор задания</small>
| colspan="2" |<small>Вывод по окончанию распознавания аналогичен выводу метода stt + добавлено поле status, которое содержит информацию о статусе отложенной задачи:</small>
<small>'''ready''' - готово</small>

<small>'''waiting''' - ожидание</small>

<small>'''not found''' - не найдена</small>

<small>'''failed''' - сбой</small>
|-
! style="color:blue;width: 15%"|'''GET:/spr/waveform/{taskID}'''
! colspan="3" |<small>Служебный метод для отображения аудио в графическом виде, содержит пики сигнала.</small>
|-
|  style="width: 50%" colspan="2" |<small>'''taskID''' - идентификатор задания</small>
| colspan="2" |<small><code>{</code></small>

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

<small><code>"waveform": [</code></small>

<small><code>0.016,</code></small>

<small><code>    0.015,</code></small>

<small><code>    0.01</code></small>

<small><code>]</code></small>

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