From 83c3e38bbaf48848745f81bfe26d09a5d9367eeb Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 17 Sep 2024 18:23:30 +0000 Subject: [PATCH] v1.5.12 --- RELEASE.md | 4 + VERSION | 2 +- .../ALPRDemo/docker-compose.yml | 2 +- docs/schemas/anypipe/anypipe.html | 5523 ++++++++++++++++- 4 files changed, 5528 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index e9c1027..c3a90e4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,5 +1,9 @@ # Release Notes +## v1.5.12 + +- ALPRDemo increase docker compose compatibility + ## v1.5.11 - Add ALPRDemo to deployment-examples diff --git a/VERSION b/VERSION index bbb1b25..008350c 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v1.5.11 +v1.5.12 diff --git a/deployment-examples/ALPRDemo/docker-compose.yml b/deployment-examples/ALPRDemo/docker-compose.yml index 26c56ce..e858c02 100644 --- a/deployment-examples/ALPRDemo/docker-compose.yml +++ b/deployment-examples/ALPRDemo/docker-compose.yml @@ -1,4 +1,4 @@ -version: "3" +version: "2.3" services: # ========================= RTSP Server providing demo videos ========================= diff --git a/docs/schemas/anypipe/anypipe.html b/docs/schemas/anypipe/anypipe.html index 8229510..2db41e4 100644 --- a/docs/schemas/anypipe/anypipe.html +++ b/docs/schemas/anypipe/anypipe.html @@ -1 +1,5522 @@ - Sighthound Analytics

Sighthound Analytics

Type: object

Analytics data sent by the Sighthound video/image analysis pipeline. This data is sent based on configuration when the number of detected objects or attributes of detected objects changes, the confidence of detected objects or their attributes improves, or a configurable timeout occurs.

 No Additional Properties

root apiVersion
Type: object

root analyticsTimestamp
Type: integer

Timestamp the frame corresponding to this analytics data was processed at, in milliseconds since the epoch and GMT timezone.

Value must be greater or equal to 0

root sourceId
Type: string

A global unique ID representing the media source, for
instance a specific video stream from a camera sensor or RTSP feed, , or input source location for images or videos

root frameId
Type: string

An ID corresponding to this frame, which may be used to
access the image corresponding to all box coordinates and object
detections represented in this object, via the Media Service API.

root frameDimensions
Type: object

The dimensions (width and height) of the frame represented by frameId. Also used as the coordinate base for all bounding box coordinates.

root frameDimensions w
Type: number

Width in pixels

Value must be greater or equal to 0

root frameDimensions h
Type: number

Height in pixels

Value must be greater or equal to 0

root frameTimestamp
Type: integer

Timestamp of the frame corresponding to this analytics data, acccording to the source, in milliseconds since the epoch and GMT timezone.

Value must be greater or equal to 0

root frameSource
Type: string

root metaClasses
Type: object

Meta classes include objects such as vehicles, license plates, and people. These are high-level classifications.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root metaClasses ^.*$
Type: object

An plural MetaClass name. Supported MetaClasses
include:
vehicles - Objects including cars, buses, trucks, motorbikes.
Vehicles include objects which may potentially include license
plates, may include links to licensePlates.
licensePlates - Objects which are detected/classified as license plates.
people - Pedestrians or people riding skateboards, electric
scooter, wheelchairs,etc.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root metaClasses ^.*$ ^.*$
Type: object

A Unique ID representing this object, used to map
additional object properties. This ID is guaranteed unique
for each object, regardless of streamId. It will change the object drops out of
detection/tracking

root metaClasses ^.*$ ^.*$ bestDetectionTimestamp
Type: integer

The analyticsTimestamp with highest confidence score for this object.

Value must be greater or equal to 0

root metaClasses ^.*$ ^.*$ class
Type: string

Object specific class returned by the model. For objects of the vehicles metaclass this may include car, truck, bus, motorbike, etc based on model capabilities

root metaClasses ^.*$ ^.*$ attributes
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root metaClasses ^.*$ ^.*$ attributes ^.*$
Type: object

A map of attributes for this object. Not all atributes are supported for all object types. Example attributes include:
color - The color of an object
lpString - A string representing license plate text
and numbers
lpRegion - A string representing license plate region
vehicleType - Make model and generation of the vehicle in a single string

