@eyepop.ai/eyepop 3.6.1 → 3.7.2

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>;
@@ -56,7 +89,7 @@ interface Mask {
     stride: number;
 }
 interface PredictedObject extends PredictedClass {
-    traceId: number | undefined;
+    trackId: number | undefined;
     x: number;
     y: number;
     width: number;
@@ -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",
@@ -789,6 +822,15 @@ declare enum ModelPrecisionType {
     int8 = "int8",
     uint8 = "uint8"
 }
+declare enum AssetUrlType {
+    gcs = "gcs",
+    s3 = "s3",
+    https_signed = "https_signed"
+}
+interface DownloadResponse {
+    url: string;
+    url_type: AssetUrlType;
+}
 
 declare class DataEndpoint extends Endpoint<DataEndpoint> {
     private _baseUrl;
@@ -821,10 +863,10 @@ 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>;
+    downloadAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, transcode_mode?: TranscodeMode, start_timestamp?: number, end_timestamp?: number, url_type?: AssetUrlType): Promise<Blob | DownloadResponse>;
     previewAutoAnnotateAsset(asset_uuid: string, auto_annotate: string, auto_annotate_params?: AutoAnnotateParams): Promise<Annotation>;
     listModels(): Promise<Model[]>;
     findModelsForDataset(dataset_uuid: string): Promise<Model[]>;
@@ -1001,4 +1043,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadLiveIngressJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type QcAiHubExportParams, type ResultStream, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, type TrackingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, readableStreamFromString };
+export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadLiveIngressJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type QcAiHubExportParams, type ResultStream, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, type TrackingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, readableStreamFromString };

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>;
@@ -56,7 +89,7 @@ interface Mask {
     stride: number;
 }
 interface PredictedObject extends PredictedClass {
-    traceId: number | undefined;
+    trackId: number | undefined;
     x: number;
     y: number;
     width: number;
@@ -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",
@@ -789,6 +822,15 @@ declare enum ModelPrecisionType {
     int8 = "int8",
     uint8 = "uint8"
 }
+declare enum AssetUrlType {
+    gcs = "gcs",
+    s3 = "s3",
+    https_signed = "https_signed"
+}
+interface DownloadResponse {
+    url: string;
+    url_type: AssetUrlType;
+}
 
 declare class DataEndpoint extends Endpoint<DataEndpoint> {
     private _baseUrl;
@@ -821,10 +863,10 @@ 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>;
+    downloadAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, transcode_mode?: TranscodeMode, start_timestamp?: number, end_timestamp?: number, url_type?: AssetUrlType): Promise<Blob | DownloadResponse>;
     previewAutoAnnotateAsset(asset_uuid: string, auto_annotate: string, auto_annotate_params?: AutoAnnotateParams): Promise<Annotation>;
     listModels(): Promise<Model[]>;
     findModelsForDataset(dataset_uuid: string): Promise<Model[]>;
@@ -1001,4 +1043,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadLiveIngressJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type QcAiHubExportParams, type ResultStream, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, type TrackingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, readableStreamFromString };
+export { AbstractJob, type Annotation, AnnotationType, ArtifactType, type Asset, type AssetImport, AssetStatus, AssetUrlType, type AssetUuidSource, type Auth0Options, type Authentication, type AutoAnnotateParams, type AutoAnnotatePrompt, AutoAnnotateTask, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type ComponentParams, type Contour, type ContourFinderComponent, ContourType, type CreateWorkflow, type CreateWorkflowConfig, DEFAULT_PREDICTION_VERSION, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetParent, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, type DownloadResponse, Endpoint, EndpointState, ExportedBy, EyePop, EyepopLineDecoder, type FileSource, type ForwardComponent, ForwardOperatorType, type HttpClient, type InferenceComponent, InferenceType, type ListWorkFlowItem, type ListWorkFlowItemMetadata, type ListWorkflowItemMetadataLabels, LoadFromAssetUuidJob, LoadFromJob, LoadLiveIngressJob, LoadMediaStreamJob, type LocalAuth, type Mask, type MediaStreamSource, type Model, type ModelCreate, type ModelExport, ModelExportStatus, ModelFormat, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, ModelTask, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, MotionModel, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type PlatformSupport, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedMesh, type PredictedObject, type PredictedText, type Prediction, PredictionVersion, type QcAiHubExportParams, type ResultStream, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, Stream, type StreamEvent, type StreamSource, type StreamTime, type TrackingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, VideoMode, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, type Workflow, WorkflowPhase, EyePop as default, readableStreamFromString };

package/dist/eyepop.index.js

@@ -8660,6 +8660,7 @@ __export(index_exports, {
   AnnotationType: () => AnnotationType,
   ArtifactType: () => ArtifactType,
   AssetStatus: () => AssetStatus,
+  AssetUrlType: () => AssetUrlType,
   AutoAnnotateTask: () => AutoAnnotateTask,
   ChangeType: () => ChangeType,
   ContourType: () => ContourType,
@@ -10839,6 +10840,12 @@ var ModelPrecisionType = /* @__PURE__ */ ((ModelPrecisionType2) => {
   ModelPrecisionType2["uint8"] = "uint8";
   return ModelPrecisionType2;
 })(ModelPrecisionType || {});
+var AssetUrlType = /* @__PURE__ */ ((AssetUrlType3) => {
+  AssetUrlType3["gcs"] = "gcs";
+  AssetUrlType3["s3"] = "s3";
+  AssetUrlType3["https_signed"] = "https_signed";
+  return AssetUrlType3;
+})(AssetUrlType || {});
 
 // data/data_endpoint.ts
 var WS_INITIAL_RECONNECT_DELAY = 1e3;
@@ -11170,12 +11177,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) {
@@ -11195,12 +11202,18 @@ var DataEndpoint = class extends Endpoint {
       method: "PATCH"
     });
   }
-  async downloadAsset(asset_uuid, dataset_uuid, dataset_version, transcode_mode = "original" /* original */) {
+  async downloadAsset(asset_uuid, dataset_uuid, dataset_version, transcode_mode = "original" /* original */, start_timestamp, end_timestamp, url_type) {
     const versionQuery = dataset_version ? `&dataset_version=${dataset_version}` : "";
     const datasetQuery = dataset_uuid ? `&dataset_uuid=${dataset_uuid}` : "";
-    return this.request(`/assets/${asset_uuid}/download?${datasetQuery}${versionQuery}&transcode_mode=${transcode_mode}`, {
-      method: "GET"
-    });
+    const startTimestampQuery = start_timestamp ? `&start_timestamp=${start_timestamp}` : "";
+    const endTimestampQuery = end_timestamp ? `&end_timestamp=${end_timestamp}` : "";
+    const urlTypeQuery = url_type ? `&url_type=${url_type}` : "";
+    return this.request(
+      `/assets/${asset_uuid}/download?transcode_mode=${transcode_mode}${datasetQuery}${versionQuery}${startTimestampQuery}${endTimestampQuery}${urlTypeQuery}`,
+      {
+        method: "GET"
+      }
+    );
   }
   async previewAutoAnnotateAsset(asset_uuid, auto_annotate, auto_annotate_params) {
     return this.request(`/assets/${asset_uuid}/preview_auto_annotate?auto_annotate=${auto_annotate}`, {
@@ -11593,6 +11606,7 @@ var index_default = EyePop;
   AnnotationType,
   ArtifactType,
   AssetStatus,
+  AssetUrlType,
   AutoAnnotateTask,
   ChangeType,
   ContourType,