edge-impulse-api 1.92.25 → 1.93.0

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

@@ -37,6 +37,7 @@ import { GetDiversityDataResponse } from '../model/getDiversityDataResponse';
 import { GetLabelNoiseDataResponse } from '../model/getLabelNoiseDataResponse';
 import { GetRawDataMetadataCooccurrenceResponse } from '../model/getRawDataMetadataCooccurrenceResponse';
 import { GetRawDataMetadataDistributionResponse } from '../model/getRawDataMetadataDistributionResponse';
+import { GetSampleDspResponse } from '../model/getSampleDspResponse';
 import { GetSampleMetadataFilterOptionsResponse } from '../model/getSampleMetadataFilterOptionsResponse';
 import { GetSampleMetadataResponse } from '../model/getSampleMetadataResponse';
 import { GetSampleResponse } from '../model/getSampleResponse';
@@ -310,6 +311,12 @@ type countSamplesQueryParams = {
     minDate?: Date;
     maxDate?: Date;
 };
+type cropSampleQueryParams = {
+    datastreamIndex?: number;
+};
+type findSegmentsInSampleQueryParams = {
+    datastreamIndex?: number;
+};
 type getAllImportedFromQueryParams = {
     limit?: number;
     offset?: number;
@@ -348,11 +355,13 @@ type getSampleAsImageQueryParams = {
     afterInputBlock?: boolean;
     cacheKey?: string;
     impulseId?: number;
+    datastreamIndex?: number;
 };
 type getSampleAsVideoQueryParams = {
     afterInputBlock?: boolean;
     cacheKey?: string;
     impulseId?: number;
+    datastreamIndex?: number;
 };
 type getSampleMetadataQueryParams = {
     category: RawDataFilterCategory;
@@ -366,6 +375,7 @@ type getSampleSliceQueryParams = {
     sliceStart: number;
     sliceEnd?: number;
     impulseId?: number;
+    datastreamIndex?: number;
     truncateStructuredLabels?: boolean;
 };
 type getUncroppedDownsampledSampleQueryParams = {
@@ -373,6 +383,7 @@ type getUncroppedDownsampledSampleQueryParams = {
     zoomStart?: number;
     zoomEnd?: number;
     impulseId?: number;
+    datastreamIndex?: number;
     truncateStructuredLabels?: boolean;
 };
 type listSamplesQueryParams = {
@@ -794,13 +805,14 @@ export declare class RawDataApi {
         };
     }): Promise<CountSamplesResponse>;
     /**
-     * Crop a sample to within a new range.
+     * Crop a sample to within a new range. cropStart/cropEnd are relative to the selected datastream. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is used.
      * @summary Crop sample
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param cropSampleRequest
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
-    cropSample(projectId: number, sampleId: number, cropSampleRequest: CropSampleRequest, options?: {
+    cropSample(projectId: number, sampleId: number, cropSampleRequest: CropSampleRequest, queryParams?: cropSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -872,13 +884,14 @@ export declare class RawDataApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * Find start and end times for all non-noise events in a sample
+     * Find start and end times for all non-noise events in a sample. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is used.
      * @summary Find segments
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param findSegmentSampleRequest
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
-    findSegmentsInSample(projectId: number, sampleId: number, findSegmentSampleRequest: FindSegmentSampleRequest, options?: {
+    findSegmentsInSample(projectId: number, sampleId: number, findSegmentSampleRequest: FindSegmentSampleRequest, queryParams?: findSegmentsInSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1058,6 +1071,7 @@ export declare class RawDataApi {
      * @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).
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
     getSampleAsImage(projectId: number, sampleId: number, queryParams?: getSampleAsImageQueryParams, options?: {
         headers: {
@@ -1083,6 +1097,7 @@ export declare class RawDataApi {
      * @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).
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
     getSampleAsVideo(projectId: number, sampleId: number, queryParams?: getSampleAsVideoQueryParams, options?: {
         headers: {
@@ -1114,20 +1129,21 @@ export declare class RawDataApi {
         };
     }): Promise<GetSampleMetadataFilterOptionsResponse>;
     /**
-     * Get a slice of a sample.
+     * Get a slice of a sample. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is returned. sliceStart / sliceEnd are relative to the datastream.
      * @summary Get sample slice
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param sliceStart Begin 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.
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      * @param truncateStructuredLabels If true, only a slice of labels will be returned for samples with multiple labels.
      */
     getSampleSlice(projectId: number, sampleId: number, queryParams: getSampleSliceQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GetSampleResponse>;
+    }): Promise<GetSampleDspResponse>;
     /**
      * Returns the results of a previously requested split preview job. This endpoint is used to retrieve the results after a split preview job has been started.
      * @summary Get split preview results
@@ -1139,7 +1155,7 @@ export declare class RawDataApi {
         };
     }): Promise<DatasetSplitPreviewResponse>;
     /**
-     * Get the original, uncropped, downsampled data.
+     * Get the original, uncropped, downsampled data. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is returned. The ZoomStart/ZoomEnd parameters should be relative to the selected datastream.
      * @summary Get the original downsampled data
      * @param projectId Project ID
      * @param sampleId Sample ID
@@ -1147,13 +1163,14 @@ export declare class RawDataApi {
      * @param zoomStart Zoom into the sample, with the focus starting at this index
      * @param zoomEnd Zoom into the sample, with the focus ending at this index
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      * @param truncateStructuredLabels If true, only a slice of labels will be returned for samples with multiple labels.
      */
     getUncroppedDownsampledSample(projectId: number, sampleId: number, queryParams?: getUncroppedDownsampledSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GetSampleResponse>;
+    }): Promise<GetSampleDspResponse>;
     /**
      * t-SNE2 output of the raw dataset
      * @summary Check data explorer features

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

@@ -2099,13 +2099,14 @@ class RawDataApi {
         return this.handleResponse(response, 'CountSamplesResponse');
     }
     /**
-     * Crop a sample to within a new range.
+     * Crop a sample to within a new range. cropStart/cropEnd are relative to the selected datastream. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is used.
      * @summary Crop sample
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param cropSampleRequest
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
-    async cropSample(projectId, sampleId, cropSampleRequest, options = { headers: {} }) {
+    async cropSample(projectId, sampleId, cropSampleRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/crop'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
             .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
@@ -2136,6 +2137,9 @@ class RawDataApi {
         if (cropSampleRequest === null || cropSampleRequest === undefined) {
             throw new Error('Required parameter cropSampleRequest was null or undefined when calling cropSample.');
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.datastreamIndex) !== undefined) {
+            localVarQueryParameters['datastreamIndex'] = models_1.ObjectSerializer.serialize(queryParams.datastreamIndex, "number");
+        }
         localVarHeaderParams = {
             ...localVarHeaderParams,
             ...options.headers,
@@ -2658,13 +2662,14 @@ class RawDataApi {
         return this.handleResponse(response, 'GenericApiResponse');
     }
     /**
-     * Find start and end times for all non-noise events in a sample
+     * Find start and end times for all non-noise events in a sample. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is used.
      * @summary Find segments
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param findSegmentSampleRequest
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
-    async findSegmentsInSample(projectId, sampleId, findSegmentSampleRequest, options = { headers: {} }) {
+    async findSegmentsInSample(projectId, sampleId, findSegmentSampleRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/find-segments'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
             .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
@@ -2695,6 +2700,9 @@ class RawDataApi {
         if (findSegmentSampleRequest === null || findSegmentSampleRequest === undefined) {
             throw new Error('Required parameter findSegmentSampleRequest was null or undefined when calling findSegmentsInSample.');
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.datastreamIndex) !== undefined) {
+            localVarQueryParameters['datastreamIndex'] = models_1.ObjectSerializer.serialize(queryParams.datastreamIndex, "number");
+        }
         localVarHeaderParams = {
             ...localVarHeaderParams,
             ...options.headers,
@@ -3910,6 +3918,7 @@ class RawDataApi {
      * @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).
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
     async getSampleAsImage(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/image'
@@ -3947,6 +3956,9 @@ class RawDataApi {
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
             localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.datastreamIndex) !== undefined) {
+            localVarQueryParameters['datastreamIndex'] = models_1.ObjectSerializer.serialize(queryParams.datastreamIndex, "number");
+        }
         localVarHeaderParams = {
             ...localVarHeaderParams,
             ...options.headers,
@@ -4080,6 +4092,7 @@ class RawDataApi {
      * @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).
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      */
     async getSampleAsVideo(projectId, sampleId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/video'
@@ -4117,6 +4130,9 @@ class RawDataApi {
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
             localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.datastreamIndex) !== undefined) {
+            localVarQueryParameters['datastreamIndex'] = models_1.ObjectSerializer.serialize(queryParams.datastreamIndex, "number");
+        }
         localVarHeaderParams = {
             ...localVarHeaderParams,
             ...options.headers,
@@ -4334,13 +4350,14 @@ class RawDataApi {
         return this.handleResponse(response, 'GetSampleMetadataFilterOptionsResponse');
     }
     /**
-     * Get a slice of a sample.
+     * Get a slice of a sample. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is returned. sliceStart / sliceEnd are relative to the datastream.
      * @summary Get sample slice
      * @param projectId Project ID
      * @param sampleId Sample ID
      * @param sliceStart Begin 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.
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      * @param truncateStructuredLabels If true, only a slice of labels will be returned for samples with multiple labels.
      */
     async getSampleSlice(projectId, sampleId, queryParams, options = { headers: {} }) {
@@ -4383,6 +4400,9 @@ class RawDataApi {
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
             localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.datastreamIndex) !== undefined) {
+            localVarQueryParameters['datastreamIndex'] = models_1.ObjectSerializer.serialize(queryParams.datastreamIndex, "number");
+        }
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateStructuredLabels) !== undefined) {
             localVarQueryParameters['truncateStructuredLabels'] = models_1.ObjectSerializer.serialize(queryParams.truncateStructuredLabels, "boolean");
         }