No Additional Properties

root metaClasses ^.*$ ^.*$ attributes ^.*$ attributeScore
Type: number

Confidence score for attribute detection, ranging from 0.0 to 1.0. A score of 1.0 indicates 100% confidence.

Value must be greater or equal to 0 and lesser or equal to 1

root metaClasses ^.*$ ^.*$ attributes ^.*$ detectionScore
Type: number

Confidence score for object detection, ranging from 0.0 to 1.0. A score of 1.0 indicates 100% confidence.When included in an attribute, this score represents the
object Detection score for the parent object corresponding to the
timestamp when the attribute value was determined.

Value must be greater or equal to 0 and lesser or equal to 1

root metaClasses ^.*$ ^.*$ attributes ^.*$ updated
Type: boolean

Flag to indicate if the attribute is updated. True means updated, False means not updated.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value

A value of the attribute. The value is specific to the attribute type.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf vehicle
Type: object

Information about the detected vehicle, including its make, model, and generation.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf item 0 make
Type: string

The manufacturer of the detected vehicle, e.g., 'Toyota'.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf item 0 model
Type: string

The specific model of the detected vehicle, e.g., 'Camry'.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf item 0 generation
Type: string

The generation or variant of the detected vehicle, e.g., '2020'.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf item 0 type
Type: string

The category to which the detected vehicle belongs, e.g., 'Sedan'.

Additional Properties of any type are allowed.

root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf item 0 additionalProperties
Type: object
root metaClasses ^.*$ ^.*$ attributes ^.*$ value oneOf item 1
Type: string

root metaClasses ^.*$ ^.*$ attributes ^.*$ debug
Type: object

Debug information, subject to change
between releases. Do not use this object in an
application.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root metaClasses ^.*$ ^.*$ attributes ^.*$ debug ^.*$
Type: string

root metaClasses ^.*$ ^.*$ hash
Type: string

An object hash which uniquely identifies this object and associated attributes. Will change when attributes change. Reserved for future use

root metaClasses ^.*$ ^.*$ box
Type: object

The bounding box containing this object, in
pixel coordinates where the top left corner of the
image is represented by pixel 0,0, corresponding to the image referenced by imageRef

No Additional Properties

root metaClasses ^.*$ ^.*$ box height
Type: integer

Height of the bounding box in pixels

Value must be greater or equal to 0

root metaClasses ^.*$ ^.*$ box width
Type: integer

Width of the bounding box in pixels

Value must be greater or equal to 0

root metaClasses ^.*$ ^.*$ box x
Type: integer

X coordinate of the top left corner
of the bounding box.

Value must be greater or equal to 0

root metaClasses ^.*$ ^.*$ box y
Type: integer

Y coordinate of the top left corner of
the bounding box

Value must be greater or equal to 0

root metaClasses ^.*$ ^.*$ detectionScore
Type: number

Confidence score for object detection, ranging from 0.0 to 1.0. A score of 1.0 indicates 100% confidence.When included in an attribute, this score represents the
object Detection score for the parent object corresponding to the
timestamp when the attribute value was determined.

Same definition as detectionScore

root metaClasses ^.*$ ^.*$ updated
Type: boolean

Flag to indicate if the attribute is updated. True means updated, False means not updated.

Same definition as updated

root metaClasses ^.*$ ^.*$ firstFrameTimestamp
Type: integer

The analyticsTimestamp with highest confidence score for this object.

Value must be greater or equal to 0

root sensorEvents
Type: object

A map of maps describing an event type.
- The top level map key is a name describing the event type. Supported types are presenceSensor, lineCrossingEvent, speedEvent.
- The sub level map key is a Unique ID representing the event, used to map
additional object properties. This ID is guaranteed unique
for each event for a given stream ID.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root sensorEvents ^.*$
Type: object

A name describing an event type.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root sensorEvents ^.*$ ^.*$
Type: array

A Unique ID representing this event

 No Additional Items

Each item of this array must be:

root sensorEvents ^.*$ ^.*$ ^.*$ items

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf presenceSensor
Type: object

