Engine

FaceRecognition.Recognize

Perform Face Recognition on a list of Images.

RecognizeFaceRequest

images

array[ImageItem]

feed_id

string

User specified ID to reference the source of the image

custom_id

string

User specified ID used to identify an image. This optional custom ID can be used to map your image request to a result from Engine. Engine does not perform any operations with custom ID, it merely just passes the value directly back in the response. It is up to the client to ensure uniqueness.

group_id

string

User specified GroupID used to identify an image. This is only used by the Face Recognition feature.

data

string

Either encoded or pixel image data

exclusion_zones

array[ExclusionZone]

Zones to ignore on this image (optional)

points

array[Point]

Ordered list of points delimitating this polygon

x	`int32` Position on the X-axis
y	`int32` Position on the Y-axis

persistence

Persistence

RecognizeFaceResponse

results

array[RecognizeFaceImageResult]

feed_id

string

User specified ID to reference the source of the image

image_id

string

ID assigned to the image

group_id

string

ID of the group this image is under

custom_id

string

Arbitrary user specified ID to reference the image

faces

array[RecognizeFaceResult]

face_id

string

ID assigned to the face

identity_id

string

ID of the identity this face is assigned to

name

string

Name given to identity

confidence

float

The confidence for the face

bounding_box

BoundingBox

Bounding box with absolute pixel coordinates

x_min	`int32` Start position of bounding box on the X-axis
y_min	`int32` Start position of bounding box on the Y-axis
x_max	`int32` End position of bounding box on the X-axis
y_max	`int32` End position of bounding box on the Y-axis

normalized_bounding_box

NormalizedBoundingBox

Bounding box with coordinates normalized against the image

x_min	`double` Normalized start position of bounding box on the X-axis
y_min	`double` Normalized start position of bounding box on the Y-axis
x_max	`double` Normalized end position of bounding box on the X-axis
y_max	`double` Normalized end position of bounding box on the Y-axis

sharpness

float

The sharpness of the face

frontal_pose

string

The frontal pose of a face

exclusion_zones

array[ExclusionZone]

points

array[Point]

Ordered list of points delimitating this polygon

x	`int32` Position on the X-axis
y	`int32` Position on the Y-axis