Detection Object

One detected object or matched item within a detection result.

Example

{
  "detection_type": "face_recognition",
  "class_name": "person",
  "class_confidence": 98,
  "bounds": {
    "left": 939,
    "top": 305,
    "width": 341,
    "height": 412
  },
  "object_descriptions": [
    {
      "text": "person wearing a hard hat",
      "confidence": 96,
      "over_threshold": true
    }
  ],
  "face": {
    "person_external_id": "person-001",
    "person_display_name": "Alex Carter",
    "confidence": 94,
    "face_quality": 88
  }
}

Fields

Field	Type	Description
detection_type	string	Match type such as class_name, natural_language, face_recognition, or similarity.
class_name	string	Detected object class when available.
class_confidence	number	Confidence score for the class match.
bounds	Bounding Box	Bounding box for the detected object.
image	string	Base64-encoded crop or image for the object when provided.
object_descriptions	Object Description[]	Prompt matches and confidence scores.
face	object	Face recognition match details.
similarity	object	Similarity match details.

face Fields

Field	Type	Description
person_external_id	string	Matched person identifier.
person_display_name	string	Matched person display name.
confidence	number	Face recognition confidence score.
face_quality	number	Face quality score.
group_external_id	string	Matched group identifier when available.
group_display_name	string	Matched group display name when available.

similarity Fields

Field	Type	Description
confidence	number	Similarity confidence score.