Skip to main content

Object Description

A natural-language prompt used to describe what EyesOnIt should match.

Example

{
"text": "person carrying a red bag",
"background_prompt": false,
"alert": true,
"threshold": 90,
"display_text": "Suspicious Bag",
"confidence": 93,
"over_threshold": true
}

Fields

FieldTypeDescription
textstringPrompt text used for matching.
background_promptbooleanMarks a context prompt that should not alert on its own.
alertbooleanWhen true, this prompt can trigger alerts.
thresholdnumberConfidence threshold for this prompt.
display_textstringOptional label shown in outputs.
confidencenumberConfidence returned in response payloads.
over_thresholdbooleanWhether the returned confidence met the threshold.