Конфигурация Oz API

Настройка Oz API производится путем изменения конфигурационного файла, расположенного на сервере Oz API по пути /opt/gateway/configs/config.py

Важно! После изменения настроек файла конфигурации необходимо перезапустить сервис Oz API следующей командой:

Bash


    sudo systemctl restart gateway.target

Настройки файла конфигурации Oz API.

Основные настройки:

PORT - Порт для генерируемых приложением адресов файловых ресурсов. По-умолчанию «80» , числовой параметр;

DEBUG - Работает ли система в режиме отладки. Возможные значения = True\False;

SCHEME – схема для генерируемых приложением адресов файловых ресурсов. Возможные значения = http\https

ALLOWED_HOSTS – URL, который может быть использован при обращении к системе, может быть более 1 значения, текстовый параметр;

HOST - Имя хоста веб-сервера, используемого для генерируемых приложением адресов файловых ресурсов. Может быть определен конструкцией вида: ALLOWED_HOSTS[0], где цифра в квадратных скобках определяет имя хоста из массива, заданного в параметре ALLOWED_HOSTS (отсчёт ведется с нуля).

Настройки связи с базой данных:

DB_USER – имя пользователя для связи с базой данных системы, текстовый параметр;

DB_HOST - адрес сервера базы данных системы, текстовый параметр;

DB_PASS - пароль для связи с базой данных системы, текстовый параметр;

DB_NAME - наименование базы данных системы, текстовый параметр;

DB_ENGINE - тип базы данных системы, текстовый параметр;

DB_CONNECT_OPTS - специализированные параметры подключения к базе данных, текстовый параметр, по-умолчанию значение «None».

Настройки таймаутов:

OZ_EXTERNAL_REQUEST_TIMEOUT – таймаут на исполнение HTTP-запроса к внешней системе, числовой параметр в секундах;

OZ_CELERY_RETRY_MAX_COUNT – максимальное количество повторных отправок запросов при возникновении ошибок обработки запроса, числовой параметр;

OZ_CELERY_RETRY_STEP – время между повторными отправками запросов при возникновении ошибок обработки запроса, числовой параметр в секундах;

OZ_ANALYSE_PROCESSING_EXPIRE_TIMEOUT – таймаут ожидания завершения анализа, числовой параметр в секундах;

OZ_ANALYSE_DELIVERY_EXPIRE_TIMEOUT – таймаут отправки запроса на обработчики, числовой параметр в секундах;

OZ_ANALYSE_EXPIRE_BEAT_PERIOD – частота проверки завершения анализа, числовой параметр в секундах.

Настройки модулей:

OZ_FFMPEG_BINARY – папка на сервере с утилитой раскадровки видео FFMpeg, текстовый параметр;

OZ_COLLECTION_FOLDER_NAME – наименование папки с коллекциями, текстовый параметр;

OZ_REPORTS_FOLDER_NAME – наименование папки с отчетами, текстовый параметр;

OZ_SERVICE_REGULA_HOST - адрес сервера модуля OZ Text, текстовый параметр;

OZ_SERVICE_REGULA_USERID - имя пользователя для связи с модулем OZ Text, текстовый параметр;

OZ_SERVICE_REGULA_PASSWORD - пароль для связи с модулем OZ Text, текстовый параметр;

OZ_SERVICE_PHOTOEXPERT_HOST - адрес сервера модуля OZ Photoexpert, текстовый параметр;

OZ_SERVICE_PHOTOEXPERT_USER - имя пользователя для связи с модулем OZ Photoexpert, текстовый параметр;

OZ_SERVICE_PHOTOEXPERT_PASSWORD - пароль для связи с модулем OZ Photoexpert, текстовый параметр;

OZ_SERVICE_COLLECTION_API_NODE – адрес сервера проверок OZ Collection, текстовый параметр;

OZ_SERVICE_TFSS_ANALYSE_VALID_ACTION_MAP – блок настройки соответствия типов действий в системе проводимым анализам. Пример настройки: 'biometry': ['far', 'close'] - на проверку Biometry будут отправляться только видео с тэгами «video_selfie_zoom_in» и «video_selfie_zoom_out», видео с остальными тэгами будут проигнорированы. Для определения тэгов в этом параметре используются сокращенные наименования, массив соответствия можно посмотреть в параметре конфигурационного файла «OZ_MEDIA_TAGS_MAPPING». Список актуальных тэгов.

OZ_SERVICE_TFSS_HOST – адрес TFSS-сервера системы, текстовый параметр.

Настройки порогов:

OZ_SERVICE_THRESHOLD_BIOMETRY_MIN – нижний порог для проверки Biometry;

OZ_SERVICE_THRESHOLD_BIOMETRY_MAX – верхний порог для проверки Biometry;

OZ_SERVICE_THRESHOLD_BLACKLIST_MIN – нижний порог для проверки Collection;

OZ_SERVICE_THRESHOLD_BLACKLIST_MAX – верхний порог для проверки Collection;

