@eyepop.ai/eyepop 1.4.0 → 1.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -35,7 +35,7 @@ interface Prediction extends StreamTime {
35
35
  source_id?: string;
36
36
  objects?: Array<PredictedObject>;
37
37
  classes?: Array<PredictedClass>;
38
- labels?: Array<PredictedLabel>;
38
+ texts?: Array<PredictedText>;
39
39
  meshs?: Array<PredictedMesh>;
40
40
  keyPoints?: Array<PredictedKeyPoints>;
41
41
  }
@@ -45,10 +45,10 @@ interface PredictedClass {
45
45
  classLabel: string;
46
46
  category: string;
47
47
  }
48
- interface PredictedLabel {
48
+ interface PredictedText {
49
49
  id: number;
50
50
  confidence: number;
51
- label: string;
51
+ text: string;
52
52
  category: string;
53
53
  }
54
54
  interface Contour {
@@ -73,7 +73,7 @@ interface PredictedObject extends PredictedClass {
73
73
  mask: Mask | undefined;
74
74
  objects: Array<PredictedObject> | undefined;
75
75
  classes: Array<PredictedClass> | undefined;
76
- labels: Array<PredictedLabel> | undefined;
76
+ texts: Array<PredictedText> | undefined;
77
77
  meshs: Array<PredictedMesh> | undefined;
78
78
  keyPoints: Array<PredictedKeyPoints> | undefined;
79
79
  }
@@ -464,6 +464,8 @@ interface DatasetVersion {
464
464
  modifiable: boolean;
465
465
  created_at: Date;
466
466
  updated_at: Date;
467
+ analysis_started_at?: Date;
468
+ auto_annotate_started_at?: Date;
467
469
  hero_asset_uuid?: string;
468
470
  asset_stats?: DatasetVersionAssetStats;
469
471
  }
@@ -477,6 +479,7 @@ interface Dataset {
477
479
  account_uuid: string;
478
480
  created_at: Date;
479
481
  updated_at: Date;
482
+ modifiable_version?: number;
480
483
  versions: DatasetVersion[];
481
484
  }
482
485
  interface DatasetCreate {
@@ -487,7 +490,7 @@ interface DatasetCreate {
487
490
  auto_annotate_params?: AutoAnnotateParams;
488
491
  }
489
492
  interface DatasetUpdate {
490
- name: string;
493
+ name?: string;
491
494
  description?: string;
492
495
  tags?: string[];
493
496
  auto_annotates?: string[];
@@ -573,6 +576,7 @@ interface Model {
573
576
  uuid: string;
574
577
  name: string;
575
578
  description?: string;
579
+ external_id?: string;
576
580
  type: ModelType;
577
581
  status: ModelStatus;
578
582
  status_message?: string;
@@ -586,10 +590,12 @@ interface Model {
586
590
  interface ModelCreate {
587
591
  name: string;
588
592
  description: string;
593
+ external_id?: string;
589
594
  }
590
595
  interface ModelUpdate {
591
596
  name: string;
592
597
  description: string;
598
+ external_id?: string;
593
599
  }
594
600
  declare enum ModelTrainingStage {
595
601
  waiting = "waiting",
@@ -656,10 +662,12 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
656
662
  createDataset(data: DatasetCreate): Promise<Dataset>;
657
663
  getDataset(dataset_uuid: string,
658
664
  /** @deprecated */ include_hero_asset?: boolean, include_stats?: boolean): Promise<Dataset>;
659
- updateDataset(dataset_uuid: string, data: DatasetUpdate): Promise<Dataset>;
665
+ updateDataset(dataset_uuid: string, data: DatasetUpdate, start_auto_annotate?: boolean): Promise<Dataset>;
660
666
  updateDatasetHeroAsset(dataset_uuid: string, update: DatasetHeroAssetUpdate): Promise<Dataset>;
661
667
  deleteDataset(dataset_uuid: string): Promise<void>;
662
668
  freezeDatasetVersion(dataset_uuid: string, dataset_version?: number): Promise<Dataset>;
669
+ analyzeDatasetVersion(dataset_uuid: string, dataset_version?: number): Promise<void>;
670
+ autoAnnotateDatasetVersion(dataset_uuid: string, dataset_version?: number, max_assets?: number): Promise<void>;
663
671
  deleteDatasetVersion(dataset_uuid: string, dataset_version: number): Promise<Dataset>;
664
672
  uploadAsset(dataset_uuid: string, dataset_version: number | undefined, blob: Blob, external_id?: string | undefined): Promise<Asset>;
665
673
  importAsset(dataset_uuid: string, dataset_version: number | undefined, asset_import: AssetImport, external_id?: string | undefined): Promise<Asset>;
@@ -673,11 +681,12 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
673
681
  downloadAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, transcode_mode?: TranscodeMode): Promise<Blob>;
674
682
  previewAutoAnnotateAsset(asset_uuid: string, auto_annotate: string, auto_annotate_params?: AutoAnnotateParams): Promise<Annotation>;
675
683
  listModels(): Promise<Model[]>;
676
- createModel(dataset_uuid: string, dataset_version: number, data: ModelCreate): Promise<Model>;
684
+ createModel(dataset_uuid: string, dataset_version: number, data: ModelCreate, start_training?: boolean): Promise<Model>;
677
685
  getModel(model_uuid: string): Promise<Model>;
678
686
  getModelTrainingProgress(model_uuid: string): Promise<ModelTrainingProgress>;
679
687
  updateModel(model_uuid: string, data: ModelUpdate): Promise<Model>;
680
688
  deleteModel(model_uuid: string): Promise<void>;
689
+ trainModel(model_uuid: string): Promise<Model>;
681
690
  publishModel(model_uuid: string): Promise<Model>;
682
691
  addAccountEventHandler(eventHandler: OnChangeEvent): void;
683
692
  removeAccountEventHandler(eventHandler: OnChangeEvent): void;
@@ -815,4 +824,4 @@ declare namespace EyePop {
815
824
  function dataEndpoint(opts?: DataOptions): DataEndpoint;
816
825
  }
817
826
 
818
- export { AbstractJob, type Annotation, AnnotationType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedLabel, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
827
+ export { AbstractJob, type Annotation, AnnotationType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, 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, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
@@ -35,7 +35,7 @@ interface Prediction extends StreamTime {
35
35
  source_id?: string;
36
36
  objects?: Array<PredictedObject>;
37
37
  classes?: Array<PredictedClass>;
38
- labels?: Array<PredictedLabel>;
38
+ texts?: Array<PredictedText>;
39
39
  meshs?: Array<PredictedMesh>;
40
40
  keyPoints?: Array<PredictedKeyPoints>;
41
41
  }
@@ -45,10 +45,10 @@ interface PredictedClass {
45
45
  classLabel: string;
46
46
  category: string;
47
47
  }
48
- interface PredictedLabel {
48
+ interface PredictedText {
49
49
  id: number;
50
50
  confidence: number;
51
- label: string;
51
+ text: string;
52
52
  category: string;
53
53
  }
54
54
  interface Contour {
@@ -73,7 +73,7 @@ interface PredictedObject extends PredictedClass {
73
73
  mask: Mask | undefined;
74
74
  objects: Array<PredictedObject> | undefined;
75
75
  classes: Array<PredictedClass> | undefined;
76
- labels: Array<PredictedLabel> | undefined;
76
+ texts: Array<PredictedText> | undefined;
77
77
  meshs: Array<PredictedMesh> | undefined;
78
78
  keyPoints: Array<PredictedKeyPoints> | undefined;
79
79
  }
@@ -464,6 +464,8 @@ interface DatasetVersion {
464
464
  modifiable: boolean;
465
465
  created_at: Date;
466
466
  updated_at: Date;
467
+ analysis_started_at?: Date;
468
+ auto_annotate_started_at?: Date;
467
469
  hero_asset_uuid?: string;
468
470
  asset_stats?: DatasetVersionAssetStats;
469
471
  }
@@ -477,6 +479,7 @@ interface Dataset {
477
479
  account_uuid: string;
478
480
  created_at: Date;
479
481
  updated_at: Date;
482
+ modifiable_version?: number;
480
483
  versions: DatasetVersion[];
481
484
  }
482
485
  interface DatasetCreate {
@@ -487,7 +490,7 @@ interface DatasetCreate {
487
490
  auto_annotate_params?: AutoAnnotateParams;
488
491
  }
489
492
  interface DatasetUpdate {
490
- name: string;
493
+ name?: string;
491
494
  description?: string;
492
495
  tags?: string[];
493
496
  auto_annotates?: string[];
@@ -573,6 +576,7 @@ interface Model {
573
576
  uuid: string;
574
577
  name: string;
575
578
  description?: string;
579
+ external_id?: string;
576
580
  type: ModelType;
577
581
  status: ModelStatus;
578
582
  status_message?: string;
@@ -586,10 +590,12 @@ interface Model {
586
590
  interface ModelCreate {
587
591
  name: string;
588
592
  description: string;
593
+ external_id?: string;
589
594
  }
590
595
  interface ModelUpdate {
591
596
  name: string;
592
597
  description: string;
598
+ external_id?: string;
593
599
  }
594
600
  declare enum ModelTrainingStage {
595
601
  waiting = "waiting",
@@ -656,10 +662,12 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
656
662
  createDataset(data: DatasetCreate): Promise<Dataset>;
657
663
  getDataset(dataset_uuid: string,
658
664
  /** @deprecated */ include_hero_asset?: boolean, include_stats?: boolean): Promise<Dataset>;
659
- updateDataset(dataset_uuid: string, data: DatasetUpdate): Promise<Dataset>;
665
+ updateDataset(dataset_uuid: string, data: DatasetUpdate, start_auto_annotate?: boolean): Promise<Dataset>;
660
666
  updateDatasetHeroAsset(dataset_uuid: string, update: DatasetHeroAssetUpdate): Promise<Dataset>;
661
667
  deleteDataset(dataset_uuid: string): Promise<void>;
662
668
  freezeDatasetVersion(dataset_uuid: string, dataset_version?: number): Promise<Dataset>;
669
+ analyzeDatasetVersion(dataset_uuid: string, dataset_version?: number): Promise<void>;
670
+ autoAnnotateDatasetVersion(dataset_uuid: string, dataset_version?: number, max_assets?: number): Promise<void>;
663
671
  deleteDatasetVersion(dataset_uuid: string, dataset_version: number): Promise<Dataset>;
664
672
  uploadAsset(dataset_uuid: string, dataset_version: number | undefined, blob: Blob, external_id?: string | undefined): Promise<Asset>;
665
673
  importAsset(dataset_uuid: string, dataset_version: number | undefined, asset_import: AssetImport, external_id?: string | undefined): Promise<Asset>;
@@ -673,11 +681,12 @@ declare class DataEndpoint extends Endpoint<DataEndpoint> {
673
681
  downloadAsset(asset_uuid: string, dataset_uuid?: string, dataset_version?: number, transcode_mode?: TranscodeMode): Promise<Blob>;
674
682
  previewAutoAnnotateAsset(asset_uuid: string, auto_annotate: string, auto_annotate_params?: AutoAnnotateParams): Promise<Annotation>;
675
683
  listModels(): Promise<Model[]>;
676
- createModel(dataset_uuid: string, dataset_version: number, data: ModelCreate): Promise<Model>;
684
+ createModel(dataset_uuid: string, dataset_version: number, data: ModelCreate, start_training?: boolean): Promise<Model>;
677
685
  getModel(model_uuid: string): Promise<Model>;
678
686
  getModelTrainingProgress(model_uuid: string): Promise<ModelTrainingProgress>;
679
687
  updateModel(model_uuid: string, data: ModelUpdate): Promise<Model>;
680
688
  deleteModel(model_uuid: string): Promise<void>;
689
+ trainModel(model_uuid: string): Promise<Model>;
681
690
  publishModel(model_uuid: string): Promise<Model>;
682
691
  addAccountEventHandler(eventHandler: OnChangeEvent): void;
683
692
  removeAccountEventHandler(eventHandler: OnChangeEvent): void;
@@ -815,4 +824,4 @@ declare namespace EyePop {
815
824
  function dataEndpoint(opts?: DataOptions): DataEndpoint;
816
825
  }
817
826
 
818
- export { AbstractJob, type Annotation, AnnotationType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedLabel, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
827
+ export { AbstractJob, type Annotation, AnnotationType, type Asset, type AssetImport, AssetStatus, type Auth0Options, type Authentication, type AutoAnnotateParams, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetHeroAssetUpdate, type DatasetUpdate, type DatasetVersion, type DatasetVersionAssetStats, Endpoint, EndpointState, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, type ModelMetrics, ModelPrecisionType, type ModelSample, ModelStatus, type ModelTrainingProgress, ModelTrainingStage, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, 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, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamEvent, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
@@ -11127,8 +11127,8 @@ var DataEndpoint = class extends Endpoint {
11127
11127
  method: "GET"
11128
11128
  });
11129
11129
  }
11130
- async updateDataset(dataset_uuid, data) {
11131
- return this.request(`/datasets/${dataset_uuid}`, {
11130
+ async updateDataset(dataset_uuid, data, start_auto_annotate = true) {
11131
+ return this.request(`/datasets/${dataset_uuid}?start_auto_annotate=${start_auto_annotate}`, {
11132
11132
  method: "PATCH",
11133
11133
  body: JSON.stringify(data)
11134
11134
  });
@@ -11150,6 +11150,19 @@ var DataEndpoint = class extends Endpoint {
11150
11150
  method: "POST"
11151
11151
  });
11152
11152
  }
11153
+ async analyzeDatasetVersion(dataset_uuid, dataset_version) {
11154
+ const versionQuery = dataset_version ? `&dataset_version=${dataset_version}` : "";
11155
+ return this.request(`/datasets/${dataset_uuid}/analyze?${versionQuery}`, {
11156
+ method: "POST"
11157
+ });
11158
+ }
11159
+ async autoAnnotateDatasetVersion(dataset_uuid, dataset_version, max_assets) {
11160
+ const versionQuery = dataset_version ? `&dataset_version=${dataset_version}` : "";
11161
+ const maxAssetsQuery = max_assets ? `&max_assets=${max_assets}` : "";
11162
+ return this.request(`/datasets/${dataset_uuid}/auto_annotate?${versionQuery}${maxAssetsQuery}`, {
11163
+ method: "POST"
11164
+ });
11165
+ }
11153
11166
  async deleteDatasetVersion(dataset_uuid, dataset_version) {
11154
11167
  return this.request(`/datasets/${dataset_uuid}/delete?dataset_version=${dataset_version}`, {
11155
11168
  method: "POST"
@@ -11260,8 +11273,8 @@ var DataEndpoint = class extends Endpoint {
11260
11273
  method: "GET"
11261
11274
  });
11262
11275
  }
11263
- async createModel(dataset_uuid, dataset_version, data) {
11264
- return this.request(`/models?dataset_uuid=${dataset_uuid}&dataset_version=${dataset_version}`, {
11276
+ async createModel(dataset_uuid, dataset_version, data, start_training = true) {
11277
+ return this.request(`/models?dataset_uuid=${dataset_uuid}&dataset_version=${dataset_version}&start_training=${start_training}`, {
11265
11278
  method: "POST",
11266
11279
  body: JSON.stringify(data)
11267
11280
  });
@@ -11287,6 +11300,11 @@ var DataEndpoint = class extends Endpoint {
11287
11300
  method: "DELETE"
11288
11301
  });
11289
11302
  }
11303
+ async trainModel(model_uuid) {
11304
+ return this.request(`/models/${model_uuid}/train`, {
11305
+ method: "POST"
11306
+ });
11307
+ }
11290
11308
  async publishModel(model_uuid) {
11291
11309
  return this.request(`/models/${model_uuid}/publish`, {
11292
11310
  method: "POST"