@eyepop.ai/eyepop 3.6.1 → 3.7.0

package/dist/eyepop.index.d.mts

@@ -18,13 +18,46 @@ interface Box {
     readonly bottomRight: Point2d;
 }
 interface StreamTime {
+    /**
+     * Temporal offset of prediction from start of the media (video or audio) in nano seconds.
+     */
     timestamp?: number;
+    /**
+     * Convenience, same vale as 'timestamp' just in seconds.
+     */
     seconds?: number;
+    /**
+     * Temporal length of the chunk that was the source for this prediction in nano seconds.
+     */
+    duration?: number;
+    /**
+     * Real time when the media was captured as epoch timestamp in nano seconds.
+     *
+     * Only provided if source provides this timestamp e.g. as timestamp/x-ntp in RTSP.
+     */
+    captured_at?: number;
+    /**
+     * A media specific offset.
+     *
+     * For video frames, this is the frame number of prediction.
+     * For audio samples, this is the offset of the first sample for this prediction.
+     */
     offset?: number;
+    /**
+     * Offset length of the chunk used for this prediction.
+     *
+     * It has the same format as offset.
+     */
+    offset_duration?: number;
 }
 interface Prediction extends StreamTime {
-    captured_at?: number;
+    /**
+     * The width of the source coordinate system for all prediction coordinates.
+     */
     source_width: number;
+    /**
+     * The height of the source coordinate system for all prediction coordinates.
+     */
     source_height: number;
     source_id?: string;
     objects?: Array<PredictedObject>;
@@ -576,7 +609,7 @@ interface Annotation {
     auto_annotate?: string;
     auto_annotate_params?: AutoAnnotateParams;
     uncertainty_score?: number;
-    annotation: Prediction;
+    predictions: Prediction[];
 }
 declare enum TranscodeMode {
     original = "original",
@@ -821,7 +854,7 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     getAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, include_annotations?: boolean, top_k?: number): Promise<Asset>;
     deleteAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number): Promise<void>;
     resurrectAsset(asset_uuid: string, dataset_uuid: string, from_dataset_version: number, into_dataset_version?: number): Promise<void>;
-    updateAssetGroundTruth(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, prediction?: Prediction): Promise<void>;
+    updateAssetGroundTruth(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, predictions?: Prediction[]): Promise<void>;
     deleteAssetGroundTruth(asset_uuid: string, dataset_uuid?: string, dataset_version?: number): Promise<void>;
     updateAutoAnnotationStatus(asset_uuid: string, auto_annotate: string, user_review: UserReview, approved_threshold?: number): Promise<void>;
     downloadAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, transcode_mode?: TranscodeMode): Promise<Blob>;

package/dist/eyepop.index.d.ts

@@ -18,13 +18,46 @@ interface Box {
     readonly bottomRight: Point2d;
 }
 interface StreamTime {
+    /**
+     * Temporal offset of prediction from start of the media (video or audio) in nano seconds.
+     */
     timestamp?: number;
+    /**
+     * Convenience, same vale as 'timestamp' just in seconds.
+     */
     seconds?: number;
+    /**
+     * Temporal length of the chunk that was the source for this prediction in nano seconds.
+     */
+    duration?: number;
+    /**
+     * Real time when the media was captured as epoch timestamp in nano seconds.
+     *
+     * Only provided if source provides this timestamp e.g. as timestamp/x-ntp in RTSP.
+     */
+    captured_at?: number;
+    /**
+     * A media specific offset.
+     *
+     * For video frames, this is the frame number of prediction.
+     * For audio samples, this is the offset of the first sample for this prediction.
+     */
     offset?: number;
+    /**
+     * Offset length of the chunk used for this prediction.
+     *
+     * It has the same format as offset.
+     */
+    offset_duration?: number;
 }
 interface Prediction extends StreamTime {
-    captured_at?: number;
+    /**
+     * The width of the source coordinate system for all prediction coordinates.
+     */
     source_width: number;
+    /**
+     * The height of the source coordinate system for all prediction coordinates.
+     */
     source_height: number;
     source_id?: string;
     objects?: Array<PredictedObject>;
@@ -576,7 +609,7 @@ interface Annotation {
     auto_annotate?: string;
     auto_annotate_params?: AutoAnnotateParams;
     uncertainty_score?: number;
-    annotation: Prediction;
+    predictions: Prediction[];
 }
 declare enum TranscodeMode {
     original = "original",
@@ -821,7 +854,7 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
     getAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, include_annotations?: boolean, top_k?: number): Promise<Asset>;
     deleteAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number): Promise<void>;
     resurrectAsset(asset_uuid: string, dataset_uuid: string, from_dataset_version: number, into_dataset_version?: number): Promise<void>;
-    updateAssetGroundTruth(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, prediction?: Prediction): Promise<void>;
+    updateAssetGroundTruth(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, predictions?: Prediction[]): Promise<void>;
     deleteAssetGroundTruth(asset_uuid: string, dataset_uuid?: string, dataset_version?: number): Promise<void>;
     updateAutoAnnotationStatus(asset_uuid: string, auto_annotate: string, user_review: UserReview, approved_threshold?: number): Promise<void>;
     downloadAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, transcode_mode?: TranscodeMode): Promise<Blob>;

package/dist/eyepop.index.js

@@ -11170,12 +11170,12 @@ var DataEndpoint = class extends Endpoint {
       method: "POST"
     });
   }
-  async updateAssetGroundTruth(asset_uuid, dataset_uuid, dataset_version, prediction) {
+  async updateAssetGroundTruth(asset_uuid, dataset_uuid, dataset_version, predictions) {
     const versionQuery = dataset_version ? `&dataset_version=${dataset_version}` : "";
     const datasetQuery = dataset_uuid ? `&dataset_uuid=${dataset_uuid}` : "";
     return this.request(`/assets/${asset_uuid}/ground_truth?${datasetQuery}${versionQuery}`, {
       method: "PATCH",
-      body: JSON.stringify(prediction)
+      body: JSON.stringify(predictions)
     });
   }
   async deleteAssetGroundTruth(asset_uuid, dataset_uuid, dataset_version) {