Object model

Sample is JSON-object that represents and stores the result of image processing (a face image, face attributes and/or a corresponding biometric template) used for face recognition.

Profile is an object that contains metadata about a person, person's photo (avatar), activity and the main sample - a biometric template used for detection. The main sample is used by an agent to check for a profile in the database, and by a server - to determine a profile which the new activities should be attached to. In case the sample from the new activity has better quality than the current main sample, the main sample can be replaced by the system.

Profile Group is an object used for profile grouping and receiving notifications. It contains a number of profile IDs, profile group metadata and attached trigger. If the detected activity belongs to a profile from this profile group, the system enables this attached trigger with the condition to create and send a notification.

Activity is an object created when a person is detected by an agent. When a person appears in the frame, agent takes a photo, checks it for quality, identifies the person and collects activity data. After that, agent checks the activity sample and the main samples for the similarity of the biometric template.

Notification is automatically generated when the system receives activity that satisfies the trigger condition. For a certain profile group this condition is as follows: the biometric data of received activity match the biometric data of a profile from this profile group.

Endpoint is an object that contains data about the point where notifications are sent to. To send notifications, you need to attach an endpoint to the trigger.

Trigger is the object needed to create and send a notification to an endpoint if the activity data satisfies the trigger condition. Trigger contains a trigger condition, a set of endpoints, and ID of profile group it is attached to.

Agent is an object that stores information about edge device processing instances.

The object diagram that shows relation between the objects is given below: