EOISearchInputs
eyesonit-typescript-sdk / EOISearchInputs
Class: EOISearchInputs
Base search criteria shared by live and archive search requests.
Extended by
Constructors
Constructor
new EOISearchInputs():
EOISearchInputs
Returns
EOISearchInputs
Properties
class_name
class_name:
string
Object class to search for.
Valid values include: person, face, vehicle, bag, animal, unknown.
search_type
search_type:
string|null=null
Search strategy.
Supported values: class_name, natural_language, face_recognition, similarity.
object_description
object_description:
string
Natural-language query used for object/event matching.
face_match_type
face_match_type:
string
Face recognition match type: person or group
face_person_id
face_person_id:
string
Face recognition person ID for targeted face search.
face_group_id
face_group_id:
string
Face recognition group ID for targeted face search.
alert_threshold
alert_threshold:
number
Alert threshold for search confidence.
Expected range: greater than 0 and less than 100 for live search.
similarity
similarity:
EOISimilarityConfig|undefined=undefined
Similarity matching configuration.
stream_list
stream_list:
string[] |undefined
Optional list of stream URLs to constrain search scope.
Methods
setBaseProperties()
setBaseProperties(
obj):void
Copies shared search properties from a plain object.
Used by fromJsonObj helper methods in derived classes.
Parameters
obj
any
Returns
void