edge-impulse-linux 1.8.10 → 1.9.1

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

@@ -10,14 +10,14 @@
  * Do not edit the class manually.
  */
 /// <reference types="node" />
-import { AnomalyGmmMetadata } from '../model/anomalyGmmMetadata';
-import { AnomalyModelMetadata } from '../model/anomalyModelMetadata';
-import { AnomalyResponse } from '../model/anomalyResponse';
+import { AnomalyConfigResponse } from '../model/anomalyConfigResponse';
+import { AnomalyGmmMetadataResponse } from '../model/anomalyGmmMetadataResponse';
+import { AnomalyModelMetadataResponse } from '../model/anomalyModelMetadataResponse';
 import { AnomalyTrainedFeaturesResponse } from '../model/anomalyTrainedFeaturesResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetDataExplorerFeaturesResponse } from '../model/getDataExplorerFeaturesResponse';
 import { GetPretrainedModelResponse } from '../model/getPretrainedModelResponse';
-import { KerasModelMetadata } from '../model/kerasModelMetadata';
+import { KerasModelMetadataResponse } from '../model/kerasModelMetadataResponse';
 import { KerasResponse } from '../model/kerasResponse';
 import { SavePretrainedModelRequest } from '../model/savePretrainedModelRequest';
 import { SetAnomalyParameterRequest } from '../model/setAnomalyParameterRequest';
