Настройка конфигурации FindFace Lite
Вы можете внести персонализированные настройки в FindFace Lite в конфигурационном файле сервиса, расположенном в FFlite -> api_config.yml.
Конфигурационный файл содержит следующие блоки информации:
app — конфигурация API;
eapi — адрес сервиса eapi;
eapi_license_plate — адрес сервиса eapi_license_plate;
vm — адрес и данные для подключения к виртуальной машине;
db — адрес и данные для подключения к базе данных.
Настройка конфигурации
Откройте его, используя текстовый редактор (например: nano, vim и тд.) и внесите изменения в необходимые настройки.
Ниже расположена информация о каждом блоке настроек с описанием возможных параметров и их значений.
Предупреждение
Пожалуйста, изучите описание настроек конфигурационного файл, чтобы корректно вносить изменения.
Примените новые параметры, перезагрузив сервис api. Для этого используйте команду:
docker compose restart api
Настройки блока App
Возможные значения
Настройки |
Возможные значения |
|---|---|
host: |
0.0.0.0 — значение по умолчанию. |
port: |
8000 — значение по умолчанию. |
debug: |
false (по умолчанию) — режим отладки выключен; |
true — режим отладки включен. |
|
router_base_url: |
http://nginx — значение по умолчанию. |
media_root: |
/uploads — значение по умолчанию. |
fullframe_root |
/fullframe – значение по умолчанию. |
normalized_root: |
/normalized – значение по умолчанию. |
save_fullframe: |
false – полноразмерные изображения не будут сохраняться. |
true (по умолчанию) — полноразмерные изображения будут сохраняться. |
|
save_normalized: |
false (по умолчанию) – преобразованные изображения не будут сохраняться. |
true— преобразованные изображения будут сохраняться. |
|
secret_key: |
change_me — значение по умолчанию. |
max_event_age_days: |
20 – значение по умолчанию. |
face_confidence_threshold: |
0.714 – значение по умолчанию. |
car_confidence_threshold: |
0.65 — значение по умолчанию. |
webhook_workers_num: |
10 — значение по умолчанию. |
exit_on_availability_check_fail: |
false – API сервис предпринимает попытки получить необходимые ресурсы до тех пор, пока не получит; |
true (по умолчанию) — API сервис прекратит работу, если один из необходимых для работы ресурсов будет недоступен. |
|
event_creation_token: |
change_me — значение по умолчанию. |
event_creation_response_type: |
serialized (по умолчанию) – ответ будет включать информацию о созданном Event’е (включая совпавшую карточку, путь до полноразмерного изображения и др.). |
id – ответ будет включать ID созданного Event`а. |
|
serialized_verbose — ответ будет включать информацию о созданном Event’е (включая совпавшую карточку, путь до полноразмерного изображения и тд.), а также полную информацию о карточке. |
|
face_features: |
headpose – положение головы; |
medmask – распознавание медицинской маски; |
|
liveness – применение технологии “лайвнес”, при которой происходит оценка объекта на “живость”. |
|
car_features |
orientation — распознавание положения автомобиля. |
special_types – распознавание типа автомобиля. |
|
license_plate_visibility —распознавание номерного знака автомобиля. |
|
liveness_source |
eapi — использование сервиса “eapi” для получения данных о ”живости объектов” для применения технологии “лайвнесс”. Это значение необходимо, для создания Event’ов при помощи API-запроса POST /{object_type}/add с периферийных устройств |
vw – использование сервиса “videoworker” для получения данных о ”живости” объектов для применения технологии “лайвнесс”.. |
|
auth_enabled: |
false — авторизация выключена; |
true (по умолчанию) – авторизация включена. |
|
access_token_expire_minutes: |
43200 — значение по умолчанию. |
dedup_enabled: |
false – дублирование Event’ов выключено; |
true (по умолчанию) – дублирование Event’ов включено. |
|
save_dedup_events: |
false (по умолчанию) – дубликаты Event’ов будут сохранены. |
true— дубликаты ивентов не будут сохранятся. |
|
face_dedup_interval: |
5 – значение по умолчанию. |
face_dedup_confidence: |
0.9 — значение по умолчанию. |
car_dedup_interval: |
5 – значение по умолчанию. |
car_dedup_confidence: |
0.9 — значение по умолчанию. |
Описание настроек
Настройки |
Описание |
|---|---|
host: |
Информация о хосте |
port: |
Информация о порте |
debug: |
Управление режимом отладки. На момент версии 1.3 доступно управление только журналом отладки. |
router_base_url: |
Базовый URL роутера. Пожалуйста, изменяйте, только если уверены в результате. |
media_root: |
Указание корневой директории для хранения изображений объектов Objects. |
fullframe_root |
Указание корневой директории для полноразмерных изображений, полученных из обработчика видеопотоков VideoWorker (vw). |
normalized_root: |
Корневая директория для преобразованных изображений, где они хранятся для миграций между моделями в базе данных. |
save_fullframe: |
Настройки сохранения полноразмерных изображений. |
save_normalized: |
Настройки сохранения преобразованных изображений. |
secret_key: |
Секретный ключ, необходимый для выполнения операций, требующих проверки безопасности. |
max_event_age_days: |
Максимальное время хранения Event’ов. После окончания указанного в настройке времени Event будет удален. |
face_confidence_threshold: |
Значение порога уверенности, согласно которому Event совпадает или не совпадает с Card при распознавании и обработке изображений людей. Если значение порога уверенности превышает установленное значение, Event соотносится Card. |
car_confidence_threshold: |
Значение порога уверенности, согласно которому Event совпадает или не совпадает с Card при распознавании и обработке изображений автомобилей. Если значение порога уверенности превышает установленное значение, Event соотносится с Card. |
webhook_workers_num: |
Количество одновременных обработчиков вебхуков, отправляющих запросы. |
exit_on_availability_check_fail: |
Поведение API сервиса в случае недоступности необходимых ресурсов. |
event_creation_token: |
Токен, используемый для аутентификации внешнего детектора для создания Event`а (/{object_type}/add). Токен JWT не используется в этом запросе. |
event_creation_response_type: |
Варианты содержания ответа на запрос на о создании Event`а (/{object_type}/add). |
face_features: |
Управление функциональностью FindFace Lite для распознавания лиц. Функциональность активна, если она указана в значении. После активации функциональности недавно созданные Event`ы будут обработаны согласно новой настройке. |
car_features |
Управление функциональностью FindFace Lite для распознавания автомобилей. Функциональность активна, если она указана в значении. После активации функциональности недавно созданные Event`ы будут обработаны согласно новой настройке. |
liveness_source |
Источник данных для применения технологии “лайвнесс”. |
auth_enabled: |
Управление авторизацией. Обратите внимание, что все API запросы (с некоторыми исключениями) требуют заголовок Authorization с указанием токена авторизации JWT <token>. |
access_token_expire_minutes: |
Время жизни токена авторизации. |
dedup_enabled: |
Управление дублированием Event’ов. |
save_dedup_events |
Настройки сохранения дублирующихся Event’ов. |
face_dedup_interval: |
Временной интервал в секундах, в течение которого несколько Event’ов с одним человеком отмечаются как дубликаты. |
face_dedup_confidence: |
Порог совпадения между двумя дублирующими Event’ами. |
car_dedup_interval: |
Временной интервал в секундах, в течение которого несколько Event’ов с одной машиной отмечаются как дубликаты. |
car_dedup_confidence: |
Порог совпадения между двумя дублирующими Event’ами. |
Настройки блока EAPI
Настройки |
Возможные значения |
Описание |
|---|---|---|
host: |
eapi — значение по умолчанию. |
Информация о хосте |
port: |
18666 — значение по умолчанию. |
Информация о порте |
Настройки блока License plate EAPI
Настройки |
Возможные значения |
Описание |
|---|---|---|
host: |
eapi-license-plate — значение по умолчанию. |
Информация о хосте |
port: |
18667 — значение по умолчанию. |
Информация о порте |
Настройки блока VM
Настройки |
Возможные значения |
Описание |
|---|---|---|
host: |
vm — значение по умолчанию. |
Информация о хосте |
port: |
18810 – значение по умолчанию. |
Информация о порте |
token: |
GOOD_TOKEN — значение по умолчанию. |
Токен для процессов, связанных с виртуальной машиной. Должен совпадать с токеном из конфигурационного файла vm.conf. |
Настройки блока DB
Настройки |
Возможные значения |
Описание |
|---|---|---|
host: |
postgres — значение по умолчанию. |
Информация о хосте |
port: |
5432 – значение по умолчанию. |
Информация о порте |
user: |
fflite — значение по умолчанию. |
Данные для доступа к базе данных с названием из настройки database. |
password: |
fflite — значение по умолчанию. |
|
database: |
fflite — значение по умолчанию. |
Название базы данных. |