Группы камер

Группа камер - это набор камер, установленных в одном и том же месте или используемых для схожих целей.

Вывести список групп камер

Для того чтобы отобразить список групп камер, используйте следующий метод:

GET /camera-groups/

Запрос содержит следующие параметры QUERY-STRING:

Название	Тип	Описание
created_date_gt	date-time	Выбрать группы камер, у которых значение created_date больше указанного.
created_date_gte	date-time	Выбрать группы камер, у которых значение created_date больше или равно указанному.
created_date_last_n_days	number	Выбрать группы камер со значением created_date за последние N дней.
created_date_lt	date-time	Выбрать группы камер, у которых значение created_date меньше указанного.
created_date_lte	date-time	Выбрать группы камер, у которых значение created_date меньше или равно указанному.
created_date_nth_full_week	number	Выбрать группы камер со значением created_date за последние N недель (включая субботу и воскресенье).
created_date_nth_work_week	number	Выбрать группы камер со значением created_date за последние N недель (только рабочие дни, исключая субботу и воскресенье).
id_gte	integer	Выбрать группы камер, у которых значение ID больше или равно указанному.
id_in	array of integers	Выбрать группы камер, ID которых указаны в массиве.
limit	integer	Количество выводимых результатов.
name_contains	string	Выбрать группы камер, в названии которых содержится указанный текст, независимо от регистра.
ordering	string	Поле для сортировки результатов запроса. Допустимые поля: id, created_date, modified_date, name, active.
page	string	Значение курсора пагинации.

Чтобы найти в ответе ID определенной группы камер, укажите значения параметров limit и ordering — это позволит сузить и упорядочить результаты поиска.

CURL пример

curl -X GET "http://<findface-ip:port>/camera-groups/?limit=3&ordering=id" \
  -H "Authorization: Token <token>"

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

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

Примечание

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

Название	Тип	Описание
id*	integer 🆁	ID группы камер.
created_date*	date-time 🆁	Дата и время создания группы камер.
modified_date*	date-time 🆁	Дата и время последнего изменения группы камер.
active	boolean	true, если события из этой группы камер должны обрабатываться.
name*	string	Название группы камер. Ограничения: минимальное количество символов — 1, максимальное количество символов — 256.
comment	string	Комментарий. Ограничения: минимальное количество символов — 0, максимальное количество символов — 2048.
deduplicate	boolean	true, если события из этой группы камер должны быть дедуплицированы.
deduplicateDelay	integer	Тайм-аут дедупликации событий. Значение по умолчанию: 15. Ограничения: минимальное значение — 0, максимальное значение — 10000.
labels	object	Объект, содержащий одну или несколько меток, используемых для привязки группы камер к определенному экземпляру findface-video-worker для обработки видеопотоков из этой группы камер.
face_threshold	number┃null	Порог срабатывания, применяемый при распознавании лиц для этой группы камер. Ограничения: минимальное значение — 0, максимальное значение — 1.
body_threshold	number┃null	Порог срабатывания, применяемый при распознавании силуэтов для этой группы камер. Ограничения: минимальное значение — 0, максимальное значение — 1.
car_threshold	number┃null	Порог срабатывания, применяемый при распознавании транспортных средств для этой группы камер. Ограничения: минимальное значение — 0, максимальное значение — 1.

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

{
 "next_page": null,
 "prev_page": null,
 "results": [
   {
     "id": -1,
     "created_date": "2025-01-16T13:44:36.531501Z",
     "modified_date": "2025-01-16T13:44:36.531519Z",
     "active": true,
     "name": "Video archive default Camera Group",
     "comment": "",
     "deduplicate": false,
     "deduplicateDelay": 15,
     "labels": {},
     "face_threshold": null,
     "body_threshold": null,
     "car_threshold": null
   }
 ]
}

Создать группу камер

Чтобы добавить новую группу камер, используйте следующий метод:

POST /camera-groups/

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

Название	Тип	Описание
active	boolean	Если true, то события из этой группы камер будут обрабатываться.
name*	string	Название группы камер. Ограничения: минимальное количество символов — 1, максимальное количество символов — 256.
comment	string	Комментарий. Ограничения: минимальное количество символов — 0, максимальное количество символов — 2048.
deduplicate	boolean	Если true, то события из этой группы камер будут дедуплицированы.
deduplicateDelay	integer	Тайм-аут дедупликации событий. Значение по умолчанию: 15. Ограничения: минимальное значение — 0, максимальное значение — 10000.
labels	object	Объект, содержащий одну или несколько меток, используемых для привязки группы камер к определенному экземпляру findface-video-worker для обработки видеопотоков из этой группы камер.
face_threshold	number┃null	Порог срабатывания, применяемый при распознавании лиц для этой группы камер. Ограничения: минимальное значение — 0, максимальное значение — 1.
body_threshold	number┃null	Порог срабатывания, применяемый при распознавании силуэтов для этой группы камер. Ограничения: минимальное значение — 0, максимальное значение — 1.
car_threshold	number┃null	Порог срабатывания, применяемый при распознавании транспортных средств для этой группы камер. Ограничения: минимальное значение — 0, максимальное значение — 1.

CURL пример

curl -X POST "http://<findface-ip:port>/camera-groups/" \
 -H "Authorization: Token <token>" \
 -H "Content-Type: application/json" \
 -d '{"active":true,"name":"Office camera group","comment":"AAAAAA","deduplicate":false,"deduplicateDelay":0,"labels":{},"face_threshold":0,"body_threshold":0,"car_threshold":0}'

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

Совет

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

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

{
 "active": false,
 "name": "Test_camera_group",
 "comment": "AAAAAA",
 "deduplicate": false,
 "deduplicateDelay": 0,
 "labels": {},
 "face_threshold": 0,
 "body_threshold": 0,
 "car_threshold": 0
}

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

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

{
 "id": 2,
 "created_date": "2025-01-23T12:14:09.885006Z",
 "modified_date": "2025-01-23T12:14:09.885030Z",
 "active": false,
 "name": "Test_camera_group",
 "comment": "AAAAAA",
 "deduplicate": false,
 "deduplicateDelay": 0,
 "labels": {},
 "face_threshold": 0,
 "body_threshold": 0,
 "car_threshold": 0
}

Используйте ID группы камер при отправке POST-запроса для создания новой камеры.

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

GET /camera-groups/
POST /camera-groups/
GET /camera-groups/{id}/
DELETE /camera-groups/{id}/
PATCH /camera-groups/{id}/
GET /camera-groups/count/