@@ -33,23 +33,41 @@ export declare enum LearnApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
-type addKerasFilesFormParams = {
+export type addKerasFilesFormParams = {
     zip: RequestFile;
 };
 type anomalyTrainedFeaturesQueryParams = {
     featureAx1: number;
     featureAx2: number;
 };
-type uploadKerasFilesFormParams = {
+type downloadPretrainedModelQueryParams = {
+    impulseId?: number;
+};
+type getPretrainedModelInfoQueryParams = {
+    impulseId?: number;
+};
+type profilePretrainedModelQueryParams = {
+    impulseId?: number;
+};
+type savePretrainedModelParametersQueryParams = {
+    impulseId?: number;
+};
+type testPretrainedModelQueryParams = {
+    impulseId?: number;
+};
+export type uploadKerasFilesFormParams = {
     zip: RequestFile;
 };
-type uploadPretrainedModelFormParams = {
+export type uploadPretrainedModelFormParams = {
     modelFile: RequestFile;
     modelFileName: string;
     modelFileType: string;
     representativeFeatures?: RequestFile;
     device?: string;
 };
+type uploadPretrainedModelQueryParams = {
+    impulseId?: number;
+};
 export type LearnApiOpts = {
     extraHeaders?: {
         [name: string]: string;
@@ -150,8 +168,9 @@ export declare class LearnApi {
      * @summary Download pretrained model
      * @param projectId Project ID
      * @param pretrainedModelDownloadType
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    downloadPretrainedModel(projectId: number, pretrainedModelDownloadType: 'tflite_float32' | 'tflite_int8' | 'onnx' | 'saved_model', options?: {
+    downloadPretrainedModel(projectId: number, pretrainedModelDownloadType: 'tflite_float32' | 'tflite_int8' | 'onnx' | 'saved_model', queryParams?: downloadPretrainedModelQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -166,7 +185,7 @@ export declare class LearnApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AnomalyResponse>;
+    }): Promise<AnomalyConfigResponse>;
     /**
      * Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId.
      * @summary Anomaly metadata
@@ -177,7 +196,7 @@ export declare class LearnApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AnomalyModelMetadata>;
+    }): Promise<AnomalyModelMetadataResponse>;
     /**
      * 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
@@ -188,7 +207,7 @@ export declare class LearnApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AnomalyGmmMetadata>;
+    }): Promise<AnomalyGmmMetadataResponse>;
     /**
      * Get information about a Keras block, such as its dependencies. Use the impulse blocks to find the learnId.
      * @summary Keras information
@@ -221,7 +240,7 @@ export declare class LearnApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<KerasModelMetadata>;
+    }): Promise<KerasModelMetadataResponse>;
     /**
      * Download the processed data for this learning block. This is data already processed by the signal processing blocks.
      * @summary Download data
@@ -248,8 +267,9 @@ export declare class LearnApi {
      * Receive info back about the earlier uploaded pretrained model (via `uploadPretrainedModel`) input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
      * @summary Get pretrained model
      * @param projectId Project ID
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    getPretrainedModelInfo(projectId: number, options?: {
+    getPretrainedModelInfo(projectId: number, queryParams?: getPretrainedModelInfoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -258,8 +278,9 @@ export declare class LearnApi {
      * Returns the latency, RAM and ROM used for the pretrained model - upload first via  `uploadPretrainedModel`. This is using the project\'s selected latency device. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
      * @summary Profile pretrained model
      * @param projectId Project ID
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    profilePretrainedModel(projectId: number, options?: {
+    profilePretrainedModel(projectId: number, queryParams?: profilePretrainedModelQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -269,8 +290,9 @@ export declare class LearnApi {
      * @summary Save parameters for pretrained model
      * @param projectId Project ID
      * @param savePretrainedModelRequest
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    savePretrainedModelParameters(projectId: number, savePretrainedModelRequest?: SavePretrainedModelRequest, options?: {
+    savePretrainedModelParameters(projectId: number, savePretrainedModelRequest: SavePretrainedModelRequest, queryParams?: savePretrainedModelParametersQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -304,8 +326,9 @@ export declare class LearnApi {
      * @summary Test pretrained model
      * @param projectId Project ID
      * @param testPretrainedModelRequest
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    testPretrainedModel(projectId: number, testPretrainedModelRequest?: TestPretrainedModelRequest, options?: {
+    testPretrainedModel(projectId: number, testPretrainedModelRequest: TestPretrainedModelRequest, queryParams?: testPretrainedModelQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -329,10 +352,11 @@ export declare class LearnApi {
      * @param modelFile
      * @param modelFileName
      * @param modelFileType
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      * @param representativeFeatures
      * @param device MCU used for calculating latency, query &#x60;latencyDevices&#x60; in &#x60;listProject&#x60; for a list of supported devices (and use the \\\&quot;mcu\\\&quot; property here). If this is kept empty then we\\\&#39;ll show an overview of multiple devices.
      */
-    uploadPretrainedModel(projectId: number, params: uploadPretrainedModelFormParams, options?: {
+    uploadPretrainedModel(projectId: number, params: uploadPretrainedModelFormParams, queryParams?: uploadPretrainedModelQueryParams, options?: {
         headers: {
             [name: string]: string;
         };

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

@@ -203,10 +203,10 @@ class LearnApi {
         if (queryParams.featureAx2 === null || queryParams.featureAx2 === undefined) {
             throw new Error('Required parameter queryParams.featureAx2 was null or undefined when calling anomalyTrainedFeatures.');
         }
-        if (queryParams.featureAx1 !== undefined) {
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.featureAx1) !== undefined) {
             localVarQueryParameters['featureAx1'] = models_1.ObjectSerializer.serialize(queryParams.featureAx1, "number");
         }
-        if (queryParams.featureAx2 !== undefined) {
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.featureAx2) !== undefined) {
             localVarQueryParameters['featureAx2'] = models_1.ObjectSerializer.serialize(queryParams.featureAx2, "number");
         }
         Object.assign(localVarHeaderParams, options.headers);
@@ -590,8 +590,9 @@ class LearnApi {
      * @summary Download pretrained model
      * @param projectId Project ID
      * @param pretrainedModelDownloadType
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    async downloadPretrainedModel(projectId, pretrainedModelDownloadType, options = { headers: {} }) {
+    async downloadPretrainedModel(projectId, pretrainedModelDownloadType, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/pretrained-model/download/{pretrainedModelDownloadType}'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
             .replace('{' + 'pretrainedModelDownloadType' + '}', encodeURIComponent(String(pretrainedModelDownloadType)));
@@ -616,6 +617,9 @@ class LearnApi {
         if (pretrainedModelDownloadType === null || pretrainedModelDownloadType === undefined) {
             throw new Error('Required parameter pretrainedModelDownloadType was null or undefined when calling downloadPretrainedModel.');
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
+            localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -727,7 +731,7 @@ class LearnApi {
                         reject(error);
                     }
                     else {
-                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyResponse");
+                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyConfigResponse");
                         const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
                         if (typeof body.success === 'boolean' && !body.success) {
                             reject(new Error(body.error || errString));
@@ -806,7 +810,7 @@ class LearnApi {
                         reject(error);
                     }
                     else {
-                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyModelMetadata");
+                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyModelMetadataResponse");
                         const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
                         if (typeof body.success === 'boolean' && !body.success) {
                             reject(new Error(body.error || errString));
@@ -885,7 +889,7 @@ class LearnApi {
                         reject(error);
                     }
                     else {
-                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyGmmMetadata");
+                        body = models_1.ObjectSerializer.deserialize(body, "AnomalyGmmMetadataResponse");
                         const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
                         if (typeof body.success === 'boolean' && !body.success) {
                             reject(new Error(body.error || errString));
@@ -1122,7 +1126,7 @@ class LearnApi {
                         reject(error);
                     }
                     else {
-                        body = models_1.ObjectSerializer.deserialize(body, "KerasModelMetadata");
+                        body = models_1.ObjectSerializer.deserialize(body, "KerasModelMetadataResponse");
                         const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
                         if (typeof body.success === 'boolean' && !body.success) {
                             reject(new Error(body.error || errString));
@@ -1300,8 +1304,9 @@ class LearnApi {
      * Receive info back about the earlier uploaded pretrained model (via `uploadPretrainedModel`) input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
      * @summary Get pretrained model
      * @param projectId Project ID
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    async getPretrainedModelInfo(projectId, options = { headers: {} }) {
+    async getPretrainedModelInfo(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/pretrained-model'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
@@ -1321,6 +1326,9 @@ class LearnApi {
         if (projectId === null || projectId === undefined) {
             throw new Error('Required parameter projectId was null or undefined when calling getPretrainedModelInfo.');
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
+            localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1373,8 +1381,9 @@ class LearnApi {
      * Returns the latency, RAM and ROM used for the pretrained model - upload first via  `uploadPretrainedModel`. This is using the project\'s selected latency device. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
      * @summary Profile pretrained model
      * @param projectId Project ID
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    async profilePretrainedModel(projectId, options = { headers: {} }) {
+    async profilePretrainedModel(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/pretrained-model/profile'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
@@ -1394,6 +1403,9 @@ class LearnApi {
         if (projectId === null || projectId === undefined) {
             throw new Error('Required parameter projectId was null or undefined when calling profilePretrainedModel.');
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
+            localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1447,8 +1459,9 @@ class LearnApi {
      * @summary Save parameters for pretrained model
      * @param projectId Project ID
      * @param savePretrainedModelRequest
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    async savePretrainedModelParameters(projectId, savePretrainedModelRequest, options = { headers: {} }) {
+    async savePretrainedModelParameters(projectId, savePretrainedModelRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/pretrained-model/save'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
@@ -1468,6 +1481,13 @@ class LearnApi {
         if (projectId === null || projectId === undefined) {
             throw new Error('Required parameter projectId was null or undefined when calling savePretrainedModelParameters.');
         }
+        // verify required parameter 'savePretrainedModelRequest' is not null or undefined
+        if (savePretrainedModelRequest === null || savePretrainedModelRequest === undefined) {
+            throw new Error('Required parameter savePretrainedModelRequest was null or undefined when calling savePretrainedModelParameters.');
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
+            localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1692,8 +1712,9 @@ class LearnApi {
      * @summary Test pretrained model
      * @param projectId Project ID
      * @param testPretrainedModelRequest
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    async testPretrainedModel(projectId, testPretrainedModelRequest, options = { headers: {} }) {
+    async testPretrainedModel(projectId, testPretrainedModelRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/pretrained-model/test'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
@@ -1713,6 +1734,13 @@ class LearnApi {
         if (projectId === null || projectId === undefined) {
             throw new Error('Required parameter projectId was null or undefined when calling testPretrainedModel.');
         }
+        // verify required parameter 'testPretrainedModelRequest' is not null or undefined
+        if (testPretrainedModelRequest === null || testPretrainedModelRequest === undefined) {
+            throw new Error('Required parameter testPretrainedModelRequest was null or undefined when calling testPretrainedModel.');
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
+            localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1857,10 +1885,11 @@ class LearnApi {
      * @param modelFile
      * @param modelFileName
      * @param modelFileType
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      * @param representativeFeatures
      * @param device MCU used for calculating latency, query `latencyDevices` in `listProject` for a list of supported devices (and use the \\\"mcu\\\" property here). If this is kept empty then we\\\'ll show an overview of multiple devices.
      */
-    async uploadPretrainedModel(projectId, params, options = { headers: {} }) {
+    async uploadPretrainedModel(projectId, params, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/pretrained-model/upload'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
@@ -1892,6 +1921,9 @@ class LearnApi {
         if (params.modelFileType === null || params.modelFileType === undefined) {
             throw new Error('Required parameter params.modelFileType was null or undefined when calling uploadPretrainedModel.');
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
+            localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1900,17 +1932,17 @@ class LearnApi {
         }
         localVarUseFormData = true;
         if (params.modelFileName !== undefined) {
-            localVarFormParams['modelFileName'] = models_1.ObjectSerializer.serialize(params.modelFileName, "string");
+            localVarFormParams['modelFileName'] = models_1.ObjectSerializer.serializeFormData(params.modelFileName, "string");
         }
         if (params.modelFileType !== undefined) {
-            localVarFormParams['modelFileType'] = models_1.ObjectSerializer.serialize(params.modelFileType, "string");
+            localVarFormParams['modelFileType'] = models_1.ObjectSerializer.serializeFormData(params.modelFileType, "string");
         }
         if (params.representativeFeatures !== undefined) {
             localVarFormParams['representativeFeatures'] = params.representativeFeatures;
         }
         localVarUseFormData = true;
         if (params.device !== undefined) {
-            localVarFormParams['device'] = models_1.ObjectSerializer.serialize(params.device, "string");
+            localVarFormParams['device'] = models_1.ObjectSerializer.serializeFormData(params.device, "string");
         }
         let localVarRequestOptions = {
             method: 'POST',