Карточка

Вывести список карточек

Чтобы вывести список карточек, созданных для объекта «Люди», используйте следующий метод:

GET /cards/humans/

Совет

Чтобы вывести список карточек, созданных для объекта «Транспортное средство», используйте /cards/cars/ вместо /cards/humans/.

Запрос содержит параметры QUERY-STRING. Полный список доступных параметров находится по ссылке: http://<findface-ip:port>/api-docs.

Вы можете использовать этот метод для поиска лиц и силуэтов в системе.

CURL пример

curl -X GET "http://<findface-ip:port>/cards/humans/?looks_like=detection:cf4ffvmv54rotim9jt60" \
 -H "Authorization: Token <token>"

В случае успешного ответа (OK: 200) возвращается JSON-объект со следующими параметрами:

Название	Тип	Описание
next_page	string┃null	Следующая страница.
prev_page	string┃null	Предыдущая страница.
results	[{…}]	Массив, содержащий следующие параметры. Пример.

Примечание

* – означает, что параметр является обязательным. 🆁 – только для чтения.

Название		Тип	Описание
id*		integer 🆁	ID карточки.
active		boolean	true, если карточка активна.
created_date*		date-time 🆁	Дата и время создания карточки.
modified_date*		date-time 🆁	Дата и время последнего изменения карточки.
name*		string	Название карточки. Ограничения: минимальное количество символов — 1, максимальное количество символов — 256.
comment		string	Комментарий. Ограничения: минимальное количество символов — 0, максимальное количество символов — 2048.
watch_lists*		array of integers	Массив из ID списков наблюдений.
looks_like*		object	Объект, возвращаемый в ответе только в том случае, если в запросе GET /cards/humans/ задан параметр looks_like. Содержит информацию о наиболее похожем объекте в карточке.
	confidence*	number	Значение параметра looks_like_confidence. Ограничения: минимальное значение — 0, максимальное значение — 1.
	collection*	string┃null	Название коллекции объектов, в которой найден совпадающий объект (например, face_objects — коллекция лиц).
	matched_object*	string┃null	ID совпадающего объекта в карточке.
meta		object	Объект, содержащий метаданные.
looks_like_confidence*		number 🆁	Возвращается в ответе, только если в запросе GET /cards/humans/ задан параметр looks_like. Показывает степень схожести между двумя векторами признаков в базе данных: вектором признаков объекта, по которому выполняется поиск через параметр looks_like, и вектором признаков совпадающего объекта в карточке. Значение параметра looks_like_confidence используется при фильтрации результатов по степени схожести, если задано пороговое значение (threshold).
face_objects*		integer 🆁	Общее количество объектов типа «Лицо» в карточке.
body_objects*		integer 🆁	Общее количество объектов типа «Силуэт» в карточке.
face_cluster*		integer 🆁	ID кластера лиц, для которого найдено совпадение с карточкой.
body_cluster*		integer 🆁	ID кластера силуэтов, для которого найдено совпадение с карточкой.

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

{
 "next_page": null,
 "prev_page": null,
 "results": [
   {
     "id": 1,
     "active": true,
     "created_date": "2025-01-17T07:43:56.363330Z",
     "modified_date": "2025-01-17T11:56:42.496871Z",
     "name": "Angelina Jolie",
     "comment": "actor",
     "watch_lists": [
       2
     ],
     "looks_like": {
       "confidence": 0.8078,
       "collection": "face_objects",
       "matched_object": "4493493039043981648"
     },
     "meta": {},
     "looks_like_confidence": 0.8078,
     "face_objects": 1,
     "body_objects": 0,
     "face_cluster": 11,
     "body_cluster": null
   }
 ]
}

Создание новой карточки

Чтобы создать карточку для объекта «Люди», используйте следующий метод:

POST /cards/humans/

Совет

Чтобы создать карточку для объекта «Транспортное средство», используйте /cards/cars/ вместо /cards/humans/.

Тело запроса является обязательным и содержит объект application/json со следующими параметрами:

Название	Тип	Описание
active	boolean	Если true, созданная карточка будет активна.
name*	string	Название карточки. Ограничения: минимальное количество символов — 1, максимальное количество символов — 256.
comment	string	Комментарий. Ограничения: минимальное количество символов — 0, максимальное количество символов — 2048.
watch_lists*	array of integers	Массив из ID списков наблюдений.
meta	object	Метаданные, представленные в виде объекта с ключами строкового типа и произвольными значениями.

Пример запроса

Совет

Этот пример приведен только для ознакомления. Подставьте свои значения в соответствующие поля. Вы можете заполнить только обязательные поля, а остальные будут использовать значения по умолчанию.

{
 "active": false,
 "name": "A",
 "comment": "AAAAAA",
 "watch_lists": [
   0
 ],
 "meta": {}
}

Например, вы можете отправить в запросе следующие параметры:

{
 "active": true,
 "name": "new card",
 "comment": "sample",
 "watch_lists": [
   1
 ]
}

CURL пример

curl -X POST "http://<findface-ip:port>/cards/humans/" \
 -H "Authorization: Token <token>" \
 -H "Content-Type: application/json" \
 -d '{"active":true,"name":"new card","comment":"sample","watch_lists":[1]}'

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

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

{
 "id": 24,
 "active": false,
 "created_date": "2025-07-21T15:26:52.435522Z",
 "modified_date": "2025-07-21T15:26:52.435560Z",
 "name": "new card",
 "comment": "sample",
 "watch_lists": [
   1
 ],
 "meta": {},
 "face_objects": 0,
 "body_objects": 0,
 "face_cluster": null,
 "body_cluster": null
}

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

GET /cards/cars/
POST /cards/cars/
GET /cards/cars/{id}/
DELETE /cards/cars/{id}/
PATCH /cards/cars/{id}/
GET /cards/cars/count/
GET /cards/humans/
POST /cards/humans/
GET /cards/humans/{id}/
DELETE /cards/humans/{id}/
PATCH /cards/humans/{id}/
GET /cards/humans/count/