Skip to main content

Object Description

Reference for the Object Description JSON element.

See also: Object Description

Example

{
"text": "person carrying a red bag",
"background_prompt": false,
"alert": true,
"threshold": 90
}

Fields

FieldTypeDescription
textstringPrompt text used for matching.
background_promptbooleanContext prompt that should not alert on its own.
alertbooleanWhether this prompt can trigger alerts.
thresholdnumberConfidence threshold for this prompt.
display_textstringOptional label shown in outputs.
confidencenumberConfidence returned in responses.
over_thresholdbooleanWhether the confidence met the threshold.