edge-impulse-linux 1.4.7 → 1.4.8

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

@@ -10,11 +10,13 @@
  * Do not edit the class manually.
  */
 /// <reference types="node" />
+import { AnomalyGmmMetadata } from '../model/anomalyGmmMetadata';
 import { AnomalyModelMetadata } from '../model/anomalyModelMetadata';
 import { AnomalyTrainedFeaturesResponse } from '../model/anomalyTrainedFeaturesResponse';
 import { ClassifyJobResponse } from '../model/classifyJobResponse';
 import { ClassifyJobResponsePage } from '../model/classifyJobResponsePage';
 import { ClassifySampleResponse } from '../model/classifySampleResponse';
+import { StartJobResponse } from '../model/startJobResponse';
 import { CountSamplesResponse } from '../model/countSamplesResponse';
 import { DSPMetadataResponse } from '../model/dSPMetadataResponse';
 import { DataExplorerPredictionsResponse } from '../model/dataExplorerPredictionsResponse';
@@ -35,6 +37,7 @@ import { GetSampleResponse } from '../model/getSampleResponse';
 import { HasDataExplorerFeaturesResponse } from '../model/hasDataExplorerFeaturesResponse';
 import { KerasModelMetadata } from '../model/kerasModelMetadata';
 import { KerasModelTypeEnum } from '../model/kerasModelTypeEnum';
+import { KerasModelVariantEnum } from '../model/kerasModelVariantEnum';
 import { ListSamplesResponse } from '../model/listSamplesResponse';
 import { ProjectDeploymentTargetsResponse } from '../model/projectDeploymentTargetsResponse';
 import { ProjectInfoSummaryResponse } from '../model/projectInfoSummaryResponse';
