ObjectDetectionTool interface

Object detection tool configuration.

Signature:

export interface ObjectDetectionTool

Properties

Property	Type	Description
aggregation?	AggregationStrategy	(Optional)
bucketSecs?	number	(Optional)
confidenceThreshold?	number	(Optional)
gate?	Gate	(Optional) Only run this tool while the gate holds (see Gate).
id?	string	(Optional) Instance id (G3): names this instance so gates can reference it and the same tool may appear more than once. Default: the tool name. Must be unique across localAnalysis.
inferEveryMs?	number	(Optional) Minimum media-time between inferences in ms (framerate-invariant). Default 500. Explicit 0 = every frame.
labels?	string[]	(Optional) Class labels for a customer model, index-aligned with its class dimension. Default COCO-80.
model?	"rt-detr" \| "yolo"	(Optional) "rt-detr" (default): the shipped Apache-2.0 RT-DETR. "yolo": a customer-supplied YOLO export — v8-family raw head (NMS runs server-side) or v10 end-to-end, detected from the output shape. YOLO weights are never distributed with Norsk.
modelFile?	string	(Optional) Server-side path to the customer’s YOLO .onnx. Required when model is "yolo"; validated (parse + existence) at configuration.
sampleN?	number	(Optional)
tool	"object_detection"
windowSecs	number

Property

Type

Description

aggregation?

AggregationStrategy

(Optional)

bucketSecs?

number

(Optional)

confidenceThreshold?

number

(Optional)

gate?

Gate

(Optional) Only run this tool while the gate holds (see Gate).

id?

string

(Optional) Instance id (G3): names this instance so gates can reference it and the same tool may appear more than once. Default: the tool name. Must be unique across localAnalysis.

inferEveryMs?

number

(Optional) Minimum media-time between inferences in ms (framerate-invariant). Default 500. Explicit 0 = every frame.

labels?

string[]

(Optional) Class labels for a customer model, index-aligned with its class dimension. Default COCO-80.

model?

"rt-detr" | "yolo"

(Optional) "rt-detr" (default): the shipped Apache-2.0 RT-DETR. "yolo": a customer-supplied YOLO export — v8-family raw head (NMS runs server-side) or v10 end-to-end, detected from the output shape. YOLO weights are never distributed with Norsk.

modelFile?

string

(Optional) Server-side path to the customer’s YOLO .onnx. Required when model is "yolo"; validated (parse + existence) at configuration.

sampleN?

number

(Optional)

tool

"object_detection"

windowSecs

number