Dbrain
Ask or search…
K
Comment on page

Liveness

Оцениваем фотографию на «живость», чтобы убедиться, что перед нами фото человека, а не снимок экрана или другой фотографии
Чтобы воспользоваться сервисом, отправьте POST-запрос на URL
https://latest.dbrain.io/v2/face/liveness

Параметры запроса к сервису

Асинхронный запрос

async — boolean
Поведение по умолчанию: 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 секунды.

Возврат найденных областей изображения

return_crops — boolean
Поведение по умолчанию: return_crops=false — сервис не возвращает найденные области изображения с лицами.
Если вам нужны найденные сервисом области изображения с лицами, укажите return_crops=true. Сервис вернёт их в ответе API в параметре crop.

Тегирование запроса

task_tags — string array
Поведение по умолчанию: параметр не используется.
Функция тегирует запросы по вашему усмотрению. Это упрощает отслеживание пакетов документов, связанных с конкретным клиентом. Для использования функции, укажите в параметре task_tags удобный вам тег: task_tags=тэг

Тело запроса к API

Изображение

image — string ($binary)
Обязательно для передачи в запросе. Сервис ожидает изображение в двоичном виде.
Перед началом работы с сервисами советуем заглянуть в раздел «Общая информация о сервисах». В нём перечислили форматы файлов, которые поддерживают сервисы, описали общие для всех сервисов параметры API и расшифровали коды ошибок.

В ответе на запрос API:

Иллюстрация к понятиям yaw, pitch и roll
  • task_id — string, идентификатор запроса, формат: 32 символа, 16-ричная строка
  • status_code — integer, дублирует код состояния HTTP
  • success — boolean, статус выполнения запроса
  • result — массив, содержащий смысловую часть ответа
    • liveness_score — number, числовое выражение liveness лица, принимает значения от 0 до 1. Чем больше значение, тем больше изображение похоже на живого человека
    • input_image — оригинальное изображение из запроса в формате base64
    • warnings — массив с предупреждениями об отклонениях параметров лица от стандарта (здесь и далее ISO/IEC 19794-5), возможные значения:
      • More than one face detected — найдено более 1 лица
      • No face detected on image — лицо не найдено
      • Head yaw is too high — поворот головы относительно вертикальной оси превышает ±5 градусов
      • Head pitch is too high — наклон головы вверх или вниз относительно горизонтальной оси, проведённой через уши превышает ±5 градусов
      • Head roll is too high — наклон головы налево или направо относительно горизонтальной оси, проведённой через нос превышает ±5 градусов
      • Left eye closed — левый глаз закрыт
      • Left eye occluded — левый глаз заслонён более чем на 5%
      • Right eye closed — правый глаз закрыт
      • Right eye occluded — правый глаз заслонён более чем на 5%
      • Mouth opened — рот открыт
      • Mouth occluded — рот заслонён более чем на 5%
    • face — объект, описывающий найденное лицо
      • confidence — number, от 0 до 1, уровень уверенности сервиса в том, что найденная область изображения действительно лицо.
      • coords — массив из integer, координаты лица на изображении по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правый
      • coords_relative — массив, в текущей версии параметр не используется
      • crop — найденная область лица в формате base64. Если в запросе return_crops=false, параметр возвращает null
      • page — integer, номер страницы файла, на котором найдено лицо
      • rotation — integer, в котором закодирована ориентация лица
        • 0 — поворот не требуется
        • 1 — требуется поворот на 90 градусов
        • 2 — требуется поворот на 180 градусов
        • 3 — требуется поворот на 270 градусов
      • description — string, в текущей версии параметр не используется
      • type — string, в текущей версии параметр не используется
      • head — объект, содержащий оценку положения головы в трёх измерениях
        • pitch — number от -180 до 180: оценка наклона головы вверх или вниз относительно горизонтальной оси, проведённой через уши, где 0 — нет наклона.
        • yaw — number от -180 до 180: оценка поворота головы налево или направо относительно вертикальной оси, где 0 — нет поворота.
        • roll — number от -180 до 180: оценка наклона головы налево или направо относительно горизонтальной оси, проведённой через нос, где 0 — нет наклона.
      • left_eye — объект, содержащий оценку левого глаза
        • occluded — number от 0 до 1, где 0 — глаз ничем не заслонён, а 1 — глаз полностью заслонён
        • open — true/false, где true — глаз открыт
      • right_eye — объект, содержащий оценку правого глаза
        • occluded — number от 0 до 1, где 0 — глаз ничем не заслонён, а 1 — глаз полностью заслонён
        • open — true/false, где true — глаз открыт
      • mouth — объект, содержащий оценку рта
        • occluded — number от 0 до 1, где 0 — рот ничем не закрыт, а 1 — рот полностью закрыт
Остальные поля не несут практического смысла. Оставили их для совместимости со старыми версиями.
Last modified 18d ago