HTTP API Voicee (0.17.0)

Аутентификация происходит с помощью передачи api ключа, который вам выдал наш партнер в заголовке Authentication: Bearer ключ

1. Поставить обработку в очередь

   1. Если есть ссылка на аудио файл: можно отправить классический запрос с JSON в теле

      curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer tk-..." https://api.voicee.ru/v1/replicate/v1/models/voicee/transcribe/predictions -d '{"input": {"audio": "https://..."}}'
      

   2. Если вы хотите загрузить файл внутри запроса

      Мы поддерживаем загрузку файлов в 3 форматах: multipart/form-data, application/octet-stream и application/json. Ограничение на размер файла - 300MiB.

      multipart/form-data

      Описание формата можно посмотреть на википедии: https://ru.wikipedia.org/wiki/Multipart/form-data

      curl -X POST https://api.voicee.ru/v1/replicate/v1/models/voicee/transcribe/predictions -H "Authorization: Bearer tk-<token here>" -F "input.audio=@/path-to-file/audio.mp4"
      

      при этом /path-to-file/audio.mp4 - это путь к файлу на вашем компьютере, а собачка перед путем обязательна - она подсказывает утилите curl, что это файл.

      application/octet-stream

      Если у вас нет под рукой клиента, который уже поддерживает мультипарт запросы, возможно самым простым вариантом будет отправка файла как есть в теле запроса. При этом нашей модели понадобится подсказка в какой параметр подложить этот файл - ее следует передать в заголовке X-Voicee-Body-Field:

      curl https://api.voicee.ru/v1/replicate/v1/models/voicee/transcribe/predictions -H "Authorization: Bearer tk-<token here>" -H "X-Voicee-Body-Field: input.audio" -H "Content-Type: application/octet-stream" --data-binary "@/path-to-file/audio.mp4"
      

      application/json

      Мы не рекомендуем пользоваться этим вариантом т.к. по проводу будет передаваться втрое больше байт и в будущем мы возможно перестанем его поддерживать, но сегодня он работает. Передавать файлы можно в виде строк внутри JSON предварительно откодировав их в base64. Пример не приводим сознательно.

   В обоих случаях в ответ вы получите айди задачки и статус:

   {"id": "<prediction_id>", "status": "processing", ...}
   

2. Узнать статус обработки и получить результат

   Опрашивать статус обработки можно по айди задачки:

   curl https://api.voicee.ru/v1/replicate/v1/predictions/<prediction_id> -H "Authorization: Bearer tk-<token here>"
   

   Конечными статусами являются failed и succeeded.

   Формат вывода

   Ответом основной нашей модели является сложный словарь с траснкриптом разделенным на сегменты. Иногда такая сложность не нужна и нужно получить просто текст Вывод можно контролировать с заголовком X-Voicee-Output-Transformers. Пример:

   X-Voicee-Output-Transformers: text?speakers=false&timestamps=false&pauses=false
   

Рядом с обычным API мы публикуем replicate совместимый API, чтобы вы могли использовать готовые библиотеки для работы с нашим API на множестве языков.

Полный список библиотек можно посмотреть на странице библиотек.

API ключ - используйте тот же ключ, который используете для обычного API

При создании клиента укажите baseUrl = https://api.voicee.ru/

В качестве модели используйте voicee/transcribe

Пример для Python:

1. Установите библиотеку

pip install 'replicate<0.32.0'

2. Установите токен и базовый URL в переменные окружения

export REPLICATE_API_TOKEN=<ваш ключ>
export REPLICATE_BASE_URL=https://api.voicee.ru/

или, если у вас уже есть .env файл с переменными окружения - добавьте их в него:

REPLICATE_API_TOKEN=<ваш ключ>
REPLICATE_BASE_URL=https://api.voicee.ru/

или, вы можете указать эти настройки прямо в коде приложения:

from replicate import Client

client = Client(base_url='https://api.voicee.ru/', api_token='Ваш ключ')

# дальше используйте client.run(...) вместо replicate.run(...)

3. Запустите транскрибацию

import replicate

audio_file_url = "https://example.com/audio.mp3"

result = replicate.models.run(
    "voicee/transcribe",
    input={"url": audio_file_url},
)

print(result)
# output example TBD