Object Description

Encapsulates object description details that are provided as part of detection configuration inputs to EyesOnIt.

Example

{
	"regions": [
		{
			"enabled": true,
			"name": "Front Street",
			"polygon": [...],
			"motion_detection": {...},
			"detection_configs": [
				{
					"class_name": "vehicle",
					"class_threshold": 10,
					"object_size": 350,
					"object_descriptions": [
						{
							"text": "black sedan",
							"threshold": 90,
							"alert": true,
							"background_prompt": false
						},
						{
							"text": "street building",
							"threshold": null,
							"alert": false,
							"background_prompt": true
						}
					],
					"conditions": [
						{
							"type": "count_greater_than",
							"count": 0
						}
					],
					"alert_seconds": 1.0,
					"reset_seconds": 5.0
				}
			]
		}
	]
}

Input Attributes

Name	Type	Description
text	string	the text of the object description
threshold	number	optional. The alerting threshold for the object description. Should be defined for object descriptions that will trigger alerts. If provided, should be an integer between 1 and 99. If background_description is true, the threshold value should null.
background_description	boolean	true if this object description is the background description for the detection configuration, false otherwise
alert	boolean	true if this object description should generate alerts. false otherwise.