SPR. Руководство пользователя
Материал из Флора AI
Общее описание
Сервис Short phrase recognizer предназначен для преобразования речи в текст. Принимает на вход аудиофайл в формате wav и возвращает структурированные данные в формате JSON.
Термины и определения
Short Phrase Recognizer (SPR) - сервис распознавания речи.
Модель — предварительно обученная специализированная нейронная сеть для распознавания естественной речи в аудиозаписях.
Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SPR в реальном времени
Описание методов API SPR
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SPR. По умолчанию используется порт 6183/tcp.
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"
Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6183 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.
| GET:/spr/ | Вывод списка моделей | |||
|---|---|---|---|---|
| нет входных параметров | { models: [model1,...,modelN] } | |||
| GET:/spr/audio/{taskID} | Получение файла аудиозаписи отложенного задания | |||
| taskID - идентификатор задания | Файл аудиозаписи или { error: INT , message: DESCRIPTION } | |||
| GET:/spr/data/{id} | Получение архива модели | |||
| id - идентификатор модели | ZIP-файл с моделью, либо { error: INT , message: DESCRIPTION } | |||
| POST:/spr/data/{id} | Добавление модели. Может быть добавлена как из файла архива, так и переименованием существующей модели. | |||
| id - идентификатор модели, обязательный параметр.
zip-model - zip-архив с файлами модели или from-existing-model - название модели, которая должна перемещена на место id |
{ error: INT, message: DESCRIPTION } | |||
| DELETE:/spr/data/{id} | Удаление модели | |||
| id - идентификатор модели | { error: INT, message: DESCRIPTION } | |||
| GET:/spr/queue | Получение очереди отложенных заданий на распознавание | |||
| Без входных параметров | {
"id задания": { "created": "ХХХХ-ХХ-ХХ ХХ:ХХ:ХХ", "status": "waiting", "filename": "wav" } } Статусы ready - готово waiting - ожидание failed - сбой | |||
| DELETE:/spr/queue/{taskID} | Удаление отложенных заданий на распознавание | |||
| taskID - идентификатор задания в очереди | {
"error": 0, "message": "success" } | |||
| POST:/spr/stt/{id} | Отправка файла на распознавание речи. Моно-файлы до 30 секунд распознаются без разбивки на фрагменты. Многоканальные файлы и файлы длиннее 30 секунд предварительно разбиваются на фрагменты по отсутствию речи. Настройка данных параметров описана в руководстве администратора. | |||
В случае отправки переменной speakers=1, дополнительно производится поиск говорящих и получение метаданных по каждому говорящему. (используется сервис sbs с предварительно обученными слепками метаданных говорящих) В случае отправки переменной punctuation=1, дополнительно вызывает метод punctuate в SMC, и расставляет знаки препинания в распознанном тексте (значение по умолчанию берётся из файлы конфигурации). normalization=1 для обратной нормализации текста. В случае использования модели big параметры punctuation и normalization игнорируются - модель всегда расставляет знаки препинания и нормализует текст.
При установке параметра toxicity запрашивается в smc метод GET/smc/toxicity Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1: "оскорбление": 0.13, "непристойность": 0, "угроза": 0, "вежливость": 0.53
Высказывание анализируется на эмоциональность (negative, neutral, positive)
Аудио говорящего анализируется на возраст (child adult old) эмоции (ANGER BORE DISAPPOINTMENT DISGUST EXCITEMENT FEAR NEUTRAL PAIN PLEASURE SADNESS SUPRISE) пол (male female) |
в случае async=1 возвращается только taskID, результат по taskID смотреть в методе /spr/result.для коротких файлов:{
"model": "call", "text": "текст фрагментв", "words": [ { "word": "текст", "start": 520, "stop": 1240 }, { "word": "фрагмента", "start": 1240, "stop": 1920 } ] } для транскрибации больших файлов ответ состоит из нескольких списков 1) "speakers": [ { "id": null, "duration": 18980, "fragments": 3, "age": "old", "gender": "female" }] - параметры каждого говорящего, если voice_analyzer = 1, то будут отображены предположительные возраст и пол говорящего 2) "splitted": [ { "start": "00:00:01.870", "text": "текст фрагмента", "words": [ { "word": "текст.", "start": 1870, "stop": 2710, "confidence": 0.95263671875 }, { "word": "фрагмента,", "start": 2730, "stop": 3330, "confidence": 0.9986572265625 } ], "stop": "00:00:05.510", "channel": 0, "duration": "00:00:03.640", "start_ms": 1870, "stop_ms": 5510, "duration_ms": 3640, "speaker": 4, "speakerConfidence": 0.8699063646965216, "toxicity": { "insult": 0, "obscenity": 0, "threat": 0, "politeness": 0.99 }, "emotion": { "neutral": -0.3315 }, "voice_analysis": { "emotion": { "class": "NEUTRAL", "confidence": 0.7554781436920166 } } } ] - для каждой фразы отдельно целиком фраза, затем по словам, для каждого слова временные параметры и вероятность. Также при установке соответствующих параметров в 1 будут для каждой фразы выведены toxicity emotion voice_analysis. | |||
| /spr/result/{taskID} | GET | Получение результата отложенного распознавания | taskID - идентификатор задания | Вывод по окончанию распознавания аналогичен выводу метода stt + добавлено поле status, которое содержит информацию о статусе отложенной задачи:
ready - готово waiting - ожидание not found - не найдена failed - сбой |
| /spr/waveform/{taskID} | GET | Служебный метод для отображения аудио в графическом виде, содержит пики сигнала | taskID - идентификатор задания | {
<"error": 0, "waveform": [ 0.016, .......... .......... 0.015, 0.01 ] } |