edge-impulse-api 1.22.1 → 1.25.33

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

@@ -0,0 +1,329 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/// <reference types="node" />
+import { AnomalyModelMetadata } from '../model/anomalyModelMetadata';
+import { AnomalyResponse } from '../model/anomalyResponse';
+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 { KerasResponse } from '../model/kerasResponse';
+import { SavePretrainedModelRequest } from '../model/savePretrainedModelRequest';
+import { SetAnomalyParameterRequest } from '../model/setAnomalyParameterRequest';
+import { SetKerasParameterRequest } from '../model/setKerasParameterRequest';
+import { StartJobResponse } from '../model/startJobResponse';
+import { TestPretrainedModelRequest } from '../model/testPretrainedModelRequest';
+import { TestPretrainedModelResponse } from '../model/testPretrainedModelResponse';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum LearnApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type addKerasFilesFormParams = {
+    zip: RequestFile;
+};
+declare type anomalyTrainedFeaturesQueryParams = {
+    featureAx1: number;
+    featureAx2: number;
+};
+declare type uploadKerasFilesFormParams = {
+    zip: RequestFile;
+};
+declare type uploadPretrainedModelFormParams = {
+    modelFile: RequestFile;
+    modelFileName: string;
+    modelFileType: string;
+    representativeFeatures?: RequestFile;
+    device?: string;
+};
+export declare type LearnApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class LearnApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: LearnApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: LearnApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: LearnApiOpts);
+    get opts(): LearnApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: LearnApiApiKeys, value: string | undefined): void;
+    /**
+     * Add Keras block files with the contents of a zip. This is an internal API.
+     * @summary Add Keras files
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param zip
+     */
+    addKerasFiles(projectId: number, learnId: number, params: addKerasFilesFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Get a sample of trained features, this extracts a number of samples and their features.
+     * @summary Trained features
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param featureAx1 Feature axis 1
+     * @param featureAx2 Feature axis 2
+     */
+    anomalyTrainedFeatures(projectId: number, learnId: number, queryParams: anomalyTrainedFeaturesQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AnomalyTrainedFeaturesResponse>;
+    /**
+     * Get trained features for a single sample. This runs both the DSP prerequisites and the anomaly classifier.
+     * @summary Trained features for sample
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param sampleId Sample ID
+     */
+    anomalyTrainedFeaturesPerSample(projectId: number, learnId: number, sampleId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AnomalyTrainedFeaturesResponse>;
+    /**
+     * Download the data of an exported Keras block - needs to be exported via \'exportKerasBlockData\' first
+     * @summary Download Keras data export
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    downloadKerasData(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download an exported Keras block - needs to be exported via \'exportKerasBlock\' first
+     * @summary Download Keras export
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    downloadKerasExport(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download a trained model for a learning block. Depending on the block this can be a TensorFlow model, or the cluster centroids.
+     * @summary Download trained model
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param modelDownloadId Model download ID, which can be obtained from the project information
+     */
+    downloadLearnModel(projectId: number, learnId: number, modelDownloadId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download a pretrained model file
+     * @summary Download pretrained model
+     * @param projectId Project ID
+     * @param pretrainedModelDownloadType
+     */
+    downloadPretrainedModel(projectId: number, pretrainedModelDownloadType: 'tflite_float32' | 'tflite_int8' | 'onnx' | 'saved_model', options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Get information about an anomaly block, such as its dependencies. Use the impulse blocks to find the learnId.
+     * @summary Anomaly information
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getAnomaly(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AnomalyResponse>;
+    /**
+     * Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId.
+     * @summary Anomaly metadata
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getAnomalyMetadata(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AnomalyModelMetadata>;
+    /**
+     * Get information about a Keras block, such as its dependencies. Use the impulse blocks to find the learnId.
+     * @summary Keras information
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getKeras(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<KerasResponse>;
+    /**
+     * t-SNE2 output of the raw dataset using embeddings from this Keras block
+     * @summary Get data explorer features
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getKerasDataExplorerFeatures(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetDataExplorerFeaturesResponse>;
+    /**
+     * Get metadata about a trained Keras block. Use the impulse blocks to find the learnId.
+     * @summary Keras metadata
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getKerasMetadata(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<KerasModelMetadata>;
+    /**
+     * Download the processed data for this learning block. This is data already processed by the signal processing blocks.
+     * @summary Download data
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getLearnXData(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download the labels for this learning block. This is data already processed by the signal processing blocks. Not all blocks support this function. If so, a GenericApiResponse is returned with an error message.
+     * @summary Download labels
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    getLearnYData(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * 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
+     */
+    getPretrainedModelInfo(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetPretrainedModelResponse>;
+    /**
+     * 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
+     */
+    profilePretrainedModel(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Save input / model configuration for a pretrained model. This overrides the current impulse. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
+     * @summary Save parameters for pretrained model
+     * @param projectId Project ID
+     * @param savePretrainedModelRequest
+     */
+    savePretrainedModelParameters(projectId: number, savePretrainedModelRequest?: SavePretrainedModelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Configure the anomaly block, such as its minimum confidence score. Use the impulse blocks to find the learnId.
+     * @summary Anomaly settings
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param setAnomalyParameterRequest
+     */
+    setAnomaly(projectId: number, learnId: number, setAnomalyParameterRequest: SetAnomalyParameterRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Configure the Keras block, such as its minimum confidence score. Use the impulse blocks to find the learnId.
+     * @summary Keras settings
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param setKerasParameterRequest
+     */
+    setKeras(projectId: number, learnId: number, setKerasParameterRequest: SetKerasParameterRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Test out a pretrained model (using raw features) - upload first via  `uploadPretrainedModel`. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
+     * @summary Test pretrained model
+     * @param projectId Project ID
+     * @param testPretrainedModelRequest
+     */
+    testPretrainedModel(projectId: number, testPretrainedModelRequest?: TestPretrainedModelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<TestPretrainedModelResponse>;
+    /**
+     * Replace Keras block files with the contents of a zip. This is an internal API.
+     * @summary Upload Keras files
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param zip
+     */
+    uploadKerasFiles(projectId: number, learnId: number, params: uploadKerasFilesFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Upload a pretrained model and receive info back about the input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
+     * @summary Upload a pretrained model
+     * @param projectId Project ID
+     * @param modelFile
+     * @param modelFileName
+     * @param modelFileType
+     * @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?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+}
+export {};

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

@@ -74,6 +74,94 @@ class LearnApi {
     setApiKey(key, value) {
         this.authentications[LearnApiApiKeys[key]].apiKey = value;
     }
+    /**
+     * Add Keras block files with the contents of a zip. This is an internal API.
+     * @summary Add Keras files
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param zip
+     */
+    async addKerasFiles(projectId, learnId, params, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/training/keras/{learnId}/addFiles'
+            .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 addKerasFiles.');
+        }
+        // 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 addKerasFiles.');
+        }
+        // verify required parameter 'zip' is not null or undefined
+        if (params.zip === null || params.zip === undefined) {
+            throw new Error('Required parameter params.zip was null or undefined when calling addKerasFiles.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        if (params.zip !== undefined) {
+            localVarFormParams['zip'] = params.zip;
+        }
+        localVarUseFormData = true;
+        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, "GenericApiResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Get a sample of trained features, this extracts a number of samples and their features.
      * @summary Trained features
@@ -497,6 +585,85 @@ class LearnApi {
             });
         });
     }
+    /**
+     * Download a pretrained model file
+     * @summary Download pretrained model
+     * @param projectId Project ID
+     * @param pretrainedModelDownloadType
+     */
+    async downloadPretrainedModel(projectId, pretrainedModelDownloadType, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/pretrained-model/download/{pretrainedModelDownloadType}'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'pretrainedModelDownloadType' + '}', encodeURIComponent(String(pretrainedModelDownloadType)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/octet-stream'];
+        // 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 downloadPretrainedModel.');
+        }
+        // verify required parameter 'pretrainedModelDownloadType' is not null or undefined
+        if (pretrainedModelDownloadType === null || pretrainedModelDownloadType === undefined) {
+            throw new Error('Required parameter pretrainedModelDownloadType was null or undefined when calling downloadPretrainedModel.');
+        }
+        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 },
+            encoding: null,
+        };
+        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, "Buffer");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Get information about an anomaly block, such as its dependencies. Use the impulse blocks to find the learnId.
      * @summary Anomaly information
@@ -639,7 +806,7 @@ class LearnApi {
                         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));