Skip to main content

EOIDetectionConfig

eyesonit-typescript-sdk

eyesonit-typescript-sdk / EOIDetectionConfig

Class: EOIDetectionConfig

Detection behavior for a region. Configure class-based, natural-language, face-recognition, or similarity matching.

Constructors​

Constructor​

new EOIDetectionConfig(init?): EOIDetectionConfig

Parameters​

init?​

Partial<EOIDetectionConfig>

Optional partial initialization object.

Returns​

EOIDetectionConfig

Properties​

class_name?​

optional class_name: string | null

Optional class filter (person, vehicle, bag, animal, unknown).

class_threshold?​

optional class_threshold: number | null = 10

Class confidence threshold used when class_name is set.

use_object_type_detection​

use_object_type_detection: boolean = true

Whether class-name/object-type detection contributes to match results.

use_natural_language​

use_natural_language: boolean = false

Whether natural-language prompt matching is enabled.

use_face_recognition​

use_face_recognition: boolean = false

Whether face-recognition matching is enabled.

use_similarity_detection​

use_similarity_detection: boolean = false

Whether similarity matching is enabled.

object_size?​

optional object_size: number = 100

Minimum object size filter. Minimum is 100 when provided.

combined_threshold?​

optional combined_threshold: number | null = null

Minimum combined threshold for alerting. Default is 50.

min_contour_area?​

optional min_contour_area: number | null = null

Optional contour-area filter for motion/object extraction.

max_bounding_box_area?​

optional max_bounding_box_area: number | null = null

Optional upper bound for bounding-box area.

object_descriptions​

object_descriptions: EOIObjectDescription[]

Natural-language/object prompt list used for matching and alerting.

face_recognition​

face_recognition: EOIFaceRecognitionConfig | undefined = undefined

Face-recognition matching configuration.

similarity​

similarity: EOISimilarityConfig | undefined = undefined

Similarity matching configuration.

conditions?​

optional conditions: EOIDetectionCondition[]

Optional detection conditions such as count and line-cross.

alert_seconds?​

optional alert_seconds: number = 0.1

Seconds detection must persist before alerting. Validator minimum: 0.1.

reset_seconds?​

optional reset_seconds: number = 0.1

Seconds before resetting alert state. Validator minimum: 0.1.

objects?​

optional objects: EOIDetectionObject[]

Optional object-level filters/labels for downstream matching logic.

Methods​

fromJsonObj()​

static fromJsonObj(obj): EOIDetectionConfig

Parameters​

obj​

any

Returns​

EOIDetectionConfig

default()​

static default(): EOIDetectionConfig

Returns​

EOIDetectionConfig