Describes an event where one or more objects are present in a region of interest.
The event starts when the first object enters a region of interest. Updates are sent for each change in status, with updateCount incremented for each update. When the last object exits and the region is empty, the sensor event will become immutable and will track the total amount of time at least one object was present in the region of interest. An entry of an object will start a new event and reset the updateCount to 1. Region definitons, object filtering and other items related to sensor definitions are tracked as a part of the sensorId associated with the event.

No Additional Properties

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 eventId
Type: string

The globally unique event ID corresponding to this event.

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 objectsInRegionCount
Type: integer

The total number of objects of a specific type detected within a region of interest, excluding those filtered out based on sensor configuration.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 objectsCountbyMetaClass
Type: object

The total number of detected objects in a region grouped by metaclasses.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 objectsCountbyMetaClass ^.*$
Type: integer

The total number of objects detected within a region of interest grouped by metaclass. Metaclasses represent higher-level categories that objects may belong to, such as 'vehicle' or 'people,' while classes represent more specific types, such as 'car' or 'person'.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 objectsCountbyClass
Type: object

The total number of detected objects in a region grouped by classes.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*$
root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 objectsCountbyClass ^.*$
Type: integer

The total number of objects detected within a region of interest grouped by class. For example, if the sensor is configured to detect vehicles, this property may include counts of 'car,' 'bus,' and 'truck'.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 startedAt
Type: integer

The time in milliseconds since the epoch (GMT) when the event started, or when a link was established.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 updateCount
Type: integer

The cumulative number of updates sent for this sensor, starting with 1 for the initial update and incremented once for each update sent for each unique sensor event ID. An update refers to a change in the state of the sensor due to a corresponding sensor event (entry, exit, crossing, ...). For sensors which include multiple updates per sensor event (presense sensors), the updateCount will be reset to 1 to indicate the first update for a given event. For sensors (count) which only include 1 update per event, updateCount will be cumulative and count the total number of events per sensor.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 0 endedAt
Type: integer

The time in milliseconds since the epoch (GMT) when the event ended.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf countSensor
Type: object

Describes an event where one object crosses a line

 No Additional Properties

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 1 eventId
Type: string

The globally unique event ID corresponding to this event.

Same definition as eventId

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 1 direction
Type: string

The direction of an object's trajectory relative to the sensor's line, with the first point (A) as the pivot point. 'Clockwise' means the object is moving in a clockwise direction relative to the line, while 'counterclockwise' means the object is moving in a counterclockwise direction.

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 1 cwCount
Type: integer

Number of clockwise crossings.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 1 ccwCount
Type: integer

Number of counterclockwise crossings.

Value must be greater or equal to 0

root sensorEvents ^.*$ ^.*$ ^.*$ items oneOf item 1 startedAt
Type: integer

The time in milliseconds since the epoch (GMT) when the event started, or when a link was established.

Same definition as startedAt

root mediaEvents
Type: array of object
No Additional Items

Each item of this array must be:

root mediaEvents mediaEvents items
Type: object

root mediaEvents mediaEvents items type
Type: string

Media Event type: Ex: image,video

root mediaEvents mediaEvents items msg
Type: string

Message content

root mediaEvents mediaEvents items startTs
Type: integer

Start of Event Timestamp

Value must be greater or equal to 0

root mediaEvents mediaEvents items endTs
Type: integer

End of Event Timestamp

Value must be greater or equal to 0

root mediaEvents mediaEvents items format
Type: string

Message format. Ex: json, jpeg, mp4, ts...
\ No newline at end of file + + + + + + + + + + + + + Sighthound Analytics + + + +
+
+

+ Sighthound Analytics +

+ + Type: object + +
+ +

+ Analytics data sent by the Sighthound video/image analysis pipeline. This data is sent based on configuration when the number of detected objects or attributes of detected objects changes, the confidence of detected objects or their attributes improves, or a configurable timeout occurs. +

+ + + No Additional Properties + +
+
+
+

+ +

+
+
+
+
+ root + + + + + + apiVersion + +
+ + Type: object + +
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + analyticsTimestamp + +
+ + Type: integer + +
+ +

+ Timestamp the frame corresponding to this analytics data was processed at, in milliseconds since the epoch and GMT timezone. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sourceId + +
+ + Type: string + +
+ +

