edge-impulse-api 1.74.11 → 1.74.12

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

@@ -13,6 +13,7 @@
 /// <reference types="node" />
 import { BatchAddMetadataRequest } from '../model/batchAddMetadataRequest';
 import { BatchClearMetadataByKeyRequest } from '../model/batchClearMetadataByKeyRequest';
+import { BatchEditBoundingBoxesRequest } from '../model/batchEditBoundingBoxesRequest';
 import { CountSamplesResponse } from '../model/countSamplesResponse';
 import { CropSampleRequest } from '../model/cropSampleRequest';
 import { CropSampleResponse } from '../model/cropSampleResponse';
@@ -171,6 +172,28 @@ type batchDisableQueryParams = {
     minDate?: Date;
     maxDate?: Date;
 };
+type batchEditBoundingBoxesQueryParams = {
+    category: RawDataCategory;
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+    minLabel?: number;
+    maxLabel?: number;
+    search?: string;
+    dataType?: 'audio' | 'image';
+    minId?: number;
+    maxId?: number;
+    metadata?: string;
+    minDate?: Date;
+    maxDate?: Date;
+};
 type batchEditLabelsQueryParams = {
     category: RawDataCategory;
     labels?: string;
@@ -513,7 +536,38 @@ export declare class RawDataApi {
         };
     }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * 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.
+     * Relabels (or removes) bounding boxes for 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 bounding boxes for multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param batchEditBoundingBoxesRequest
+     * @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 minLabel Only include samples with a label &gt;&#x3D; this value
+     * @param maxLabel Only include samples with a label &lt; this value
+     * @param search Search query
+     * @param dataType Include only samples with a particular data type
+     * @param minId Include only samples with an ID &gt;&#x3D; this value
+     * @param maxId Include only samples with an ID &lt; this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \&quot;no_metadata\&quot;: true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
+     */
+    batchEditBoundingBoxes(projectId: number, batchEditBoundingBoxesRequest: BatchEditBoundingBoxesRequest, queryParams: batchEditBoundingBoxesQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse | StartJobResponse>;
+    /**
+     * Sets the label (also known as class) of multiple samples. If you want to relabel bounding boxes, use \"batchEditBoundingBoxes\" instead. 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

package/build/library/sdk/api/rawDataApi.js

@@ -886,7 +886,172 @@ class RawDataApi {
         });
     }
     /**
-     * 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.
+     * Relabels (or removes) bounding boxes for 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 bounding boxes for multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param batchEditBoundingBoxesRequest
+     * @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 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
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
+     */
+    async batchEditBoundingBoxes(projectId, batchEditBoundingBoxesRequest, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/edit-bounding-boxes'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'projectId' is not null or undefined
+        if (projectId === null || projectId === undefined) {
+            throw new Error('Required parameter projectId was null or undefined when calling batchEditBoundingBoxes.');
+        }
+        // verify required parameter 'category' is not null or undefined
+        if (queryParams.category === null || queryParams.category === undefined) {
+            throw new Error('Required parameter queryParams.category was null or undefined when calling batchEditBoundingBoxes.');
+        }
+        // verify required parameter 'batchEditBoundingBoxesRequest' is not null or undefined
+        if (batchEditBoundingBoxesRequest === null || batchEditBoundingBoxesRequest === undefined) {
+            throw new Error('Required parameter batchEditBoundingBoxesRequest was null or undefined when calling batchEditBoundingBoxes.');
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.category) !== undefined) {
+            localVarQueryParameters['category'] = models_1.ObjectSerializer.serialize(queryParams.category, "RawDataCategory");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.labels) !== undefined) {
+            localVarQueryParameters['labels'] = models_1.ObjectSerializer.serialize(queryParams.labels, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.filename) !== undefined) {
+            localVarQueryParameters['filename'] = models_1.ObjectSerializer.serialize(queryParams.filename, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.maxLength) !== undefined) {
+            localVarQueryParameters['maxLength'] = models_1.ObjectSerializer.serialize(queryParams.maxLength, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.minLength) !== undefined) {
+            localVarQueryParameters['minLength'] = models_1.ObjectSerializer.serialize(queryParams.minLength, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.minFrequency) !== undefined) {
+            localVarQueryParameters['minFrequency'] = models_1.ObjectSerializer.serialize(queryParams.minFrequency, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.maxFrequency) !== undefined) {
+            localVarQueryParameters['maxFrequency'] = models_1.ObjectSerializer.serialize(queryParams.maxFrequency, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.signatureValidity) !== undefined) {
+            localVarQueryParameters['signatureValidity'] = models_1.ObjectSerializer.serialize(queryParams.signatureValidity, "'both' | 'valid' | 'invalid'");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.includeDisabled) !== undefined) {
+            localVarQueryParameters['includeDisabled'] = models_1.ObjectSerializer.serialize(queryParams.includeDisabled, "'both' | 'enabled' | 'disabled'");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.ids) !== undefined) {
+            localVarQueryParameters['ids'] = models_1.ObjectSerializer.serialize(queryParams.ids, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.excludeIds) !== undefined) {
+            localVarQueryParameters['excludeIds'] = models_1.ObjectSerializer.serialize(queryParams.excludeIds, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.minLabel) !== undefined) {
+            localVarQueryParameters['minLabel'] = models_1.ObjectSerializer.serialize(queryParams.minLabel, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.maxLabel) !== undefined) {
+            localVarQueryParameters['maxLabel'] = models_1.ObjectSerializer.serialize(queryParams.maxLabel, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.search) !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.dataType) !== undefined) {
+            localVarQueryParameters['dataType'] = models_1.ObjectSerializer.serialize(queryParams.dataType, "'audio' | 'image'");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.minId) !== undefined) {
+            localVarQueryParameters['minId'] = models_1.ObjectSerializer.serialize(queryParams.minId, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.maxId) !== undefined) {
+            localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.metadata) !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.minDate) !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.maxDate) !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(batchEditBoundingBoxesRequest, "BatchEditBoundingBoxesRequest")
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.OAuth2.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "GenericApiResponse | StartJobResponse");
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Sets the label (also known as class) of multiple samples. If you want to relabel bounding boxes, use \"batchEditBoundingBoxes\" instead. 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