edge-impulse-linux 1.15.1 → 1.15.2

package/build/sdk/studio/sdk/api/rawDataApi.d.ts

@@ -38,6 +38,7 @@ import { ObjectDetectionAutoLabelRequest } from '../model/objectDetectionAutoLab
 import { ObjectDetectionAutoLabelResponse } from '../model/objectDetectionAutoLabelResponse';
 import { ObjectDetectionLabelQueueCountResponse } from '../model/objectDetectionLabelQueueCountResponse';
 import { ObjectDetectionLabelQueueResponse } from '../model/objectDetectionLabelQueueResponse';
+import { RawDataCategory } from '../model/rawDataCategory';
 import { RebalanceDatasetResponse } from '../model/rebalanceDatasetResponse';
 import { RenameSampleRequest } from '../model/renameSampleRequest';
 import { SampleBoundingBoxesRequest } from '../model/sampleBoundingBoxesRequest';
@@ -45,12 +46,13 @@ import { SegmentSampleRequest } from '../model/segmentSampleRequest';
 import { SetSampleMetadataRequest } from '../model/setSampleMetadataRequest';
 import { SetSampleProposedChangesRequest } from '../model/setSampleProposedChangesRequest';
 import { SetSampleStructuredLabelsRequest } from '../model/setSampleStructuredLabelsRequest';
+import { SetSampleVideoDimensionsRequest } from '../model/setSampleVideoDimensionsRequest';
 import { SplitSampleInFramesRequest } from '../model/splitSampleInFramesRequest';
 import { StoreSegmentLengthRequest } from '../model/storeSegmentLengthRequest';
 import { TrackObjectsRequest } from '../model/trackObjectsRequest';
 import { TrackObjectsResponse } from '../model/trackObjectsResponse';
 import { Authentication } from '../model/models';
-import { ApiKeyAuth } from '../model/models';
+import { ApiKeyAuth, OAuth } from '../model/models';
 import { RequestFile } from './apis';
 export declare enum RawDataApiApiKeys {
     ApiKeyAuthentication = 0,
@@ -58,7 +60,7 @@ export declare enum RawDataApiApiKeys {
     JWTHttpHeaderAuthentication = 2
 }
 type batchAddMetadataQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -72,9 +74,12 @@ type batchAddMetadataQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchClearMetadataQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -88,9 +93,12 @@ type batchClearMetadataQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchClearMetadataByKeyQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -104,9 +112,12 @@ type batchClearMetadataByKeyQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchDeleteQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -120,9 +131,12 @@ type batchDeleteQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchDisableQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -136,9 +150,12 @@ type batchDisableQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchEditLabelsQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -152,9 +169,12 @@ type batchEditLabelsQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchEnableQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -168,9 +188,12 @@ type batchEnableQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type batchMoveQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -184,9 +207,12 @@ type batchMoveQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type countSamplesQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     labels?: string;
     filename?: string;
     maxLength?: number;
@@ -198,6 +224,9 @@ type countSamplesQueryParams = {
     minLabel?: number;
     maxLabel?: number;
     search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 type getAllImportedFromQueryParams = {
     limit?: number;
@@ -227,7 +256,7 @@ type getSampleAsVideoQueryParams = {
     impulseId?: number;
 };
 type getSampleMetadataQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
 };
 type getSampleSliceQueryParams = {
     sliceStart: number;
@@ -243,7 +272,7 @@ type getUncroppedDownsampledSampleQueryParams = {
     truncateStructuredLabels?: boolean;
 };
 type listSamplesQueryParams = {
-    category: 'training' | 'testing' | 'anomaly';
+    category: RawDataCategory;
     limit?: number;
     offset?: number;
     excludeSensors?: boolean;
@@ -260,6 +289,10 @@ type listSamplesQueryParams = {
     search?: string;
     proposedActionsJobId?: number;
     truncateStructuredLabels?: boolean;
+    sortBy?: 'id-desc' | 'random';
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
 };
 export type uploadDataExplorerScreenshotFormParams = {
     image: RequestFile;
@@ -277,6 +310,7 @@ export declare class RawDataApi {
     protected authentications: {
         default: Authentication;
         ApiKeyAuthentication: ApiKeyAuth;
+        OAuth2: OAuth;
         JWTAuthentication: ApiKeyAuth;
         JWTHttpHeaderAuthentication: ApiKeyAuth;
     };
@@ -288,6 +322,7 @@ export declare class RawDataApi {
     get opts(): RawDataApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: RawDataApiApiKeys, value: string | undefined): void;
+    set accessToken(token: string);
     /**
      * Add specific metadata for multiple samples.
      * @summary Add metadata (multiple samples)
@@ -307,6 +342,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchAddMetadata(projectId: number, batchAddMetadataRequest: BatchAddMetadataRequest, queryParams: batchAddMetadataQueryParams, options?: {
         headers: {
@@ -331,6 +369,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchClearMetadata(projectId: number, queryParams: batchClearMetadataQueryParams, options?: {
         headers: {
@@ -356,6 +397,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchClearMetadataByKey(projectId: number, batchClearMetadataByKeyRequest: BatchClearMetadataByKeyRequest, queryParams: batchClearMetadataByKeyQueryParams, options?: {
         headers: {
@@ -380,6 +424,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchDelete(projectId: number, queryParams: batchDeleteQueryParams, options?: {
         headers: {
@@ -404,6 +451,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchDisable(projectId: number, queryParams: batchDisableQueryParams, options?: {
         headers: {
@@ -429,6 +479,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchEditLabels(projectId: number, editSampleLabelRequest: EditSampleLabelRequest, queryParams: batchEditLabelsQueryParams, options?: {
         headers: {
@@ -453,6 +506,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchEnable(projectId: number, queryParams: batchEnableQueryParams, options?: {
         headers: {
@@ -478,6 +534,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     batchMove(projectId: number, moveRawDataRequest: MoveRawDataRequest, queryParams: batchMoveQueryParams, options?: {
         headers: {
@@ -532,6 +591,9 @@ export declare class RawDataApi {
      * @param minLabel Only include samples with a label >= this value
      * @param maxLabel Only include samples with a label < this value
      * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     countSamples(projectId: number, queryParams: countSamplesQueryParams, options?: {
         headers: {
@@ -566,7 +628,7 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param category Which of the three acquisition categories to download data from
      */
-    deleteAllSamplesByCategory(projectId: number, category: 'training' | 'testing' | 'anomaly', options?: {
+    deleteAllSamplesByCategory(projectId: number, category: RawDataCategory, options?: {
         headers: {
             [name: string]: string;
         };
@@ -884,6 +946,10 @@ export declare class RawDataApi {
      * @param search Search query
      * @param proposedActionsJobId Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.
      * @param truncateStructuredLabels If true, only a slice of labels will be returned for samples with multiple labels.
+     * @param sortBy If not specified, \"id-desc\" is used.
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID >= this value
+     * @param maxId Include only samples with an ID < this value
      */
     listSamples(projectId: number, queryParams: listSamplesQueryParams, options?: {
         headers: {
@@ -1017,6 +1083,18 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Update the video dimensions for a sample. This is only available for video files that do not have dimensions set yet.
+     * @summary Set sample video dimensions
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param setSampleVideoDimensionsRequest
+     */
+    setSampleVideoDimensions(projectId: number, sampleId: number, setSampleVideoDimensionsRequest: SetSampleVideoDimensionsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Split a video sample into individual frames. Depending on the length of the video sample this will either execute immediately or return the ID of a job that will perform this action.
      * @summary Split sample into frames