Classification types

This schema defines a set of object classifications and properties.

The diagram above shows the relationships between the different classification types. The Any Object is an abstract illustration representing any of the defined classifications. All classes are not available on all devices.

Bike

A bicycle object.

Property	Type	Required	Note
type	String	Yes	Value: Bike
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence

Bus

A bus object.

Property	Type	Required	Note
type	String	Yes	Value: Bus
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence
license_plate	LicensePlateAttributes	No	License plate attributes
license_plate_id	String	No	UUID reference to the license_plate object
colors	Array of Color	No	Estimated color(s) associated with the object (e.g., body/paint color); values are color classifications

Car

A passenger car object.

Property	Type	Required	Note
type	String	Yes	Value: Car
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence
license_plate	LicensePlateAttributes	No	License plate attributes
license_plate_id	String	No	UUID reference to the license_plate object
colors	Array of Color	No	Estimated color(s) associated with the object (e.g., body/paint color); values are color classifications

Head

A human head object.

Property	Type	Required	Note
type	String	Yes	Value: Head
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence.
face_visible	Float	No	A confidence score in [0.0, 1.0] indicating the likelihood that the face of the head is visible in the image. A value near 1.0 means the face is clearly visible, while a value near 0.0 means the face is not visible or is fully occluded.

Human

A human (person) object.

Property	Type	Required	Note
type	String	Yes	Value: Human
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence
carries_bag	boolean	No	True if the human carry at least one bag
upper_clothing_colors	Array of Color	No	Estimated color(s) of clothing on the upper body (e.g., shirt, jacket)
lower_clothing_colors	Array of Color	No	Estimated color(s) of clothing on the lower body (e.g., pants, skirt)

LicensePlate

A vehicle license plate object.

Property	Type	Required	Note
type	String	Yes	Value: LicensePlate
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence
country_code	String	No	Country/region code for the license plate
plate_number	String	No	The alphanumeric string printed on the license plate (as recognized)
vehicle_id	String	No	UUID reference to the license_plate object

Truck

A truck object.

Property	Type	Required	Note
type	String	Yes	Value: Truck
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence
license_plate	LicensePlateAttributes	No	License plate attributes
license_plate_id	String	No	UUID reference to the license_plate object
colors	Array of Color	No	Estimated color(s) associated with the object (e.g., body/paint color); values are color classifications

Vehicle

A generic vehicle object (motorized or otherwise).

Property	Type	Required	Note
type	String	Yes	Value: Vehicle
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence
license_plate	LicensePlateAttributes	No	License plate attributes
license_plate_id	String	No	UUID reference to the license_plate object

VehicleOther

A vehicle object whose specific type is not part of the other known classifications. It may or may not be motorized.

Property	Type	Required	Note
type	String	Yes	Value: VehicleOther
score	Float	Yes	Confidence score for the classification, normalized to [0,1] where 1 is highest confidence