+ A global unique ID representing the media source, for +
+ instance a specific video stream from a camera sensor or RTSP feed, , or input source location for images or videos +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + frameId + +
+ + Type: string + +
+ +

+ An ID corresponding to this frame, which may be used to +
+ access the image corresponding to all box coordinates and object +
+ detections represented in this object, via the Media Service API. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + frameDimensions + +
+ + Type: object + +
+ +

+ The dimensions (width and height) of the frame represented by frameId. Also used as the coordinate base for all bounding box coordinates. +

+ +
+
+
+

+ +

+
+
+
+
+ root + + + + + + frameDimensions + + + + + + + w + +
+ + Type: number + +
+ +

+ Width in pixels +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + frameDimensions + + + + + + + h + +
+ + Type: number + +
+ +

+ Height in pixels +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + frameTimestamp + +
+ + Type: integer + +
+ +

+ Timestamp of the frame corresponding to this analytics data, acccording to the source, in milliseconds since the epoch and GMT timezone. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + frameSource + +
+ + Type: string + +
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + +
+ + Type: object + +
+ +

+ Meta classes include objects such as vehicles, license plates, and people. These are high-level classifications. +

+ +
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + +
+ + Type: object + +
+
+

+ An plural MetaClass name. Supported MetaClasses +
+ include: +
+ vehicles - Objects including cars, buses, trucks, motorbikes. +
+ Vehicles include objects which may potentially include license +
+ plates, may include links to licensePlates. +
+ licensePlates - Objects which are detected/classified as license plates. +
+ people - Pedestrians or people riding skateboards, electric +
+ scooter, wheelchairs,etc. +

+
+
+ +
+
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + +
+ + Type: object + +
+ +

+ A Unique ID representing this object, used to map +
+ additional object properties. This ID is guaranteed unique +
+ for each object, regardless of streamId. It will change the object drops out of +
+ detection/tracking +

+ +
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + bestDetectionTimestamp + +
+ + Type: integer + +
+ +

+ The analyticsTimestamp with highest confidence score for this object. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + class + +
+ + Type: string + +
+ +

+ Object specific class returned by the model. For objects of the vehicles metaclass this may include car, truck, bus, motorbike, etc based on model capabilities +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + additionalProperties + +
+ + Type: object + +
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + +
+ + Type: object + +
+
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + +
+ + Type: object + +
+
+

+ A map of attributes for this object. Not all atributes are supported for all object types. Example attributes include: +
+ color - The color of an object +
+ lpString - A string representing license plate text +
+ and numbers +
+ lpRegion - A string representing license plate region +
+ vehicleType - Make model and generation of the vehicle in a single string +

+
+
+ +
+ + No Additional Properties + +
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + attributeScore + +
+ + Type: number + +
+ +

+ Confidence score for attribute detection, ranging from 0.0 to 1.0. A score of 1.0 indicates 100% confidence. +

+ +

+ + Value must be greater or equal to + + 0 + + and lesser or equal to + + 1 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + detectionScore + +
+ + Type: number + +
+ +

+ Confidence score for object detection, ranging from 0.0 to 1.0. A score of 1.0 indicates 100% confidence.When included in an attribute, this score represents the +
+ object Detection score for the parent object corresponding to the +
+ timestamp when the attribute value was determined. +

+ +

+ + Value must be greater or equal to + + 0 + + and lesser or equal to + + 1 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + updated + +
+ + Type: boolean + +
+ +

+ Flag to indicate if the attribute is updated. True means updated, False means not updated. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + +
+
+ +

+ A value of the attribute. The value is specific to the attribute type. +

+ +
+

+ +

+ +
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + vehicle + +
+ + Type: object + +
+ +

+ Information about the detected vehicle, including its make, model, and generation. +

+ +
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + item 0 + + + + + + + make + +
+ + Type: string + +
+ +

+ The manufacturer of the detected vehicle, e.g., 'Toyota'. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + item 0 + + + + + + + model + +
+ + Type: string + +
+ +

+ The specific model of the detected vehicle, e.g., 'Camry'. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + item 0 + + + + + + + generation + +
+ + Type: string + +
+ +

