Создать транскрибацию
POST https://api.shopot.ai/v1/transcribe
Транскрибирует аудиофайл и обрабатывает транскрипт через LLM. Возвращает уникальный id запроса и status.
Тело запроса
url или file
string
Обязательно
В зависимости от выбранного источника файла, вы будете использовать параметры URL или File. URL должен ссылаться на публично доступный файл на вашем/удаленном сервере. Размер файла ограничен 200 Мб. Свяжитесь с поддержкой здесь, если вам нужны большие загрузки.
В зависимости от выбранного источника файла, вы будете использовать параметры URL или File. URL должен ссылаться на публично доступный файл на вашем/удаленном сервере. Размер файла ограничен 200 Мб. Свяжитесь с поддержкой здесь, если вам нужны большие загрузки.
language
string
Необязательно
По умолчанию автоопределение
Язык аудио. Укажите входной язык в формате ISO-639-1. Если ничего не указано, произойдет автоопределение по первым секундам аудио. Поддерживаемые коды языков: af, ar, az, be, bg, bs, ca, cs, cy, da, de, el, en, es, et, fa, fi, fr, gl, he, hi, hr, hu, hy, id, is, it, ja, kk, ko, lt, lv, mi, mk, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, sw, th, tr, uk, vi, zh
Язык аудио. Укажите входной язык в формате ISO-639-1. Если ничего не указано, произойдет автоопределение по первым секундам аудио. Поддерживаемые коды языков: af, ar, az, be, bg, bs, ca, cs, cy, da, de, el, en, es, et, fa, fi, fr, gl, he, hi, hr, hu, hy, id, is, it, ja, kk, ko, lt, lv, mi, mk, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, sw, th, tr, uk, vi, zh
initial_prompt
string
Необязательно
Необязательная подсказка для определения специальной лексики или направления модели для правильной транскрибации имен и терминологии. Должна соответствовать входному языку.
Необязательная подсказка для определения специальной лексики или направления модели для правильной транскрибации имен и терминологии. Должна соответствовать входному языку.
vad_filter
boolean или null
Необязательно
По умолчанию True
Фильтр обнаружения голосовой активности, используемый для вырезания тишины и ускорения процесса транскрибации. Для файлов низкого уровня громкости или низкого качества рекомендуется выполнять запрос с опцией false.
Варианты: true или false.
Фильтр обнаружения голосовой активности, используемый для вырезания тишины и ускорения процесса транскрибации. Для файлов низкого уровня громкости или низкого качества рекомендуется выполнять запрос с опцией false.
Варианты: true или false.
disable_diarization
boolean
Необязательно
По умолчанию False
По умолчанию модель будет диаризировать файл и возвращать транскрипт с текстом, распределенным по обнаруженным говорящим.
Варианты: true или false.
По умолчанию модель будет диаризировать файл и возвращать транскрипт с текстом, распределенным по обнаруженным говорящим.
Варианты: true или false.
callback_url
string
Необязательно
URL Webhook, который будет вызван методом POST для возврата результатов после завершения обработки или в случае ошибки. Сервис осуществляет 3 попытки доставки сообщения с задержкой в 60 секунд между попытками. При доставке результатов обработки status задачи изменяется на WEBHOOK_DELIVERED или WEBHOOK_FAILED, при доставке ошибок обработки статус не меняется.
URL Webhook, который будет вызван методом POST для возврата результатов после завершения обработки или в случае ошибки. Сервис осуществляет 3 попытки доставки сообщения с задержкой в 60 секунд между попытками. При доставке результатов обработки status задачи изменяется на WEBHOOK_DELIVERED или WEBHOOK_FAILED, при доставке ошибок обработки статус не меняется.
callback_id
string
Необязательно
Любое значение ID, необзодимое для идентификации вашего исходного запроса, которое будет отправлено в Webhook при возврате результата. Параметр передается в заголовках запроса в параметре x-callback-id, а так же в теле ответа.
Любое значение ID, необзодимое для идентификации вашего исходного запроса, которое будет отправлено в Webhook при возврате результата. Параметр передается в заголовках запроса в параметре x-callback-id, а так же в теле ответа.
template
string
Необязательно
Шаблон обработки, используемый для определения настроенного рабочего процесса, созданного командой Шöпот для вашей организации, такие как опции постобработки через языковые модели или автоматизацию рабочих процессов. Этот параметр вы получаете от вашего менеджера в команде Шöпот.
Возвращает
Ответ API с id и status задания.
Возможные статусы:
ACCEPTED - запрос принят API сервисом
IN_QUEUE - запрос в очереди на транскрибацию
IN_PROGRESS - запрос транскрибируется
COMPLETED - обработка завершена, если не задан callback_url
WEBHOOK_DELIVERED - завершена обработка, Webhook доставлен успешно по заданному callback_url
WEBHOOK_FAILED - ошибка доставки Webhook по заданному callback_url
FAILED - ошибка обработки с указанием текста ошибки
Возможные статусы:
ACCEPTED - запрос принят API сервисом
IN_QUEUE - запрос в очереди на транскрибацию
IN_PROGRESS - запрос транскрибируется
COMPLETED - обработка завершена, если не задан callback_url
WEBHOOK_DELIVERED - завершена обработка, Webhook доставлен успешно по заданному callback_url
WEBHOOK_FAILED - ошибка доставки Webhook по заданному callback_url
FAILED - ошибка обработки с указанием текста ошибки