Skip to main content

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

FieldTypeDescription
class_namestringOptional class filter.
search_typestringSearch strategy.
object_descriptionstringNatural-language search text.
face_match_typestringFace recognition match type.
face_person_idstringPerson ID for face search.
face_group_idstringGroup ID for face search.
alert_thresholdnumberThreshold for live-search alerts.
similaritySimilarity ConfigSimilarity-search settings.
stream_liststring[]Optional stream URLs.
duration_secondsnumberOptional search duration in seconds.
notificationNotificationOptional notification settings.