Skip to main content

Prompt

The JSON Prompt element encapsulates object description details that are provided as input to EyesOnIt as well as detection status that is provided as output by EyesOnIt.

Example

"prompts": [
{
"text": "vehicle",
"threshold": 90,
"background_prompt": false,
"confidence": 95,
"over_threshold": true
},
{
"text": "driveway",
"background_prompt": true
}
]

Input Attributes

NameTypeDescription
textstringthe text of the object description
thresholdnumberoptional. 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.
background_descriptionbooleantrue if this is the background description for the stream, false otherwise

Ouput Attributes

These attributes are provided by EyesOnIt as output in response to certain status request endpoints.

NameTypeDescription
confidencenumberthe reported confidence level for this object description. An integer between 0 and 99.
over_thresholdbooleantrue if the confidence level is above the threshold for this object description, false otherwise.