edge-impulse-linux 1.5.1 → 1.6.0

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

@@ -68,6 +68,7 @@ declare type batchDeleteQueryParams = {
     includeDisabled?: 'both' | 'enabled' | 'disabled';
     ids?: string;
     excludeIds?: string;
+    search?: string;
 };
 declare type batchDisableQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
@@ -81,6 +82,7 @@ declare type batchDisableQueryParams = {
     includeDisabled?: 'both' | 'enabled' | 'disabled';
     ids?: string;
     excludeIds?: string;
+    search?: string;
 };
 declare type batchEditLabelsQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
@@ -94,6 +96,7 @@ declare type batchEditLabelsQueryParams = {
     includeDisabled?: 'both' | 'enabled' | 'disabled';
     ids?: string;
     excludeIds?: string;
+    search?: string;
 };
 declare type batchEnableQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
@@ -107,6 +110,7 @@ declare type batchEnableQueryParams = {
     includeDisabled?: 'both' | 'enabled' | 'disabled';
     ids?: string;
     excludeIds?: string;
+    search?: string;
 };
 declare type batchMoveQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
@@ -120,6 +124,7 @@ declare type batchMoveQueryParams = {
     includeDisabled?: 'both' | 'enabled' | 'disabled';
     ids?: string;
     excludeIds?: string;
+    search?: string;
 };
 declare type countSamplesQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
