Перейти к основному содержимому
Версия: 1.3.1

Структура API-запроса

В веб-интерфейсе Swagger описаны два вида запросов: Process Sample и Process Image.

img.png

Process Sample (Обработка сэмпла)

Content-Type: application/json

Path: <image_api_url>/<service_name>/process/sample

В качестве тела запроса выступает сэмпл, содержащий:

  • $image - исходное изображение в формате base64
  • objects - объекты обработки (лица и силуэты)

Для каждого объекта обработки предусмотрен определенный набор атрибутов, который отличается в зависимости от используемого сервиса. В ответ API возвращает атрибуты с вычисленными значениями.

примечание

Поля, отмеченные знаком “$”, например, $image, определяют, что кодирование значения выполнено в формате base64.

Process Image (Обработка изображения)

Content-Type: multipart/form-data

Path: <image_api_url>/<service_name>/process/image

В качестве тела запроса выступает изображение в одном из форматов: jpg, png, bmp.

примечание

Данный интерфейс недоступен для сервисов quality-assessment-estimator, verify-matcher, age-estimator, mask-estimator, emotion-estimator, gender-estimator, т.к. для их работы требуются дополнительные атрибуты объектов в качестве входных данных. Доступность интерфейса конкретного сервиса можно проверить в веб-интерфейсе Swagger.