edge-impulse-linux 1.24.3 → 1.25.1

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

@@ -21,6 +21,8 @@ import { CropSampleRequest } from '../model/cropSampleRequest';
 import { CropSampleResponse } from '../model/cropSampleResponse';
 import { DataExplorerPredictionsResponse } from '../model/dataExplorerPredictionsResponse';
 import { DataExplorerSettings } from '../model/dataExplorerSettings';
+import { DatasetSplitOptions } from '../model/datasetSplitOptions';
+import { DatasetSplitPreviewResponse } from '../model/datasetSplitPreviewResponse';
 import { EditSampleLabelRequest } from '../model/editSampleLabelRequest';
 import { FindSegmentSampleRequest } from '../model/findSegmentSampleRequest';
 import { FindSegmentSampleResponse } from '../model/findSegmentSampleResponse';
@@ -33,6 +35,9 @@ import { GetDataExplorerSettingsResponse } from '../model/getDataExplorerSetting
 import { GetDatasetRatioResponse } from '../model/getDatasetRatioResponse';
 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';
@@ -306,10 +311,33 @@ type countSamplesQueryParams = {
     minDate?: Date;
     maxDate?: Date;
 };
+type cropSampleQueryParams = {
+    datastreamIndex?: number;
+};
+type findSegmentsInSampleQueryParams = {
+    datastreamIndex?: number;
+};
 type getAllImportedFromQueryParams = {
     limit?: number;
     offset?: number;
 };
+type getRawDataMetadataCooccurrenceQueryParams = {
+    category: RawDataCategory;
+    keyA: string;
+    keyB: string;
+    topNKeyA?: number;
+    topNKeyB?: number;
+    normalize?: 'none' | 'global';
+    excludeDisabledSamples?: boolean;
+};
+type getRawDataMetadataDistributionQueryParams = {
+    category: RawDataCategory;
+    key: string;
+    topN?: number;
+    binCount?: number;
+    groupByLabel?: boolean;
+    excludeDisabledSamples?: boolean;
+};
 type getSampleQueryParams = {
     limitPayloadValues?: number;
     cacheKey?: string;
@@ -327,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;
@@ -345,6 +375,7 @@ type getSampleSliceQueryParams = {
     sliceStart: number;
     sliceEnd?: number;
     impulseId?: number;
+    datastreamIndex?: number;
     truncateStructuredLabels?: boolean;
 };
 type getUncroppedDownsampledSampleQueryParams = {
@@ -352,6 +383,7 @@ type getUncroppedDownsampledSampleQueryParams = {
     zoomStart?: number;
     zoomEnd?: number;
     impulseId?: number;
+    datastreamIndex?: number;
     truncateStructuredLabels?: boolean;
 };
 type listSamplesQueryParams = {
@@ -773,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;
         };
@@ -851,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;
         };
@@ -965,6 +999,39 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<ObjectDetectionLabelQueueCountResponse>;
+    /**
+     * Get co-occurrence counts for two metadata keys in a project category. This is experimental and may change in the future.
+     * @summary Get project metadata co-occurrence matrix
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param keyA First metadata key to aggregate values for
+     * @param keyB Second metadata key to aggregate values for
+     * @param topNKeyA Maximum number of top values to return for keyA
+     * @param topNKeyB Maximum number of top values to return for keyB
+     * @param normalize Controls how normalizedMatrix is computed. Use none to disable normalization (normalizedMatrix omitted), or global to return percentages across all matrix cells.
+     * @param excludeDisabledSamples Whether to exclude samples that are marked as disabled.
+     */
+    getRawDataMetadataCooccurrence(projectId: number, queryParams: getRawDataMetadataCooccurrenceQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetRawDataMetadataCooccurrenceResponse>;
+    /**
+     * Get metadata value distribution for a specific metadata key in a project category. Numeric values are returned as histogram buckets, non-numeric values as categorical counts. This is experimental and may change in the future.
+     * @summary Get project sample metadata distribution
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param key Metadata key to aggregate values for
+     * @param topN Maximum number of top categories to return for categorical values
+     * @param binCount Number of bins to use for numeric histogram values
+     * @param groupByLabel Include per-label breakdown for each bucket
+     * @param excludeDisabledSamples Whether to exclude samples that are marked as disabled.
+     */
+    getRawDataMetadataDistribution(projectId: number, queryParams: getRawDataMetadataDistributionQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetRawDataMetadataDistributionResponse>;
     /**
      * Get a sample.
      * @summary Get sample
@@ -1004,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: {
@@ -1029,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: {
@@ -1060,22 +1129,33 @@ 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>;
     /**
-     * Get the original, uncropped, downsampled data.
+     * 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
+     * @param projectId Project ID
+     */
+    getSplitPreviewResults(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<DatasetSplitPreviewResponse>;
+    /**
+     * 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
@@ -1083,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
@@ -1315,6 +1396,28 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Performs a deterministic, in-place split of the project\'s dataset into \"training\", \"testing\", and optional \"validation\" sets. Split balancing can use the label, one or more metadata keys, or both as a composite grouping signal. Related samples can also be kept together across splits by metadata key. This is a deterministic process based on the hash of the name of the data. Returns immediately on small datasets, or starts a job on larger datasets. For example:     { \"trainingSplitRatio\": 0.8, \"testingSplitRatio\": 0.1, \"validationSplitRatio\": 0.1, \"excludeDisabledSamples\": false, \"stratifyBy\": { \"label\": true, \"metadataKeys\": [\"site\", \"scanner\"] }, \"keepTogetherMetadataKeys\": [\"capture_group\"] }     With these options, label/site/scanner are used to balance the split, while samples sharing the same capture_group value stay in the same split bucket.
+     * @summary Split dataset
+     * @param projectId Project ID
+     * @param datasetSplitOptions
+     */
+    splitDataset(projectId: number, datasetSplitOptions: DatasetSplitOptions, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse | StartJobResponse>;
+    /**
+     * Returns a preview of how the project\'s dataset would be split if the current split options were applied. For each group (composite of label and/or metadata keys, or keep-together group), shows the number and percentage of samples that would be assigned to each split. This does not update the dataset, only provides a summary. Returns immediately on small datasets, or starts a job on larger datasets.
+     * @summary Split dataset preview
+     * @param projectId Project ID
+     * @param datasetSplitOptions
+     */
+    splitDatasetPreview(projectId: number, datasetSplitOptions: DatasetSplitOptions, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<DatasetSplitPreviewResponse | StartJobResponse>;
     /**
      * Split a video sample into individual frames. Depending on the length of the video sample this will either execute immediately or return the ID of a job that will perform this action.
      * @summary Split sample into frames