edge-impulse-api 1.93.25 → 1.93.27

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

@@ -100,6 +100,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Download an artifact from a DSP block for debugging. This is an internal API.
@@ -112,6 +115,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Download output from a DSP block over all data in the selected category, already sliced in windows. In Numpy binary format.
@@ -125,6 +131,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Download labels for a DSP block over all data in the selected category, already sliced in windows.
@@ -137,6 +146,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Runs the DSP block against a sample. 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 run the DSP function for every window that is extracted.
@@ -149,6 +161,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspSampleFeaturesResponse>;
     /**
      * Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set.
@@ -164,6 +179,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspTrainedFeaturesResponse>;
     /**
      * Get a set of parameters, found as a result of running the DSP autotuner.
@@ -175,6 +193,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspAutotunerResults>;
     /**
      * Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks.
@@ -186,6 +207,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DSPConfigResponse>;
     /**
      * Retrieve the feature importance for a DSP block (only available for blocks where dimensionalityReduction is not enabled)
@@ -197,6 +221,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspFeatureImportanceResponse>;
     /**
      * Retrieve the names of the features the DSP block generates
@@ -208,6 +235,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspFeatureLabelsResponse>;
     /**
      * Retrieve the metadata from a generated DSP block.
@@ -221,6 +251,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DSPMetadataResponse>;
     /**
      * Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.
@@ -236,6 +269,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GetSampleDspResponse>;
     /**
      * Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
@@ -251,6 +287,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GetSampleDspResponse>;
     /**
      * Get estimated performance (latency and RAM) for the DSP block, for all supported project latency devices.
@@ -262,6 +301,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspPerformanceAllVariantsResponse>;
     /**
      * Takes in a features array and runs it through the DSP block. This data should have the same frequency as set in the input block in your impulse.
@@ -274,6 +316,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspRunResponse>;
     /**
      * Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
@@ -289,6 +334,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspRunResponseWithSample>;
     /**
      * Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
@@ -303,6 +351,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DspRunResponseWithSample>;
     /**
      * Set configuration parameters for the DSP block. Only values set in the body will be overwritten.
@@ -315,6 +366,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Returns performance characteristics for a custom DSP block (needs `hasTfliteImplementation`). 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.
@@ -327,6 +381,9 @@ export declare class DSPApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
 }
 export {};

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

@@ -164,7 +164,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GenericApiResponse');
+        const resp = this.handleResponse(response, 'GenericApiResponse');
+        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;
     }
     /**
      * Download an artifact from a DSP block for debugging. This is an internal API.
@@ -238,7 +246,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'Buffer');
+        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;
     }
     /**
      * Download output from a DSP block over all data in the selected category, already sliced in windows. In Numpy binary format.
@@ -316,7 +332,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'Buffer');
+        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;
     }
     /**
      * Download labels for a DSP block over all data in the selected category, already sliced in windows.
@@ -390,7 +414,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'Buffer');
+        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;
     }
     /**
      * Runs the DSP block against a sample. 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 run the DSP function for every window that is extracted.
@@ -464,7 +496,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspSampleFeaturesResponse');
+        const resp = this.handleResponse(response, 'DspSampleFeaturesResponse');
+        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;
     }
     /**
      * Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set.
@@ -562,7 +602,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspTrainedFeaturesResponse');
+        const resp = this.handleResponse(response, 'DspTrainedFeaturesResponse');
+        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;
     }
     /**
      * Get a set of parameters, found as a result of running the DSP autotuner.
@@ -630,7 +678,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspAutotunerResults');
+        const resp = this.handleResponse(response, 'DspAutotunerResults');
+        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;
     }
     /**
      * Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks.
@@ -698,7 +754,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DSPConfigResponse');
+        const resp = this.handleResponse(response, 'DSPConfigResponse');
+        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;
     }
     /**
      * Retrieve the feature importance for a DSP block (only available for blocks where dimensionalityReduction is not enabled)
@@ -766,7 +830,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspFeatureImportanceResponse');
+        const resp = this.handleResponse(response, 'DspFeatureImportanceResponse');
+        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;
     }
     /**
      * Retrieve the names of the features the DSP block generates
@@ -834,7 +906,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspFeatureLabelsResponse');
+        const resp = this.handleResponse(response, 'DspFeatureLabelsResponse');
+        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;
     }
     /**
      * Retrieve the metadata from a generated DSP block.
@@ -910,7 +990,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DSPMetadataResponse');
+        const resp = this.handleResponse(response, 'DSPMetadataResponse');
+        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;
     }
     /**
      * Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.
@@ -996,7 +1084,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GetSampleDspResponse');
+        const resp = this.handleResponse(response, 'GetSampleDspResponse');
+        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;
     }
     /**
      * Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
@@ -1086,7 +1182,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GetSampleDspResponse');
+        const resp = this.handleResponse(response, 'GetSampleDspResponse');
+        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;
     }
     /**
      * Get estimated performance (latency and RAM) for the DSP block, for all supported project latency devices.
@@ -1154,7 +1258,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspPerformanceAllVariantsResponse');
+        const resp = this.handleResponse(response, 'DspPerformanceAllVariantsResponse');
+        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;
     }
     /**
      * Takes in a features array and runs it through the DSP block. This data should have the same frequency as set in the input block in your impulse.
@@ -1228,7 +1340,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspRunResponse');
+        const resp = this.handleResponse(response, 'DspRunResponse');
+        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;
     }
     /**
      * Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
@@ -1320,7 +1440,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspRunResponseWithSample');
+        const resp = this.handleResponse(response, 'DspRunResponseWithSample');
+        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;
     }
     /**
      * Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
@@ -1406,7 +1534,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DspRunResponseWithSample');
+        const resp = this.handleResponse(response, 'DspRunResponseWithSample');
+        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;
     }
     /**
      * Set configuration parameters for the DSP block. Only values set in the body will be overwritten.
@@ -1480,7 +1616,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GenericApiResponse');
+        const resp = this.handleResponse(response, 'GenericApiResponse');
+        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 performance characteristics for a custom DSP block (needs `hasTfliteImplementation`). 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.
@@ -1554,7 +1698,15 @@ class DSPApi {
         url = authDefault.url;
         (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'StartJobResponse');
+        const resp = this.handleResponse(response, 'StartJobResponse');
+        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;
     }
 }
 exports.DSPApi = DSPApi;