settings

Retrieve FF.Multi settings

Use this method to retrieve the FindFace Multi settings.

get/settings

Response

face_confidence_thresholdnumber float required

Face similarity threshold

body_confidence_thresholdnumber float required

Body similarity threshold

car_confidence_thresholdnumber float required

Car similarity threshold

face_episodes_thresholdnumber float required

Human episodes face threshold

body_episodes_thresholdnumber float required

Human episodes body threshold

car_episodes_thresholdnumber float required

Car episodes car threshold

minimum_face_qualitynumber float required

Minimum face quality for inclusion in a card

minimum_car_qualitynumber float required

Minimum car quality for inclusion in a card

minimum_body_qualitynumber float required

Minimum body quality for inclusion in a card

ignore_unmatchedboolean required

If enabled, unmatched events won't be saved to the database

license_acceptedboolean required

By setting this option to "true", you indicate that you have read and accepted the FindFace Security license agreement.

face_events_max_matched_ageinteger nullable required

Matched face events older than events_max_age will be removed every night by the cleanup script

face_events_max_unmatched_ageinteger required

Unmatched face events older than events_max_age will be removed every night by the cleanup script

face_events_max_fullframe_matched_ageinteger nullable required

Fullframes from matched face events older than events_max_fullframe_matched_age will be removed every night by the cleanup script

face_events_max_fullframe_unmatched_ageinteger nullable required

Fullframes from unmatched face events older than events_max_fullframe_unmatched_age will be removed every night by the cleanup script

face_cluster_events_max_ageinteger nullable required

Face cluster events older than face_cluster_events_max_age will be removed every night by the cleanup script

face_cluster_events_keep_best_max_ageinteger nullable required

Face cluster events except of best cluster event older than face_cluster_events_max_age will be removed every night by the cleanup script

car_events_max_matched_ageinteger nullable required

Matched car events older than events_max_age will be removed every night by the cleanup script

car_events_max_unmatched_ageinteger required

Unmatched car events older than events_max_age will be removed every night by the cleanup script

car_events_max_fullframe_matched_ageinteger nullable required

Fullframes from matched car events older than events_max_fullframe_matched_age will be removed every night by the cleanup script

car_events_max_fullframe_unmatched_ageinteger nullable required

Fullframes from unmatched car events older than events_max_fullframe_unmatched_age will be removed every night by the cleanup script

car_cluster_events_max_ageinteger nullable required

Car cluster events older than car_cluster_events_max_age will be removed every night by the cleanup script

car_cluster_events_keep_best_max_ageinteger nullable required

Car cluster events except of best cluster event older than car_cluster_events_max_age will be removed every night by the cleanup script

body_events_max_matched_ageinteger nullable required

Matched body events older than events_max_age will be removed every night by the cleanup script

body_events_max_unmatched_ageinteger required

Unmatched body events older than events_max_age will be removed every night by the cleanup script

body_events_max_fullframe_matched_ageinteger nullable required

Fullframes from matched body events older than events_max_fullframe_matched_age will be removed every night by the cleanup script

body_events_max_fullframe_unmatched_ageinteger nullable required

Fullframes from unmatched body events older than events_max_fullframe_unmatched_age will be removed every night by the cleanup script

body_cluster_events_max_ageinteger nullable required

Body cluster events older than body_cluster_events_max_age will be removed every night by the cleanup script

body_cluster_events_keep_best_max_ageinteger nullable required

Body cluster events except of best cluster event older than body_cluster_events_max_age will be removed every night by the cleanup script

face_events_featuresFaceEventsFeaturesEnum[] required

Features to extract when creating face events

body_events_featuresBodyEventsFeaturesEnum[] required

Features to extract when creating body events

car_events_featuresCarEventsFeaturesEnum[] required

Features to extract when creating car events

liveness_thresholdnumber float required

Liveness classifier threshold (if liveness is enabled)

thumbnail_jpeg_qualityinteger required

Thumbnail JPEG quality, default is 75

Changes

No recorded changes to this endpoint across all 1 revision of this API.