Объекты

Добавить объект «Лицо»

POST /objects/faces/

Данный метод позволяет создать объект «Лицо», который содержит исходное фотоизображение, миниатюру лица и другие атрибуты.

Совет

Для объектов «Автомобиль» и «Силуэт» в запросах используйте cars или body вместо faces.

Тело запроса является обязательным и содержит multipart/form-data со следующими параметрами:

Название	Схема JSON	Описание
`create_from`	string	Данное поле может содержать один из следующих вариантов идентификатора объекта: `detection:<detection id>`: используйте обнаруженный объект с помощью метода `POST /detect` на исходном изображении. Исходное фотоизображение в поле `source_photo` должно совпадать с фотоизображением в запросе `POST /detect`. `event:<event id>` для лица, силуэта или автомобиля: создавайте новый объект из События (поле `source_photo` должно быть пустым). `object:<object id>` для лица, силуэта или автомобиля: используйте другой объект в качестве шаблона для текущего объекта (поле `source_photo` должно быть пустым).
`detect_id`	string	Вспомогательный параметр.
`mf_selector`	enum	Этот параметр определяет действие FindFace Multi, когда в `source_photo` присутствует несколько объектов, а `create_from` не задан. Значение по умолчанию: `reject`. Допустимые значения: `reject` – Отклонить, если в исходном фотоизображении несколько объектов. `biggest` – Выбрать наибольший объект в исходном фотоизображении.
`upload_list`	integer	Добавить объект в данный список загрузок.
`source_photo`	binary	Исходное фотоизображение (является обязательным, если в поле `create_from` указан `detection:<detection id>` или остается пустым)
`frame_coords_left`	integer	Левая граница прямоугольника вокруг объекта.
`frame_coords_top`	integer	Верхняя граница прямоугольника вокруг объекта.
`frame_coords_right`	integer	Правая граница прямоугольника вокруг объекта.
`frame_coords_bottom`	integer	Нижняя граница прямоугольника вокруг объекта.
`active`	boolean	`true`, если объект активен. Значение по умолчанию `true`.
`card`	integer	ID связанной карточки.

Прикрепите фотоизображение в поле source_photo, укажите ID соответствующей карточки и вставьте detection:<detection id> в форму create_from, где detection id полученный id при обнаружении объекта на фотоизображении. В поле source_photo должно быть то же изображение, что и в запросе POST /detect.

CURL пример

curl -X POST "http://<findface-ip:port>/objects/faces/" \
  -H "Accept: application/json" \
  -H "Content-Language: ru" \
  -H "Accept-Language: ru" \
  -H "Authorization: Token <token>" \
  -H "Content-Type: multipart/form-data" \
  -F "create_from=detection:cf2g86uv54rqhngnq960" \
  -F "source_photo=@Смит_01.png" \
  -F "card=3" \

В случае успешного ответа (Created: 201), возвращается объект со следующими параметрами. Пример.

Название	Схема JSON	Описание
`id*`	string 🆁	ID.
`created_date*`	date-time 🆁	Дата создания объекта.
`modified_date*`	date-time 🆁	Дата изменения объекта.
`source_photo_name*`	string 🆁	Имя файла, указанное для `source_photo` при создании объекта.
`frame_coords_left`	integer	Левая граница прямоугольника вокруг объекта.
`frame_coords_top`	integer	Верхняя граница прямоугольника вокруг объекта.
`frame_coords_right`	integer	Правая граница прямоугольника вокруг объекта.
`frame_coords_bottom`	integer	Нижняя граница прямоугольника вокруг объекта.
`thumbnail*`	uri 🆁	Миниатюра объекта.
`active`	boolean	`true`, если объект активен. Значение по умолчанию `true`.
`features*`	Поддерживается любой из форматов: str┃int┃float┃bool┃object┃array┃null	Признаки.
`card*`	integer	ID соответствующей карточки.

Пример ответа

{
 "card": 3,
 "created_date": "2023-01-16T08:12:55+00:00",
 "modified_date": "1970-01-01T00:00:00+00:00",
 "source_photo_name": "Смит_01.png",
 "source_photo": "http://172.23.218.94/uploads/cards/7w/3/face_%D0%A1%D0%BC%D0%B8%D1%82_01_ftgY5K.png",
 "thumbnail": "http://172.23.218.94/uploads/cards/TD/3/face_%D0%A1%D0%BC%D0%B8%D1%82_01_thumbnail_VyVsIj.png",
 "frame_coords_left": 757,
 "frame_coords_top": 79,
 "frame_coords_right": 948,
 "frame_coords_bottom": 353,
 "active": true,
 "features": {},
 "id": "4493225067924944019",
 "meta": {}
}

Полезные API запросы

GET /objects/bodies/
POST /objects/bodies/
GET /objects/bodies/{id}/
DELETE /objects/bodies/{id}/
PATCH /objects/bodies/{id}/
GET /objects/cars/
POST /objects/cars/
GET /objects/cars/{id}/
DELETE /objects/cars/{id}/
PATCH /objects/cars/{id}/
GET /objects/faces/
POST /objects/faces/
GET /objects/faces/{id}/
DELETE /objects/faces/{id}/
PATCH /objects/faces/{id}/