edge-impulse-api 1.22.2 → 1.25.33

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

@@ -259,8 +259,9 @@ class AllowsReadOnlyApi {
      * @summary Classify sample
      * @param projectId Project ID
      * @param sampleId Sample ID
+     * @param includeDebugInfo Whether to return the debug information from FOMO classification.
      */
-    async classifySample(projectId, sampleId, options = { headers: {} }) {
+    async classifySample(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/classify/{sampleId}'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
             .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
@@ -285,6 +286,9 @@ class AllowsReadOnlyApi {
         if (sampleId === null || sampleId === undefined) {
             throw new Error('Required parameter sampleId was null or undefined when calling classifySample.');
         }
+        if (queryParams.includeDebugInfo !== undefined) {
+            localVarQueryParameters['includeDebugInfo'] = models_1.ObjectSerializer.serialize(queryParams.includeDebugInfo, "boolean");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1136,7 +1140,7 @@ class AllowsReadOnlyApi {
                         reject(error);
                     }
                     else {
-                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyModelMetadataResponse");
+                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyModelMetadata");
                         const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
                         if (typeof body.success === 'boolean' && !body.success) {
                             reject(new Error(body.error || errString));
@@ -1456,13 +1460,87 @@ class AllowsReadOnlyApi {
             });
         });
     }
+    /**
+     * Structure describing the similarity and diversity of a dataset
+     * @summary Get diversity visualization data
+     * @param projectId Project ID
+     */
+    async getDiversityData(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/data-quality/diversity'
+            .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 getDiversityData.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        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.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, "GetDiversityDataResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Retrieve the metadata from a generated DSP block.
      * @summary Get metadata
      * @param projectId Project ID
      * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
+     * @param excludeIncludedSamples Whether to exclude \&#39;includedSamples\&#39; in the response (as these can slow down requests significantly).
      */
-    async getDspMetadata(projectId, dspId, options = { headers: {} }) {
+    async getDspMetadata(projectId, dspId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/dsp/{dspId}/metadata'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
             .replace('{' + 'dspId' + '}', encodeURIComponent(String(dspId)));
@@ -1487,6 +1565,9 @@ class AllowsReadOnlyApi {
         if (dspId === null || dspId === undefined) {
             throw new Error('Required parameter dspId was null or undefined when calling getDspMetadata.');
         }
+        if (queryParams.excludeIncludedSamples !== undefined) {
+            localVarQueryParameters['excludeIncludedSamples'] = models_1.ObjectSerializer.serialize(queryParams.excludeIncludedSamples, "boolean");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -3058,6 +3139,79 @@ class AllowsReadOnlyApi {
             });
         });
     }
+    /**
+     * Determine if data diversity metrics have been calculated
+     * @summary Check if data diversity metrics exist
+     * @param projectId Project ID
+     */
+    async hasDiversityData(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/data-quality/diversity/exists'
+            .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 hasDiversityData.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        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.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, "HasDataExplorerFeaturesResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * List all deployment targets
      * @summary Deployment targets