+ The generation or variant of the detected vehicle, e.g., '2020'. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + item 0 + + + + + + + type + +
+ + Type: string + +
+ +

+ The category to which the detected vehicle belongs, e.g., 'Sedan'. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+

+ Additional Properties of any type are allowed. +

+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + item 0 + + + + + + + additionalProperties + +
+ + Type: object + +
+
+
+
+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + value + + + + + + + oneOf + + + + + + + item 1 + +
+ + Type: string + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + debug + +
+ + Type: object + +
+ +

+ Debug information, subject to change +
+ between releases. Do not use this object in an +
+ application. +

+ +
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + attributes + + + + + + + ^.*$ + + + + + + + debug + + + + + + + ^.*$ + +
+ + Type: string + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + hash + +
+ + Type: string + +
+ +

+ An object hash which uniquely identifies this object and associated attributes. Will change when attributes change. Reserved for future use +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + box + +
+ + Type: object + +
+ +

+ The bounding box containing this object, in +
+ pixel coordinates where the top left corner of the +
+ image is represented by pixel 0,0, corresponding to the image referenced by imageRef +

+ + + No Additional Properties + +
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + box + + + + + + + height + +
+ + Type: integer + +
+ +

+ Height of the bounding box in pixels +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + box + + + + + + + width + +
+ + Type: integer + +
+ +

+ Width of the bounding box in pixels +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + box + + + + + + + x + +
+ + Type: integer + +
+ +

+ X coordinate of the top left corner +
+ of the bounding box. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + box + + + + + + + y + +
+ + Type: integer + +
+ +

+ Y coordinate of the top left corner of +
+ the bounding box +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + detectionScore + +
+ + Type: number + +
+ +

+ Confidence score for object detection, ranging from 0.0 to 1.0. A score of 1.0 indicates 100% confidence.When included in an attribute, this score represents the +
+ object Detection score for the parent object corresponding to the +
+ timestamp when the attribute value was determined. +

+ + + Same definition as detectionScore + +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + updated + +
+ + Type: boolean + +
+ +

+ Flag to indicate if the attribute is updated. True means updated, False means not updated. +

+ + + Same definition as updated + +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + metaClasses + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + firstFrameTimestamp + +
+ + Type: integer + +
+ +

+ The analyticsTimestamp with highest confidence score for this object. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + +
+ + Type: object + +
+
+

+ A map of maps describing an event type. +
+ - The top level map key is a name describing the event type. Supported types are presenceSensor, lineCrossingEvent, speedEvent. +
+ - The sub level map key is a Unique ID representing the event, used to map +
+ additional object properties. This ID is guaranteed unique +
+ for each event for a given stream ID. +

+
+
+ +
+
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + +
+ + Type: object + +
+ +

+ A name describing an event type. +

+ +
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + +
+ + Type: array + +
+ +

+ A Unique ID representing this event +

+ + + No Additional Items + +

+ Each item of this array must be: +

+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + +
+
+
+

+ +

+ +
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + presenceSensor + +
+ + Type: object + +
+
+

+ Describes an event where one or more objects are present in a region of interest. +
+ The event starts when the first object enters a region of interest. Updates are sent for each change in status, with updateCount incremented for each update. When the last object exits and the region is empty, the sensor event will become immutable and will track the total amount of time at least one object was present in the region of interest. An entry of an object will start a new event and reset the updateCount to 1. Region definitons, object filtering and other items related to sensor definitions are tracked as a part of the sensorId associated with the event. +

+
+
+ +
+ + No Additional Properties + +
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + eventId + +
+ + Type: string + +
+ +

+ The globally unique event ID corresponding to this event. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + objectsInRegionCount + +
+ + Type: integer + +
+ +

+ The total number of objects of a specific type detected within a region of interest, excluding those filtered out based on sensor configuration. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + objectsCountbyMetaClass + +
+ + Type: object + +
+ +

+ The total number of detected objects in a region grouped by metaclasses. +

+ +
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + objectsCountbyMetaClass + + + + + + + ^.*$ + +
+ + Type: integer + +
+ +

