@uug-ai/models 1.6.4 → 1.6.7

package/dist/types.d.ts

@@ -16773,6 +16773,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/markerbox": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get MarkerBox (schema generation only)
+         * @description Internal endpoint used only to ensure MarkerBox schema is generated in OpenAPI spec
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["models.MarkerBox"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/markercategory": {
         parameters: {
             query?: never;
@@ -31046,6 +31085,19 @@ export interface components {
              * @example 507f1f77bcf86cd799439011
              */
             id?: string;
+            /**
+             * @description MediaKeys optionally pins this marker to specific recordings by their stable
+             *     key (media.videoFile). When set, the marker writer links the marker to
+             *     exactly these recordings — scoped to the marker's device and organisation —
+             *     instead of inferring the link from timestamp overlap. This is authoritative:
+             *     the producer (e.g. a stage worker) knows precisely which recording a
+             *     detection came from, so it is immune to timing/fps drift. Leave empty to keep
+             *     the default timestamp-overlap association.
+             * @example [
+             *       "1752482068_...device_1920_1080_10000.mp4"
+             *     ]
+             */
+            mediaKeys?: string[];
             /** @description Additional metadata */
             metadata?: components["schemas"]["models.MarkerMetadata"];
             /**
@@ -31078,6 +31130,28 @@ export interface components {
             markerRanges?: components["schemas"]["models.MarkerOptionTimeRange"][];
             tagRanges?: components["schemas"]["models.MarkerTagTimeRange"][];
         };
+        "models.MarkerBox": {
+            /**
+             * @description Box height, fraction of frame height
+             * @example 0.1
+             */
+            height?: number;
+            /**
+             * @description Box width, fraction of frame width
+             * @example 0.2
+             */
+            width?: number;
+            /**
+             * @description Left edge, fraction of frame width
+             * @example 0.12
+             */
+            x?: number;
+            /**
+             * @description Top edge, fraction of frame height
+             * @example 0.34
+             */
+            y?: number;
+        };
         "models.MarkerCategory": {
             /** @example security */
             name?: string;
@@ -31175,8 +31249,48 @@ export interface components {
             startTimestamp?: number;
         };
         "models.MarkerMetadata": {
+            /**
+             * @description BoundingBox is the normalized [0,1] region of the detection within the frame,
+             *     suitable for drawing overlays. Nil when no spatial information is available.
+             */
+            boundingBox?: components["schemas"]["models.MarkerBox"];
             /** @description Additional comments or description of the marker */
             comments?: components["schemas"]["models.Comment"];
+            /**
+             * @description Confidence is the certainty of the detection that produced this marker, in the
+             *     range [0,1] (e.g. an ANPR plate-read or object-detection score). A nil pointer
+             *     means no confidence was reported; this keeps the value optional and lets a
+             *     genuine 0 be distinguished from "unset".
+             * @example 0.92
+             */
+            confidence?: number;
+            /**
+             * @description Engine identifies the concrete backend used within the pipeline
+             *     (e.g. "fast-onnx", "tesseract", "http").
+             * @example fast-onnx
+             */
+            engine?: string;
+            /**
+             * @description ModelVersion records the version of the model that produced the detection,
+             *     so detections can be correlated with model changes after the fact.
+             * @example v1.4.0
+             */
+            modelVersion?: string;
+            /**
+             * @description Raw is an escape hatch for pipeline-specific metadata that does not warrant a
+             *     first-class field. Values here are not indexed or validated; promote anything
+             *     you need to query into a typed field instead.
+             */
+            raw?: {
+                [key: string]: unknown;
+            };
+            /**
+             * @description Source identifies the pipeline that produced this marker (e.g. "anpr",
+             *     "loitering", "dominantcolors"). This is provenance, distinct from the
+             *     user-facing Categories on the marker.
+             * @example anpr
+             */
+            source?: string;
         };
         "models.MarkerOption": {
             categories?: string[];
@@ -32815,7 +32929,7 @@ export interface components {
              *     Storage block used to resolve a per-recording vault override. Copied (and
              *     scrubbed) from the analysis monitor stage — credential/secret fields and the
              *     individual user id never cross the boundary. Wire-only; the persisted scope
-             *     is UserId (which holds the organisation id).
+             *     is OrganisationId.
              */
             user?: components["schemas"]["models.WorkflowUser"];
             /**
@@ -33090,6 +33204,7 @@ export declare namespace models {
     type Location = components['schemas']['models.Location'];
     type Marker = components['schemas']['models.Marker'];
     type MarkerAtRuntimeMetadata = components['schemas']['models.MarkerAtRuntimeMetadata'];
+    type MarkerBox = components['schemas']['models.MarkerBox'];
     type MarkerCategory = components['schemas']['models.MarkerCategory'];
     type MarkerCategoryOption = components['schemas']['models.MarkerCategoryOption'];
     type MarkerEvent = components['schemas']['models.MarkerEvent'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uug-ai/models",
-  "version": "1.6.4",
+  "version": "1.6.7",
   "description": "TypeScript type definitions for Go models",
   "main": "dist/types.js",
   "types": "dist/types.d.ts",