OZ_SERVICE_THRESHOLD_LIVENESS - порог для проверки Quality, на текущий момент не используется;

OZ_SERVICE_THRESHOLD_REPLAY - порог для проверки Quality, на текущий момент не используется;

OZ_SERVICE_THRESHOLD_SPOOFING - порог для проверки Quality.

Настройки размера и количества файлов в запросе:

OZ_IMAGE_SIZE_THUMBNAIL - максимальный размер thumbnail-файла в байтах;

OZ_ATTACHMENT_MAX_COUNT - Максимальное количество файлов в одном запросе;

OZ_ATTACHMENT_MAX_SIZE – максимальный размер файла в байтах.

Настройки работы с медиа-файлами:

OZ_VIDEO_DURATION_MAX – Максимальная длительность видео в системе;

OZ_SERVICE_TFSS_SLICING – параметры раскадровки FFMPEG для моделей, работающих с видео:

  • sentinel\podium\inquisitor – наименование целевой модели;
  • mode – метод извлечения кадров:
    • rate – количество кадров в секунду;
    • count – точное количество кадров;
  • value – числовое значение количества кадров\количества кадров в секунду;

OZ_SERVICE_TFSS_INQUISITOR_THR – внутренний порог для модели Inquisitor;

OZ_SERVICE_SLIDER_DEFAULT_MODELS – наименование модели по-умолчанию для извлечения лица;

OZ_MEDIA_TAGS_MAPPING – блок настройки модели для извлечения лица в зависимости от тэга медиа-файла и список используемых в системе тэгов и их сокращенных наиманований. Список актуальных тэгов;

OZ_VALID_MIMETYPES_IMAGE – блок настройки валидных для системы mime-типов фото-файлов;

OZ_VALID_MIMETYPES_VIDEO – блок настройки валидных для системы mime-типов видео-файлов;

OZ_VALID_MIMETYPES_VIDEO_PREVIEW – блок настройки валидных для системы mime-типов превью видео-файлов;

OZ_VIDEO_PREVIEW_CONVERT_TARGET_FORMAT – целевой формат для конвертации видео;

OZ_VIDEO_PREVIEW_CONVERT_TIMEOUT – таймаут конвертации видео.

Настройки продолжительности сессии:

OZ_SESSION_TTL – стандартная продолжительность сессии для не-сервисных учетных записей;

OZ_SESSION_LONGLIVE_TTL - продолжительность сессии для сервисных учетных записей.

Настройки восстановления паролей:

OZ_EMAIL_RESTORE_CODE_TIMEOUT – время устаревания пин-кода восстановления пароля;

OZ_EMAIL_RESTORE_TEMPLATE_NAME – имя файла с шаблоном письма по восстановлению пароля;

OZ_EMAIL_RESTORE_SUBJECT – тема письма по восстановлению пароля.

Настройки логирования SQL-запросов:

LAMB_VERBOSE_SQL_LOG – включение логирования сырых SQL запросов. Возможные значения = true\false;

LAMB_VERBOSE_SQL_LOG_THRESHOLD - лимит на длительность запроса к БД, числовой параметр в секундах.

Персонализированная настройки типов документов модуля OZ Text

За настройку типов документов модуля OZ Text в конфигурационном файле отвечают:

  • параметр OZ_SERVICE_REGULA_DEFAULT_CAPABILITIES, значение параметра для обычного использования системы = 508, значение параметра для использования системы с применением OZ Mobile SDK для IOS-Android (тут гиперссылка на раздел «OZ Mobile SDK для IOS-Android», сам раздел в разработке) = 492
  • параметр OZ_SERVICE_REGULA_DEFAULT_AUTHENTICITY, значение всегда = 0, на данный момент не используется
  • блок параметров OZ_SERVICE_REGULA_DOCTYPE_GROUP_CHECKS - задача данного блока параметров - явно требовать для двустраничных документов вторую страницу определенного типа и проверять наличие необходимых полей.

Пример настройки пары страниц документа в «OZ_SERVICE_REGULA_DOCTYPE_GROUP_CHECKS»:

JSON


    \\ комментарий, наименование типа документа в Oz Text. Рекомендуется указывать для удобства чтения.
    # KAZ: {'Id Card #1', 'Id Card #1 Side B'},
    \\ внутренние ID двух сторон двустороннего документа в Oz Text
    frozenset({825787810, 1308487493}):         
    \\ Перечень необходимых для успешной проверки документа полей
    { 'Personal_Number', 'Nationality', 'Nationality_Code', 'Date_of_Expiry', 'Sex', 'Document_Number', 'MRZ_Strings_With_Correct_CheckSums', 'Surname', 'Given_Names', 'Date_of_Birth', # 'Authority', 'Date_of_Issue' }


Если при подобной настройке на вход в Oz Text будет подана хотя бы одна страница документа из указанной в настройке пары, то система будет требовать обязательного наличия второй страницы пары. Если не определен тип документа (например из-за недостаточно высокого качества скана или фотографии) или нет хотя бы одного из перечисленных полей то проверка завершается неуспешно (FAILED).