@@ -4430,7 +4450,7 @@ class RawDataApi {
             }
         }
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GetSampleResponse');
+        return this.handleResponse(response, 'GetSampleDspResponse');
     }
     /**
      * Returns the results of a previously requested split preview job. This endpoint is used to retrieve the results after a split preview job has been started.
@@ -4506,7 +4526,7 @@ class RawDataApi {
         return this.handleResponse(response, 'DatasetSplitPreviewResponse');
     }
     /**
-     * Get the original, uncropped, downsampled data.
+     * Get the original, uncropped, downsampled data. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is returned. The ZoomStart/ZoomEnd parameters should be relative to the selected datastream.
      * @summary Get the original downsampled data
      * @param projectId Project ID
      * @param sampleId Sample ID
@@ -4514,6 +4534,7 @@ class RawDataApi {
      * @param zoomStart Zoom into the sample, with the focus starting at this index
      * @param zoomEnd Zoom into the sample, with the focus ending at this index
      * @param impulseId Impulse ID. If this is unset then the default impulse is used.
+     * @param datastreamIndex Datastream index (defaults to 0)
      * @param truncateStructuredLabels If true, only a slice of labels will be returned for samples with multiple labels.
      */
     async getUncroppedDownsampledSample(projectId, sampleId, queryParams, options = { headers: {} }) {
@@ -4555,6 +4576,9 @@ class RawDataApi {
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== undefined) {
             localVarQueryParameters['impulseId'] = models_1.ObjectSerializer.serialize(queryParams.impulseId, "number");
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.datastreamIndex) !== undefined) {
+            localVarQueryParameters['datastreamIndex'] = models_1.ObjectSerializer.serialize(queryParams.datastreamIndex, "number");
+        }
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateStructuredLabels) !== undefined) {
             localVarQueryParameters['truncateStructuredLabels'] = models_1.ObjectSerializer.serialize(queryParams.truncateStructuredLabels, "boolean");
         }
@@ -4602,7 +4626,7 @@ class RawDataApi {
             }
         }
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GetSampleResponse');
+        return this.handleResponse(response, 'GetSampleDspResponse');
     }
     /**
      * t-SNE2 output of the raw dataset