edge-impulse-api 1.78.1 → 1.79.0

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

@@ -243,6 +243,171 @@ class RawDataApi {
             });
         });
     }
+    /**
+     * Batch operation to put multiple samples back into the object detection labeling queue. 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 Put samples back into the object detection labeling queue
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param backToLabelingRequest
+     * @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 item in the filter list is an object with the following properties:     - \"key\": Metadata key to filter on.     - \"op\": Operator (\"eq\" for positive match, \"neq\" for negative match).     - \"values\": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified:     - { \"no_metadata\": boolean } - If true, include samples without any metadata     - { \"filters_combinator\": (\"and\" | \"or\") } - Specifies the combinator and matching mode:         - \"and\": All filter items must match (logical AND).         - \"or\": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included.
+     * @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 batchBackToLabeling(projectId, backToLabelingRequest, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/back-to-labeling'
+            .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 batchBackToLabeling.');
+        }
+        // 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 batchBackToLabeling.');
+        }
+        // verify required parameter 'backToLabelingRequest' is not null or undefined
+        if (backToLabelingRequest === null || backToLabelingRequest === undefined) {
+            throw new Error('Required parameter backToLabelingRequest was null or undefined when calling batchBackToLabeling.');
+        }
+        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(backToLabelingRequest, "BackToLabelingRequest")
+        };
+        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Clears all metadata for multiple samples.
      * @summary Clear all metadata (multiple samples)