edge-impulse-linux 1.9.0 → 1.9.2

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

@@ -10,6 +10,8 @@
  * Do not edit the class manually.
  */
 /// <reference types="node" />
+import { BatchAddMetadataRequest } from '../model/batchAddMetadataRequest';
+import { BatchClearMetadataByKeyRequest } from '../model/batchClearMetadataByKeyRequest';
 import { CountSamplesResponse } from '../model/countSamplesResponse';
 import { CropSampleRequest } from '../model/cropSampleRequest';
 import { CropSampleResponse } from '../model/cropSampleResponse';
@@ -19,6 +21,7 @@ import { EditSampleLabelRequest } from '../model/editSampleLabelRequest';
 import { FindSegmentSampleRequest } from '../model/findSegmentSampleRequest';
 import { FindSegmentSampleResponse } from '../model/findSegmentSampleResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetAIActionsProposedChangesResponse } from '../model/getAIActionsProposedChangesResponse';
 import { GetAllImportedFromResponse } from '../model/getAllImportedFromResponse';
 import { GetAutoLabelerResponse } from '../model/getAutoLabelerResponse';
 import { GetAutoLabelerSegmentInfoResponse } from '../model/getAutoLabelerSegmentInfoResponse';
@@ -43,6 +46,7 @@ import { SaveAutoLabelerClustersRequest } from '../model/saveAutoLabelerClusters
 import { SaveAutoLabelerClustersResponse } from '../model/saveAutoLabelerClustersResponse';
 import { SegmentSampleRequest } from '../model/segmentSampleRequest';
 import { SetSampleMetadataRequest } from '../model/setSampleMetadataRequest';
+import { SetSampleProposedChangesRequest } from '../model/setSampleProposedChangesRequest';
 import { SetSampleStructuredLabelsRequest } from '../model/setSampleStructuredLabelsRequest';
 import { SplitSampleInFramesRequest } from '../model/splitSampleInFramesRequest';
 import { StartJobResponse } from '../model/startJobResponse';
@@ -57,6 +61,48 @@ export declare enum RawDataApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+type batchAddMetadataQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+    search?: string;
+};
+type batchClearMetadataQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+    search?: string;
+};
+type batchClearMetadataByKeyQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+    search?: string;
+};
 type batchDeleteQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
     labels?: string;
@@ -224,7 +270,75 @@ export declare class RawDataApi {
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: RawDataApiApiKeys, value: string | undefined): void;
     /**
-     * Deletes samples. Note that this does not delete the data from cold storage.
+     * Add specific metadata for multiple samples.
+     * @summary Add metadata (multiple samples)
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param batchAddMetadataRequest
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
+     * @param signatureValidity Include samples with either valid or invalid signatures
+     * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
+     */
+    batchAddMetadata(projectId: number, batchAddMetadataRequest: BatchAddMetadataRequest, queryParams: batchAddMetadataQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Clears all metadata for multiple samples.
+     * @summary Clear all metadata (multiple samples)
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
+     * @param signatureValidity Include samples with either valid or invalid signatures
+     * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
+     */
+    batchClearMetadata(projectId: number, queryParams: batchClearMetadataQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Clears a specific metadata field (by key) for multiple samples.
+     * @summary Clear metadata by key (multiple samples)
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param batchClearMetadataByKeyRequest
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
+     * @param signatureValidity Include samples with either valid or invalid signatures
+     * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
+     */
+    batchClearMetadataByKey(projectId: number, batchClearMetadataByKeyRequest: BatchClearMetadataByKeyRequest, queryParams: batchClearMetadataByKeyQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Deletes samples. Note that this does not delete the data from cold storage. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.
      * @summary Remove multiple samples
      * @param projectId Project ID
      * @param category Which of the three acquisition categories to retrieve data from
@@ -244,9 +358,9 @@ export declare class RawDataApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * Disables samples, ensuring that they are excluded from the dataset.
+     * Disables samples, ensuring that they are excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.
      * @summary Disable multiple samples
      * @param projectId Project ID
      * @param category Which of the three acquisition categories to retrieve data from
@@ -266,9 +380,9 @@ export declare class RawDataApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * Sets the label (also known as class) of multiple samples.
+     * Sets the label (also known as class) of multiple samples. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.
      * @summary Edit labels for multiple samples
      * @param projectId Project ID
      * @param category Which of the three acquisition categories to retrieve data from
@@ -289,9 +403,9 @@ export declare class RawDataApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * Enables samples, ensuring that they are not excluded from the dataset.
+     * Enables samples, ensuring that they are not excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.
      * @summary Enable multiple samples
      * @param projectId Project ID
      * @param category Which of the three acquisition categories to retrieve data from
@@ -311,9 +425,9 @@ export declare class RawDataApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * Move multiple samples to another category (e.g. from test to training).
+     * Move multiple samples to another category (e.g. from test to training). Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.
      * @summary Move multiple samples
      * @param projectId Project ID
      * @param category Which of the three acquisition categories to retrieve data from
@@ -334,7 +448,7 @@ export declare class RawDataApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<GenericApiResponse | StartJobResponse>;
     /**
      * Classify an image using another neural network.
      * @summary Auto-label an image
@@ -477,6 +591,17 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<FindSegmentSampleResponse>;
+    /**
+     * Get proposed changes from an AI Actions job.
+     * @summary Get AI Actions proposed changes
+     * @param projectId Project ID
+     * @param jobId Job ID
+     */
+    getAIActionsProposedChanges(projectId: number, jobId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetAIActionsProposedChangesResponse>;
     /**
      * Lists all data with an \'imported from\' metadata key. Used to check in a data source which items are already in a project.
      * @summary List data with \"imported from\" metadata key
@@ -877,6 +1002,18 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.
+     * @summary Propose changes
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param setSampleProposedChangesRequest
+     */
+    setSampleProposedChanges(projectId: number, sampleId: number, setSampleProposedChangesRequest: SetSampleProposedChangesRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Set structured labels for a sample. If a sample has structured labels the `label` column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see `valuesCount` to get the upper bound). endIndex is _inclusive_. If you pass in an incorrect array (e.g. missing values) you\'ll get an error back.
      * @summary Update structured labels