Skip to content

Analytics Protocol

nodeflux/analytics/v1beta1/analytic.proto

Analytic

The type of image or video analytic to be performed in the Visionaire Cloud API.

Field Type Label Description
type Analytic.Type The analytic type to be performed.
extension google.protobuf.Any Extension specific data.

Analytic.Type

Type of Visionaire Cloud APIs.

Name Number Description
TYPE_UNSPECIFIED 0 Unspecified feature type.
EXTENSION 1 Reserved for types not defined in the public Cloud API. Used for custom analytics or prototypes.
FACE_DETECTION 2 Run face detection.
FACE_ENROLLMENT 3 Run face enrollment.
FACE_RECOGNITION 4 Run face recognition.
FACE_DEMOGRAPHY 5 Run face demography.
VEHICLE_DETECTION 6 Run vehicle detection.
LICENSE_PLATE_RECOGNITION 7 Run license plate recognition
FACE_MATCH 8 Run 1:1 face match.
PRODUCT_DETECTION 9 Run product detection.
ON_SHELF_AVAILABILITY 10 Run shelf availability.
SHARE_ON_SHELF 11 Run share on shelf.
SHELF_STANDARD 12 Run shelf standard.

nodeflux/analytics/v1beta1/license_plate_recognition.proto

LicensePlateRecognition

License Plate detection analytic result.

Field Type Label Description
bounding_box nodeflux.types.v1beta1.BoundingBox Bounding box around the recognized license plate.
confidence float Confidence of the license plate recognition.
license_plate_number string Character in the recognized license plate.
thumbnail nodeflux.types.v1beta1.Image Cropped image focused on the license plate.

nodeflux/analytics/v1beta1/face_demography.proto

FaceDemography

Field Type Label Description
gender FaceDemography.Gender Detected gender.
gender_confidence float Confidence of the gender detection.
age int32 The estimated age.

FaceDemography.Gender

Gender types.

Name Number Description
UNKNOWN 0
MALE 1
FEMALE 2

nodeflux/analytics/v1beta1/face_detection.proto

FaceDetection

Face detection analytic result.

Field Type Label Description
bounding_box nodeflux.types.v1beta1.BoundingBox Bounding box around the detected face.
confidence float Confidence of the face detection.
thumbnails nodeflux.types.v1beta1.Image repeated Cropped images focused on the detected face.
landmarks nodeflux.types.v1beta1.Landmark repeated Landmark points of the detected face.

nodeflux/analytics/v1beta1/vehicle_detection.proto

VehicleDetection

Vehicle detection analytic result.

Field Type Label Description
type VehicleDetection.VehicleType Detected vehicle
bounding_box nodeflux.types.v1beta1.BoundingBox Bounding box around the detected vehicle.
confidence float Confidence of the vehicle detection.
thumbnails nodeflux.types.v1beta1.Image repeated Cropped images focused on the detected vehicle.

VehicleDetection.VehicleType

Vehicle types.

Name Number Description
UNKNOWN 0
CAR 1
BUS 2
TRUCK 3
MOTORCYCLE 4

nodeflux/analytics/v1beta1/face_recognition.proto

FaceCandidate

Face candidate from the face recognition analytic.

Field Type Label Description
face_id uint64
confidence float Confidence of the recognition. Deprecated: use similarity instead.
auto_enrolled bool If auto_enrolled is true, the face id is enrolled automatically by the current search request.
similarity float Similarity score.
variation uint64 The face variation id of a particular face

FaceRecognition

Face recognition analytic result.

Field Type Label Description
candidates FaceCandidate repeated List of candidates that matches the requested face. If candidates is set, the face recognition analytic has been successful.
face_confidence float Confidence of the face detection.
registered bool True if the candidates are found in the known keyspace.

nodeflux/analytics/v1beta1/face_match.proto

FaceMatch

1:1 Face match analytic result.

Field Type Label Description
similarity float Similarity score between compared embeddings.
match bool A match identifier.

nodeflux/analytics/v1beta1/product_detection.proto

ProductDetection

Product Detection analytic result.

Field Type Label Description
image_visualized nodeflux.types.v1beta1.Image Detected visualized detected products.
products nodeflux.types.v1beta1.Product Repeated detected product.

nodeflux/analytics/v1beta1/shelf_standard.proto

ShelfStandard

Shelf Standard analytic result.

Field Type Label Description
score float Shelf standard score result.

nodeflux/analytics/v1beta1/share_on_shelf.proto

ShareOnShelf

Share On Shelf analytic result.

Field Type Label Description
known_score float Share on Shelf of known product score.
competitor_score float Share on Shelf of competitor product score.

nodeflux/analytics/v1beta1/on_shelf_availability.proto

OnShelfAvailability

On Shelf Availability analytic result.

Field Type Label Description
score float Shelf standard score result.
unavailable_products nodeflux.types.v1beta1.Product repeated Unavailable product in realogram.