LiveSearch

Request-body reference for POST /live_search.

Example

{
  "class_name": "person",
  "search_type": "face_recognition",
  "face_match_type": "group",
  "face_group_id": "employees",
  "alert_threshold": 80,
  "stream_list": ["rtsp://camera/live"],
  "duration_seconds": 600,
  "notification": { "include_image": true }
}

Fields

Field	Type	Description
class_name	string	Optional object class filter such as person, vehicle, bag, animal, or unknown.
search_type	string	Search strategy. Common values are class_name, natural_language, face_recognition, and similarity.
object_description	string	Natural-language search text.
face_match_type	string	Face recognition match type such as person, group, or all_faces.
face_person_id	string	Person ID for face search.
face_group_id	string	Group ID for face search.
alert_threshold	number	Required threshold for live-search alerts. Use a value greater than 0 and less than 100.
similarity	Similarity Config	Similarity-search settings.
stream_list	string[]	Optional stream URLs.
duration_seconds	number	Optional search duration in seconds.
notification	Notification	Optional notification settings.

Provide at least one valid search criterion: object_description, face recognition fields such as face_match_type, face_person_id, or face_group_id, or similarity.