edge-impulse-api 1.95.11 → 1.95.12

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

@@ -21,6 +21,7 @@ import { GetDataExplorerFeaturesResponse } from '../model/getDataExplorerFeature
 import { GetPretrainedModelResponse } from '../model/getPretrainedModelResponse';
 import { KerasModelMetadataResponse } from '../model/kerasModelMetadataResponse';
 import { KerasResponse } from '../model/kerasResponse';
+import { ListLearnBlockFilesResponse } from '../model/listLearnBlockFilesResponse';
 import { SavePretrainedModelRequest } from '../model/savePretrainedModelRequest';
 import { SetAnomalyParameterRequest } from '../model/setAnomalyParameterRequest';
 import { SetKerasParameterRequest } from '../model/setKerasParameterRequest';
@@ -59,6 +60,9 @@ type getPretrainedModelInfoQueryParams = {
 type profilePretrainedModelQueryParams = {
     impulseId?: number;
 };
+type readLearnBlockCustomDataFileQueryParams = {
+    path: string;
+};
 type savePretrainedModelParametersQueryParams = {
     impulseId?: number;
 };
@@ -353,6 +357,20 @@ export declare class LearnApi {
             [name: string]: string;
         }) => void;
     }): Promise<VlmConfigResponse>;
+    /**
+     * List all custom files for the learn block as they exist on the file system. You can write extra files to /home/custom_data in your custom learn block (or in expert mode); then pick them up here. This yields all files across all subfolders.
+     * @summary List learn block custom data files
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    listLearnBlockCustomDataFiles(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
+    }): Promise<ListLearnBlockFilesResponse>;
     /**
      * 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
@@ -367,6 +385,21 @@ export declare class LearnApi {
             [name: string]: string;
         }) => void;
     }): Promise<StartJobResponse>;
+    /**
+     * Read a file from the learn block as it exists on the file system. You can write extra files to /home/custom_data in your custom learn block (or in expert mode); then pick them up here. Use \"listLearnBlockCustomDataFiles\" to list all available files.
+     * @summary Read learn block custom data file
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param path CDN Path
+     */
+    readLearnBlockCustomDataFile(projectId: number, learnId: number, queryParams: readLearnBlockCustomDataFileQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
+    }): Promise<Buffer>;
     /**
      * 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

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

@@ -1439,6 +1439,82 @@ class LearnApi {
         }
         return resp;
     }
+    /**
+     * List all custom files for the learn block as they exist on the file system. You can write extra files to /home/custom_data in your custom learn block (or in expert mode); then pick them up here. This yields all files across all subfolders.
+     * @summary List learn block custom data files
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    async listLearnBlockCustomDataFiles(projectId, learnId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/learn-data/{learnId}/custom-data/list'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'learnId' + '}', encodeURIComponent(String(learnId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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 listLearnBlockCustomDataFiles.');
+        }
+        // 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 listLearnBlockCustomDataFiles.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'GET',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        const resp = this.handleResponse(response, 'ListLearnBlockFilesResponse');
+        if (options === null || options === void 0 ? void 0 : options.responseHeadersCallback) {
+            const headerCb = options.responseHeadersCallback;
+            // on next tick, so we have time to handle the response
+            setTimeout(() => {
+                headerCb(Object.fromEntries(response.headers.entries()));
+            }, 0);
+        }
+        return resp;
+    }
     /**
      * 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
@@ -1513,6 +1589,90 @@ class LearnApi {
         }
         return resp;
     }
+    /**
+     * Read a file from the learn block as it exists on the file system. You can write extra files to /home/custom_data in your custom learn block (or in expert mode); then pick them up here. Use \"listLearnBlockCustomDataFiles\" to list all available files.
+     * @summary Read learn block custom data file
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param path CDN Path
+     */
+    async readLearnBlockCustomDataFile(projectId, learnId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/learn-data/{learnId}/custom-data/read'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'learnId' + '}', encodeURIComponent(String(learnId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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 readLearnBlockCustomDataFile.');
+        }
+        // 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 readLearnBlockCustomDataFile.');
+        }
+        // verify required parameter 'path' is not null or undefined
+        if (queryParams.path === null || queryParams.path === undefined) {
+            throw new Error('Required parameter queryParams.path was null or undefined when calling readLearnBlockCustomDataFile.');
+        }
+        if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.path) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.path) !== null) {
+            queryParameters['path'] = queryParams.path;
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'GET',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        const resp = this.handleResponse(response, 'Buffer');
+        if (options === null || options === void 0 ? void 0 : options.responseHeadersCallback) {
+            const headerCb = options.responseHeadersCallback;
+            // on next tick, so we have time to handle the response
+            setTimeout(() => {
+                headerCb(Object.fromEntries(response.headers.entries()));
+            }, 0);
+        }
+        return resp;
+    }
     /**
      * 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