Skip to main content

EOILiveSearchInputs

eyesonit-typescript-sdk

eyesonit-typescript-sdk / EOILiveSearchInputs

Class: EOILiveSearchInputs

Request payload for launching a live search operation.

Extends​

Constructors​

Constructor​

new EOILiveSearchInputs(): EOILiveSearchInputs

Returns​

EOILiveSearchInputs

Overrides​

EOISearchInputs.constructor

Properties​

duration_seconds​

duration_seconds: number | undefined

Optional duration (seconds) for the live search. Use undefined for server-default behavior.

notification​

notification: EOINotification | undefined

Optional notification settings (for example phone alerting).

class_name​

class_name: string

Object class to search for. Valid values include: person, face, vehicle, bag, animal, unknown.

Inherited from​

EOISearchInputs.class_name

search_type​

search_type: string | null = null

Search strategy. Supported values: class_name, natural_language, face_recognition, similarity.

Inherited from​

EOISearchInputs.search_type

object_description​

object_description: string

Natural-language query used for object/event matching.

Inherited from​

EOISearchInputs.object_description

face_match_type​

face_match_type: string

Face recognition match type: person or group

Inherited from​

EOISearchInputs.face_match_type

face_person_id​

face_person_id: string

Face recognition person ID for targeted face search.

Inherited from​

EOISearchInputs.face_person_id

face_group_id​

face_group_id: string

Face recognition group ID for targeted face search.

Inherited from​

EOISearchInputs.face_group_id

alert_threshold​

alert_threshold: number

Alert threshold for search confidence. Expected range: greater than 0 and less than 100 for live search.

Inherited from​

EOISearchInputs.alert_threshold

similarity​

similarity: EOISimilarityConfig | undefined = undefined

Similarity matching configuration.

Inherited from​

EOISearchInputs.similarity

stream_list​

stream_list: string[] | undefined

Optional list of stream URLs to constrain search scope.

Inherited from​

EOISearchInputs.stream_list

Methods​

fromJsonObj()​

static fromJsonObj(obj): EOILiveSearchInputs | null

Parameters​

obj​

any

Returns​

EOILiveSearchInputs | null

validate()​

validate(): EOIResponse

Validates this payload against SDK-side constraints.

Returns​

EOIResponse

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

Inherited from​

EOISearchInputs.setBaseProperties