Comment on page
Общая информация о сервисах
Собрали на одной странице универсальную информацию по всем сервисам Dbrain: краткое описание сервисов, форматы файлов, запросов и ответов, набор HTTP-статусов и рекомендации по устранению ошибок
- Извлечение данных из документов — извлекаем данные из изображений документов и возвращаем их в структурированном виде.
- Проверка документов — предоставляем набор сервисов для проверки изображений документов на признаки подделки, качество, наличие подписей и печатей, а также по базам данных.
- Операции с лицами — предоставляем набор сервисов для работы с изображениями лиц: сравнение лиц и лиц с фотографиями на документах, liveness.
Сервисы Dbrain обрабатывают одностраничные файлы любого формата из ниже перечисленных. Многостраничные файлы только форматов PDF и DJVU:
Формат | Одностраничный | Многостраничный |
|---|---|---|
JPEG/JPG | ||
PDF | ||
PNG | ||
TIFF | ||
BMP | ||
GIF | ||
HEIC | ||
HEIF | ||
DJVU |
Размер файлов должен быть не более 30 Mb и не менее 1 Kb
Сервис принимает запросы в формате
multipart/form-data.В ответах формата JSON используется кодировка
UTF-8.Все сервисы Dbrain поддерживают этот набор параметров. Использовать их необязательно, но они могут помочь решить вашу задачу.
Поведение по умолчанию:
async=false — сервис обрабатывает запросы синхронно. При отправке запроса вы получите ответ только после окончательного завершения обработки запроса сервисом.Если вам нужен асинхронный режим, укажите в запросе
async=true. В таком случае в ответ на запрос сервис вернёт в response body параметр task_id, например:"task_id": "96b8ccc950a70699927036842c624d7c"
Используйте этот
task_id, чтобы получить результаты классификации в методе result:curl -X 'GET' \
'https://latest.dbrain.io/result/96b8ccc950a70699927036842c624d7c?token=XXX' \
-H 'accept: application/json'
Не забудьте указать в параметре
token ваш ключ лицензии. Рекомендуем запрашивать метод result в цикле с периодом 1-2 секунды.task_tags — string array
Поведение по умолчанию: параметр не используется.
Функция тегирует запросы по вашему усмотрению. Это упрощает отслеживание пакетов документов, связанных с конкретным клиентом-физлицом. Для использования функции, укажите в параметре
task_tags удобный вам тег: task_tags=тэгВсе сервисы Dbrain требуют передачи изобра жения в теле запроса. В случае с сервисом «Сравнение лиц» нужно передать два изображения в атрибутах
image1 и image2.image — string ($binary)
Обязательно для передачи в запросе. Сервис ожидает изображение в двоичном виде.
Сервисы Dbrain возвращают универсальный набор HTTP-статусов. Описали причины и рекомендации к каждому статусу.
Код означает, что сервис успешно обработал запрос и вернул запрошенные данные. Код 200 HTTP является наилучшим кодом ответа, который можно получить, потому что означает, что всё работает именно так, как должно быть.
Наш сервис принял запрос в обработку, но ответ ещё не готов. Повторите запрос через 1-2 секунды.
Вы попытались получить результат задачи, отправленной от другого токена. Проверьте корректность параметра token в запросе.
Задача с таким task_id не найдена. Проверьте корректность параметра task_id в запросе.
В запросе не указан токен или есть проблемы с лицензией. Например, истёк срок действия или превышено число запросов. Проверьте корре ктность параметра token в запросе. Если token указан верно, напишите нам в телеграм или на [email protected]
Вы использовали неверный тип запроса. Например, отправили GET вместо POST.
Вы отправили слишком большой файл. Файл должен быть меньше 30 Мб. Если у вас тяжелый многостраничный файл, разбейте его на несколько файлов перед отправкой. Если файл из одной страницы — сохраните его с меньшим разрешением.
Вы отправили слишк ом маленький файл. Сервисы Dbrain не поддерживают файлы меньше 1 Кб.
Скорее всего вы передали неправильный content-type тела запроса. Возможно вы отправили текст вместо файла. Проверьте запрос.
Внутренняя ошибка сервиса Dbrain. Как правило сопровождается пояснением. Попробуйте повторить запрос. Если это не решило проблему, напишите нам в телеграм или на [email protected].
Проблемы с роутингом соединения до сервисов Dbrain. Возможно проблема на вашей стороне, проверьте сетевые настройки.
Сервис недоступен, возможно, перегружен. Попробуйте повторить запрос позже. Если появился такой статус, значит мы тоже о нём знаем и уже решаем проблему.
Отправьте GET-запрос на адрес
https://latest.dbrain.io/healthcheck.В ответ вы получите код состояния HTTP
200 с Content-Type: application/json и телом ответа {"success": true}.Если пришёл любой другой код, значит есть проблемы с сервисом и мы уже их устраняем.
Last modified 18d ago