@@ -131,6 +136,7 @@ declare type countSamplesQueryParams = {
     maxFrequency?: number;
     signatureValidity?: 'both' | 'valid' | 'invalid';
     includeDisabled?: 'both' | 'enabled' | 'disabled';
+    search?: string;
 };
 declare type getAllImportedFromQueryParams = {
     limit?: number;
@@ -141,24 +147,28 @@ declare type getAutoLabelerImageQueryParams = {
 };
 declare type getSampleQueryParams = {
     limitPayloadValues?: number;
+    cacheKey?: string;
 };
 declare type getSampleAsAudioQueryParams = {
     axisIx: number;
     sliceStart?: number;
     sliceEnd?: number;
+    cacheKey?: string;
 };
 declare type getSampleAsImageQueryParams = {
     afterInputBlock?: boolean;
+    cacheKey?: string;
 };
 declare type getSampleAsVideoQueryParams = {
     afterInputBlock?: boolean;
+    cacheKey?: string;
 };
 declare type getSampleMetadataQueryParams = {
     category: 'training' | 'testing' | 'anomaly';
 };
 declare type getSampleSliceQueryParams = {
     sliceStart: number;
-    sliceEnd: number;
+    sliceEnd?: number;
 };
 declare type getUncroppedDownsampledSampleQueryParams = {
     limitPayloadValues?: number;
@@ -178,6 +188,8 @@ declare type listSamplesQueryParams = {
     maxFrequency?: number;
     signatureValidity?: 'both' | 'valid' | 'invalid';
     includeDisabled?: 'both' | 'enabled' | 'disabled';
+    saveAsDefaultLimit?: boolean;
+    search?: string;
 };
 declare type uploadDataExplorerScreenshotFormParams = {
     image: RequestFile;
@@ -221,6 +233,7 @@ export declare class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     batchDelete(projectId: number, queryParams: batchDeleteQueryParams, options?: {
         headers: {
@@ -242,6 +255,7 @@ export declare class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     batchDisable(projectId: number, queryParams: batchDisableQueryParams, options?: {
         headers: {
@@ -264,6 +278,7 @@ export declare class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     batchEditLabels(projectId: number, editSampleLabelRequest: EditSampleLabelRequest, queryParams: batchEditLabelsQueryParams, options?: {
         headers: {
@@ -285,6 +300,7 @@ export declare class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     batchEnable(projectId: number, queryParams: batchEnableQueryParams, options?: {
         headers: {
@@ -307,6 +323,7 @@ export declare class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     batchMove(projectId: number, moveRawDataRequest: MoveRawDataRequest, queryParams: batchMoveQueryParams, options?: {
         headers: {
@@ -358,6 +375,7 @@ export declare class RawDataApi {
      * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param search Search query
      */
     countSamples(projectId: number, queryParams: countSamplesQueryParams, options?: {
         headers: {
@@ -563,6 +581,7 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param limitPayloadValues Limit the number of payload values in the response
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     getSample(projectId: number, sampleId: number, queryParams: getSampleQueryParams, options?: {
         headers: {
@@ -575,8 +594,9 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param axisIx Axis index
-     * @param sliceStart Begin index of the slice
-     * @param sliceEnd End index of the slice
+     * @param sliceStart Begin index of the slice. If not given, the whole sample is used.
+     * @param sliceEnd End index of the slice. If not given, the whole sample is used.
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     getSampleAsAudio(projectId: number, sampleId: number, queryParams: getSampleAsAudioQueryParams, options?: {
         headers: {
@@ -589,6 +609,7 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     getSampleAsImage(projectId: number, sampleId: number, queryParams: getSampleAsImageQueryParams, options?: {
         headers: {
@@ -612,6 +633,7 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     getSampleAsVideo(projectId: number, sampleId: number, queryParams: getSampleAsVideoQueryParams, options?: {
         headers: {
@@ -635,7 +657,7 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param sliceStart Begin index of the slice
-     * @param sliceEnd End index of the slice
+     * @param sliceEnd End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.
      */
     getSampleSlice(projectId: number, sampleId: number, queryParams: getSampleSliceQueryParams, options?: {
         headers: {
@@ -702,6 +724,8 @@ export declare class RawDataApi {
      * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param saveAsDefaultLimit If set, then the default page size is overwritten with the current limit.
+     * @param search Search query
      */
     listSamples(projectId: number, queryParams: listSamplesQueryParams, options?: {
         headers: {

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

@@ -89,6 +89,7 @@ class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     async batchDelete(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/delete'
@@ -147,6 +148,9 @@ class RawDataApi {
         if (queryParams.excludeIds !== undefined) {
             localVarQueryParameters['excludeIds'] = models_1.ObjectSerializer.serialize(queryParams.excludeIds, "string");
         }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -210,6 +214,7 @@ class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     async batchDisable(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/disable-samples'
@@ -268,6 +273,9 @@ class RawDataApi {
         if (queryParams.excludeIds !== undefined) {
             localVarQueryParameters['excludeIds'] = models_1.ObjectSerializer.serialize(queryParams.excludeIds, "string");
         }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -332,6 +340,7 @@ class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     async batchEditLabels(projectId, editSampleLabelRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/edit-labels'
@@ -394,6 +403,9 @@ class RawDataApi {
         if (queryParams.excludeIds !== undefined) {
             localVarQueryParameters['excludeIds'] = models_1.ObjectSerializer.serialize(queryParams.excludeIds, "string");
         }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -458,6 +470,7 @@ class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     async batchEnable(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/enable-samples'
@@ -516,6 +529,9 @@ class RawDataApi {
         if (queryParams.excludeIds !== undefined) {
             localVarQueryParameters['excludeIds'] = models_1.ObjectSerializer.serialize(queryParams.excludeIds, "string");
         }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -580,6 +596,7 @@ class RawDataApi {
      * @param includeDisabled Include only enabled or disabled samples (or both)
      * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
      * @param excludeIds Exclude samples with an ID within the given list of IDs, given as a JSON string
+     * @param search Search query
      */
     async batchMove(projectId, moveRawDataRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/moveSamples'
@@ -642,6 +659,9 @@ class RawDataApi {
         if (queryParams.excludeIds !== undefined) {
             localVarQueryParameters['excludeIds'] = models_1.ObjectSerializer.serialize(queryParams.excludeIds, "string");
         }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -935,6 +955,7 @@ class RawDataApi {
      * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param search Search query
      */
     async countSamples(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/count'
@@ -987,6 +1008,9 @@ class RawDataApi {
         if (queryParams.includeDisabled !== undefined) {
             localVarQueryParameters['includeDisabled'] = models_1.ObjectSerializer.serialize(queryParams.includeDisabled, "'both' | 'enabled' | 'disabled'");
         }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -2431,6 +2455,7 @@ class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param limitPayloadValues Limit the number of payload values in the response
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     async getSample(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}'
@@ -2460,6 +2485,9 @@ class RawDataApi {
         if (queryParams.limitPayloadValues !== undefined) {
             localVarQueryParameters['limitPayloadValues'] = models_1.ObjectSerializer.serialize(queryParams.limitPayloadValues, "number");
         }
+        if (queryParams.cacheKey !== undefined) {
+            localVarQueryParameters['cacheKey'] = models_1.ObjectSerializer.serialize(queryParams.cacheKey, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -2514,8 +2542,9 @@ class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param axisIx Axis index
-     * @param sliceStart Begin index of the slice
-     * @param sliceEnd End index of the slice
+     * @param sliceStart Begin index of the slice. If not given, the whole sample is used.
+     * @param sliceEnd End index of the slice. If not given, the whole sample is used.
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     async getSampleAsAudio(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/wav'
@@ -2555,6 +2584,9 @@ class RawDataApi {
         if (queryParams.sliceEnd !== undefined) {
             localVarQueryParameters['sliceEnd'] = models_1.ObjectSerializer.serialize(queryParams.sliceEnd, "number");
         }
+        if (queryParams.cacheKey !== undefined) {
+            localVarQueryParameters['cacheKey'] = models_1.ObjectSerializer.serialize(queryParams.cacheKey, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -2609,6 +2641,7 @@ class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     async getSampleAsImage(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/image'
@@ -2638,6 +2671,9 @@ class RawDataApi {
         if (queryParams.afterInputBlock !== undefined) {
             localVarQueryParameters['afterInputBlock'] = models_1.ObjectSerializer.serialize(queryParams.afterInputBlock, "boolean");
         }
+        if (queryParams.cacheKey !== undefined) {
+            localVarQueryParameters['cacheKey'] = models_1.ObjectSerializer.serialize(queryParams.cacheKey, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -2771,6 +2807,7 @@ class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
+     * @param cacheKey If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
      */
     async getSampleAsVideo(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/video'
@@ -2800,6 +2837,9 @@ class RawDataApi {
         if (queryParams.afterInputBlock !== undefined) {
             localVarQueryParameters['afterInputBlock'] = models_1.ObjectSerializer.serialize(queryParams.afterInputBlock, "boolean");
         }
+        if (queryParams.cacheKey !== undefined) {
+            localVarQueryParameters['cacheKey'] = models_1.ObjectSerializer.serialize(queryParams.cacheKey, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -2935,7 +2975,7 @@ class RawDataApi {
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param sliceStart Begin index of the slice
-     * @param sliceEnd End index of the slice
+     * @param sliceEnd End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.
      */
     async getSampleSlice(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/slice'
@@ -2966,10 +3006,6 @@ class RawDataApi {
         if (queryParams.sliceStart === null || queryParams.sliceStart === undefined) {
             throw new Error('Required parameter queryParams.sliceStart was null or undefined when calling getSampleSlice.');
         }
-        // verify required parameter 'sliceEnd' is not null or undefined
-        if (queryParams.sliceEnd === null || queryParams.sliceEnd === undefined) {
-            throw new Error('Required parameter queryParams.sliceEnd was null or undefined when calling getSampleSlice.');
-        }
         if (queryParams.sliceStart !== undefined) {
             localVarQueryParameters['sliceStart'] = models_1.ObjectSerializer.serialize(queryParams.sliceStart, "number");
         }
@@ -3350,6 +3386,8 @@ class RawDataApi {
      * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
+     * @param saveAsDefaultLimit If set, then the default page size is overwritten with the current limit.
+     * @param search Search query
      */
     async listSamples(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data'
@@ -3411,6 +3449,12 @@ class RawDataApi {
         if (queryParams.includeDisabled !== undefined) {
             localVarQueryParameters['includeDisabled'] = models_1.ObjectSerializer.serialize(queryParams.includeDisabled, "'both' | 'enabled' | 'disabled'");
         }
+        if (queryParams.saveAsDefaultLimit !== undefined) {
+            localVarQueryParameters['saveAsDefaultLimit'] = models_1.ObjectSerializer.serialize(queryParams.saveAsDefaultLimit, "boolean");
+        }
+        if (queryParams.search !== undefined) {
+            localVarQueryParameters['search'] = models_1.ObjectSerializer.serialize(queryParams.search, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;