+ The total number of objects detected within a region of interest grouped by metaclass. Metaclasses represent higher-level categories that objects may belong to, such as 'vehicle' or 'people,' while classes represent more specific types, such as 'car' or 'person'. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + objectsCountbyClass + +
+ + Type: object + +
+ +

+ The total number of detected objects in a region grouped by classes. +

+ +
+
+
+

+ +

+
+
+
+

+ +

+

+ All properties whose name matches the following regular expression must respect the following conditions +

+ + Property name regular expression: + + ^.*$ + + +
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + objectsCountbyClass + + + + + + + ^.*$ + +
+ + Type: integer + +
+ +

+ The total number of objects detected within a region of interest grouped by class. For example, if the sensor is configured to detect vehicles, this property may include counts of 'car,' 'bus,' and 'truck'. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + startedAt + +
+ + Type: integer + +
+ +

+ The time in milliseconds since the epoch (GMT) when the event started, or when a link was established. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + updateCount + +
+ + Type: integer + +
+
+

+ The cumulative number of updates sent for this sensor, starting with 1 for the initial update and incremented once for each update sent for each unique sensor event ID. An update refers to a change in the state of the sensor due to a corresponding sensor event (entry, exit, crossing, ...). For sensors which include multiple updates per sensor event (presense sensors), the updateCount will be reset to 1 to indicate the first update for a given event. For sensors (count) which only include 1 update per event, updateCount will be cumulative and count the total number of events per sensor. +

+
+
+ +
+

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 0 + + + + + + + endedAt + +
+ + Type: integer + +
+ +

+ The time in milliseconds since the epoch (GMT) when the event ended. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+ +
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + countSensor + +
+ + Type: object + +
+ +

+ Describes an event where one object crosses a line +

+ + + No Additional Properties + +
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 1 + + + + + + + eventId + +
+ + Type: string + +
+ +

+ The globally unique event ID corresponding to this event. +

+ + + Same definition as eventId + +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 1 + + + + + + + direction + +
+ + Type: string + +
+ +

+ The direction of an object's trajectory relative to the sensor's line, with the first point (A) as the pivot point. 'Clockwise' means the object is moving in a clockwise direction relative to the line, while 'counterclockwise' means the object is moving in a counterclockwise direction. +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 1 + + + + + + + cwCount + +
+ + Type: integer + +
+ +

+ Number of clockwise crossings. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 1 + + + + + + + ccwCount + +
+ + Type: integer + +
+ +

+ Number of counterclockwise crossings. +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + sensorEvents + + + + + + + ^.*$ + + + + + + + ^.*$ + + + + + + + ^.*$ items + + + + + + + oneOf + + + + + + + item 1 + + + + + + + startedAt + +
+ + Type: integer + +
+ +

+ The time in milliseconds since the epoch (GMT) when the event started, or when a link was established. +

+ + + Same definition as startedAt + +
+
+
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+

+ +

+
+
+
+
+ root + + + + + + mediaEvents + +
+ + Type: array of object + +
+ + No Additional Items + +

+ Each item of this array must be: +

+
+
+
+ root + + + + + + mediaEvents + + + + + + + mediaEvents items + +
+ + Type: object + +
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + mediaEvents + + + + + + + mediaEvents items + + + + + + + type + +
+ + Type: string + +
+ +

+ Media Event type: Ex: image,video +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + mediaEvents + + + + + + + mediaEvents items + + + + + + + msg + +
+ + Type: string + +
+ +

+ Message content +

+ +
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + mediaEvents + + + + + + + mediaEvents items + + + + + + + startTs + +
+ + Type: integer + +
+ +

+ Start of Event Timestamp +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + mediaEvents + + + + + + + mediaEvents items + + + + + + + endTs + +
+ + Type: integer + +
+ +

+ End of Event Timestamp +

+ +

+ + Value must be greater or equal to + + 0 + + +

+
+
+
+
+
+
+
+

+ +

+
+
+
+
+ root + + + + + + mediaEvents + + + + + + + mediaEvents items + + + + + + + format + +
+ + Type: string + +
+ +

+ Message format. Ex: json, jpeg, mp4, ts... +

+ +
+
+
+
+
+
+
+
+
+
+ + +