@@ -54,6 +57,13 @@ declare type anomalyTrainedFeaturesQueryParams = {
 declare type classifySampleQueryParams = {
     includeDebugInfo?: boolean;
 };
+declare type classifySampleByLearnBlockV2QueryParams = {
+    variant?: KerasModelVariantEnum;
+};
+declare type classifySampleV2QueryParams = {
+    includeDebugInfo?: boolean;
+    variant?: KerasModelVariantEnum;
+};
 declare type countSamplesQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
     labels?: string;
@@ -181,8 +191,8 @@ export declare class AllowsReadOnlyApi {
         };
     }): Promise<AnomalyTrainedFeaturesResponse>;
     /**
-     * Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
-     * @summary Classify sample
+     * This API is deprecated, use classifySampleV2 instead (`/v1/api/{projectId}/classify/v2/{sampleId}`). Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
+     * @summary Classify sample (deprecated)
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param includeDebugInfo Whether to return the debug information from FOMO classification.
@@ -193,7 +203,7 @@ export declare class AllowsReadOnlyApi {
         };
     }): Promise<ClassifySampleResponse>;
     /**
-     * Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
+     * This API is deprecated, use classifySampleByLearnBlockV2 (`/v1/api/{projectId}/classify/anomaly-gmm/v2/{blockId}/{sampleId}`) instead. Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
      * @summary Classify sample by learn block
      * @param projectId Project ID
      * @param sampleId Sample ID
@@ -204,6 +214,32 @@ export declare class AllowsReadOnlyApi {
             [name: string]: string;
         };
     }): Promise<ClassifySampleResponse>;
+    /**
+     * Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted. Depending on the size of your file, whether your sample is resampled, and whether the result is cached you\'ll get either the result or a job back. If you receive a job, then wait for the completion of the job, and then call this function again to receive the results. The unoptimized (float32) model is used by default, and classification with an optimized (int8) model can be slower.
+     * @summary Classify sample by learn block
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param blockId Block ID
+     * @param variant Keras model variant
+     */
+    classifySampleByLearnBlockV2(projectId: number, sampleId: number, blockId: number, queryParams: classifySampleByLearnBlockV2QueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ClassifySampleResponse | StartJobResponse>;
+    /**
+     * Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted. Depending on the size of your file, whether your sample is resampled, and whether the result is cached you\'ll get either the result or a job back. If you receive a job, then wait for the completion of the job, and then call this function again to receive the results. The unoptimized (float32) model is used by default, and classification with an optimized (int8) model can be slower.
+     * @summary Classify sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param includeDebugInfo Whether to return the debug information from FOMO classification.
+     * @param variant Keras model variant
+     */
+    classifySampleV2(projectId: number, sampleId: number, queryParams: classifySampleV2QueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ClassifySampleResponse | StartJobResponse>;
     /**
      * Count all raw data by category.
      * @summary Count samples
@@ -403,6 +439,17 @@ export declare class AllowsReadOnlyApi {
             [name: string]: string;
         };
     }): Promise<GetSampleResponse>;
+    /**
+     * Get raw model metadata of the Gaussian mixture model (GMM) for a trained anomaly block. Use the impulse blocks to find the learnId.
+     * @summary Anomaly GMM metadata
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getGmmMetadata(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AnomalyGmmMetadata>;
     /**
      * t-SNE2 output of the raw dataset using embeddings from this Keras block
      * @summary Get data explorer features

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

@@ -255,8 +255,8 @@ class AllowsReadOnlyApi {
         });
     }
     /**
-     * Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
-     * @summary Classify sample
+     * This API is deprecated, use classifySampleV2 instead (`/v1/api/{projectId}/classify/v2/{sampleId}`). Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
+     * @summary Classify sample (deprecated)
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param includeDebugInfo Whether to return the debug information from FOMO classification.
@@ -338,7 +338,7 @@ class AllowsReadOnlyApi {
         });
     }
     /**
-     * Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
+     * This API is deprecated, use classifySampleByLearnBlockV2 (`/v1/api/{projectId}/classify/anomaly-gmm/v2/{blockId}/{sampleId}`) instead. Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
      * @summary Classify sample by learn block
      * @param projectId Project ID
      * @param sampleId Sample ID
@@ -422,6 +422,182 @@ class AllowsReadOnlyApi {
             });
         });
     }
+    /**
+     * Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted. Depending on the size of your file, whether your sample is resampled, and whether the result is cached you\'ll get either the result or a job back. If you receive a job, then wait for the completion of the job, and then call this function again to receive the results. The unoptimized (float32) model is used by default, and classification with an optimized (int8) model can be slower.
+     * @summary Classify sample by learn block
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param blockId Block ID
+     * @param variant Keras model variant
+     */
+    async classifySampleByLearnBlockV2(projectId, sampleId, blockId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/classify/anomaly-gmm/v2/{blockId}/{sampleId}'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)))
+            .replace('{' + 'blockId' + '}', encodeURIComponent(String(blockId)));
+        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 classifySampleByLearnBlockV2.');
+        }
+        // verify required parameter 'sampleId' is not null or undefined
+        if (sampleId === null || sampleId === undefined) {
+            throw new Error('Required parameter sampleId was null or undefined when calling classifySampleByLearnBlockV2.');
+        }
+        // verify required parameter 'blockId' is not null or undefined
+        if (blockId === null || blockId === undefined) {
+            throw new Error('Required parameter blockId was null or undefined when calling classifySampleByLearnBlockV2.');
+        }
+        if (queryParams.variant !== undefined) {
+            localVarQueryParameters['variant'] = models_1.ObjectSerializer.serialize(queryParams.variant, "KerasModelVariantEnum");
+        }
+        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,
+        };
+        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, "ClassifySampleResponse | StartJobResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted. Depending on the size of your file, whether your sample is resampled, and whether the result is cached you\'ll get either the result or a job back. If you receive a job, then wait for the completion of the job, and then call this function again to receive the results. The unoptimized (float32) model is used by default, and classification with an optimized (int8) model can be slower.
+     * @summary Classify sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param includeDebugInfo Whether to return the debug information from FOMO classification.
+     * @param variant Keras model variant
+     */
+    async classifySampleV2(projectId, sampleId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/classify/v2/{sampleId}'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
+        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 classifySampleV2.');
+        }
+        // verify required parameter 'sampleId' is not null or undefined
+        if (sampleId === null || sampleId === undefined) {
+            throw new Error('Required parameter sampleId was null or undefined when calling classifySampleV2.');
+        }
+        if (queryParams.includeDebugInfo !== undefined) {
+            localVarQueryParameters['includeDebugInfo'] = models_1.ObjectSerializer.serialize(queryParams.includeDebugInfo, "boolean");
+        }
+        if (queryParams.variant !== undefined) {
+            localVarQueryParameters['variant'] = models_1.ObjectSerializer.serialize(queryParams.variant, "KerasModelVariantEnum");
+        }
+        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,
+        };
+        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, "ClassifySampleResponse | StartJobResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Count all raw data by category.
      * @summary Count samples
@@ -1806,6 +1982,85 @@ class AllowsReadOnlyApi {
             });
         });
     }
+    /**
+     * Get raw model metadata of the Gaussian mixture model (GMM) for a trained anomaly block. Use the impulse blocks to find the learnId.
+     * @summary Anomaly GMM metadata
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    async getGmmMetadata(projectId, learnId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/training/anomaly/{learnId}/gmm/metadata'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'learnId' + '}', encodeURIComponent(String(learnId)));
+        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 getGmmMetadata.');
+        }
+        // verify required parameter 'learnId' is not null or undefined
+        if (learnId === null || learnId === undefined) {
+            throw new Error('Required parameter learnId was null or undefined when calling getGmmMetadata.');
+        }
+        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, "AnomalyGmmMetadata");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * t-SNE2 output of the raw dataset using embeddings from this Keras block
      * @summary Get data explorer features