edge-impulse-api 1.22.1 → 1.25.33

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

@@ -0,0 +1,849 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/// <reference types="node" />
+import { CountSamplesResponse } from '../model/countSamplesResponse';
+import { CropSampleRequest } from '../model/cropSampleRequest';
+import { CropSampleResponse } from '../model/cropSampleResponse';
+import { DataExplorerPredictionsResponse } from '../model/dataExplorerPredictionsResponse';
+import { DataExplorerSettings } from '../model/dataExplorerSettings';
+import { EditSampleLabelRequest } from '../model/editSampleLabelRequest';
+import { FindSegmentSampleRequest } from '../model/findSegmentSampleRequest';
+import { FindSegmentSampleResponse } from '../model/findSegmentSampleResponse';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetAllImportedFromResponse } from '../model/getAllImportedFromResponse';
+import { GetAutoSegmenterResponse } from '../model/getAutoSegmenterResponse';
+import { GetDataExplorerFeaturesResponse } from '../model/getDataExplorerFeaturesResponse';
+import { GetDataExplorerSettingsResponse } from '../model/getDataExplorerSettingsResponse';
+import { GetDiversityDataResponse } from '../model/getDiversityDataResponse';
+import { GetSampleMetadataResponse } from '../model/getSampleMetadataResponse';
+import { GetSampleResponse } from '../model/getSampleResponse';
+import { HasDataExplorerFeaturesResponse } from '../model/hasDataExplorerFeaturesResponse';
+import { ListSamplesResponse } from '../model/listSamplesResponse';
+import { MoveRawDataRequest } from '../model/moveRawDataRequest';
+import { ObjectDetectionAutoLabelRequest } from '../model/objectDetectionAutoLabelRequest';
+import { ObjectDetectionAutoLabelResponse } from '../model/objectDetectionAutoLabelResponse';
+import { ObjectDetectionLabelQueueCountResponse } from '../model/objectDetectionLabelQueueCountResponse';
+import { ObjectDetectionLabelQueueResponse } from '../model/objectDetectionLabelQueueResponse';
+import { RebalanceDatasetResponse } from '../model/rebalanceDatasetResponse';
+import { RenameSampleRequest } from '../model/renameSampleRequest';
+import { RunAutoSegmenterRequest } from '../model/runAutoSegmenterRequest';
+import { SampleBoundingBoxesRequest } from '../model/sampleBoundingBoxesRequest';
+import { SaveAutoSegmenterClustersRequest } from '../model/saveAutoSegmenterClustersRequest';
+import { SaveAutoSegmenterClustersResponse } from '../model/saveAutoSegmenterClustersResponse';
+import { SegmentSampleRequest } from '../model/segmentSampleRequest';
+import { SetSampleMetadataRequest } from '../model/setSampleMetadataRequest';
+import { SplitSampleInFramesRequest } from '../model/splitSampleInFramesRequest';
+import { StartJobResponse } from '../model/startJobResponse';
+import { StoreSegmentLengthRequest } from '../model/storeSegmentLengthRequest';
+import { TrackObjectsRequest } from '../model/trackObjectsRequest';
+import { TrackObjectsResponse } from '../model/trackObjectsResponse';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum RawDataApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type batchDeleteQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+};
+declare type batchDisableQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+};
+declare type batchEditLabelsQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+};
+declare type batchEnableQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+};
+declare type batchMoveQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+    ids?: string;
+    excludeIds?: string;
+};
+declare type countSamplesQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+};
+declare type getAllImportedFromQueryParams = {
+    limit?: number;
+    offset?: number;
+};
+declare type getAutoSegmenterImageQueryParams = {
+    image: string;
+};
+declare type getSampleQueryParams = {
+    limitPayloadValues?: number;
+};
+declare type getSampleAsAudioQueryParams = {
+    axisIx: number;
+    sliceStart?: number;
+    sliceEnd?: number;
+};
+declare type getSampleAsImageQueryParams = {
+    afterInputBlock?: boolean;
+};
+declare type getSampleAsVideoQueryParams = {
+    afterInputBlock?: boolean;
+};
+declare type getSampleMetadataQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+};
+declare type getSampleSliceQueryParams = {
+    sliceStart: number;
+    sliceEnd: number;
+};
+declare type getUncroppedDownsampledSampleQueryParams = {
+    limitPayloadValues?: number;
+    zoomStart?: number;
+    zoomEnd?: number;
+};
+declare type listSamplesQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    limit?: number;
+    offset?: number;
+    excludeSensors?: boolean;
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+};
+declare type uploadDataExplorerScreenshotFormParams = {
+    image: RequestFile;
+};
+export declare type RawDataApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class RawDataApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: RawDataApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: RawDataApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: RawDataApiOpts);
+    get opts(): RawDataApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: RawDataApiApiKeys, value: string | undefined): void;
+    /**
+     * Deletes samples. Note that this does not delete the data from cold storage.
+     * @summary Remove multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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 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
+     */
+    batchDelete(projectId: number, queryParams: batchDeleteQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Disables samples, ensuring that they are excluded from the dataset.
+     * @summary Disable multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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 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
+     */
+    batchDisable(projectId: number, queryParams: batchDisableQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Sets the label (also known as class) of multiple samples.
+     * @summary Edit labels for multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param editSampleLabelRequest
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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 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
+     */
+    batchEditLabels(projectId: number, editSampleLabelRequest: EditSampleLabelRequest, queryParams: batchEditLabelsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Enables samples, ensuring that they are not excluded from the dataset.
+     * @summary Enable multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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 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
+     */
+    batchEnable(projectId: number, queryParams: batchEnableQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Move multiple samples to another category (e.g. from test to training).
+     * @summary Move multiple samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param moveRawDataRequest
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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 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
+     */
+    batchMove(projectId: number, moveRawDataRequest: MoveRawDataRequest, queryParams: batchMoveQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Classify an image using another neural network.
+     * @summary Auto-label an image
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param objectDetectionAutoLabelRequest
+     */
+    classifyUsingAutolabel(projectId: number, sampleId: number, objectDetectionAutoLabelRequest: ObjectDetectionAutoLabelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ObjectDetectionAutoLabelResponse>;
+    /**
+     * Clears all object detection labels for this dataset, and places all images back in the labeling queue.
+     * @summary Clear all object detection labels
+     * @param projectId Project ID
+     */
+    clearAllObjectDetectionLabels(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Remove the current data explorer state
+     * @summary Clear data explorer
+     * @param projectId Project ID
+     */
+    clearDataExplorer(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Count all raw data by category.
+     * @summary Count samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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)
+     */
+    countSamples(projectId: number, queryParams: countSamplesQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CountSamplesResponse>;
+    /**
+     * Crop a sample to within a new range.
+     * @summary Crop sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param cropSampleRequest
+     */
+    cropSample(projectId: number, sampleId: number, cropSampleRequest: CropSampleRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CropSampleResponse>;
+    /**
+     * Deletes all samples for this project over all categories. This also invalidates all DSP and learn blocks. Note that this does not delete the data from cold storage.
+     * @summary Remove all samples
+     * @param projectId Project ID
+     */
+    deleteAllSamples(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Deletes all samples for this project over a single category. Note that this does not delete the data from cold storage.
+     * @summary Remove all samples by category
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to download data from
+     */
+    deleteAllSamplesByCategory(projectId: number, category: 'training' | 'testing' | 'anomaly', options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Deletes the sample. Note that this does not delete the data from cold storage.
+     * @summary Remove sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     */
+    deleteSample(projectId: number, sampleId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Disable a sample, ensuring that it is excluded from the dataset.
+     * @summary Disable sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     */
+    disableSample(projectId: number, sampleId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training.
+     * @summary Edit label
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param editSampleLabelRequest
+     */
+    editLabel(projectId: number, sampleId: number, editSampleLabelRequest: EditSampleLabelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Enable a sample, ensuring that it is not excluded from the dataset.
+     * @summary Enable sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     */
+    enableSample(projectId: number, sampleId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Find start and end times for all non-noise events in a sample
+     * @summary Find segments
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param findSegmentSampleRequest
+     */
+    findSegmentsInSample(projectId: number, sampleId: number, findSegmentSampleRequest: FindSegmentSampleRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<FindSegmentSampleResponse>;
+    /**
+     * Lists all data with an \'imported from\' metadata key. Used to check in a data source which items are already in a project.
+     * @summary List data with \"imported from\" metadata key
+     * @param projectId Project ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    getAllImportedFrom(projectId: number, queryParams: getAllImportedFromQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetAllImportedFromResponse>;
+    /**
+     * Retrieve the results of the auto-segmenter (after running `StartJobResponse`)
+     * @summary Get auto-segmenter results
+     * @param projectId Project ID
+     */
+    getAutoSegmenter(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetAutoSegmenterResponse>;
+    /**
+     * Grab a segment image from the auto-segmenter
+     * @summary Get auto-segmenter image
+     * @param projectId Project ID
+     * @param image Which image to receive from the auto-segmenter
+     */
+    getAutoSegmenterImage(projectId: number, queryParams: getAutoSegmenterImageQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * t-SNE2 output of the raw dataset
+     * @summary Get data explorer features
+     * @param projectId Project ID
+     */
+    getDataExplorerFeatures(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetDataExplorerFeaturesResponse>;
+    /**
+     * Predictions for every data explorer point (only available when using current impulse to populate data explorer)
+     * @summary Get data explorer predictions
+     * @param projectId Project ID
+     */
+    getDataExplorerPredictions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<DataExplorerPredictionsResponse>;
+    /**
+     * Get data explorer configuration, like the type of data, and the input / dsp block to use.
+     * @summary Get data explorer settings
+     * @param projectId Project ID
+     */
+    getDataExplorerSettings(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetDataExplorerSettingsResponse>;
+    /**
+     * Structure describing the similarity and diversity of a dataset
+     * @summary Get diversity visualization data
+     * @param projectId Project ID
+     */
+    getDiversityData(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetDiversityDataResponse>;
+    /**
+     * Get all unlabeled items from the object detection queue.
+     * @summary Object detection label queue
+     * @param projectId Project ID
+     */
+    getObjectDetectionLabelQueue(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ObjectDetectionLabelQueueResponse>;
+    /**
+     * Get count for unlabeled items from the object detection queue.
+     * @summary Object detection label queue count
+     * @param projectId Project ID
+     */
+    getObjectDetectionLabelQueueCount(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ObjectDetectionLabelQueueCountResponse>;
+    /**
+     * Get a sample.
+     * @summary Get sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param limitPayloadValues Limit the number of payload values in the response
+     */
+    getSample(projectId: number, sampleId: number, queryParams: getSampleQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetSampleResponse>;
+    /**
+     * Get a sample as a WAV file. This only applies to samples with an audio axis.
+     * @summary Get WAV file
+     * @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
+     */
+    getSampleAsAudio(projectId: number, sampleId: number, queryParams: getSampleAsAudioQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Get a sample as an image file. This only applies to samples with RGBA data.
+     * @summary Get image file
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param afterInputBlock Whether to process the image through the input block first
+     */
+    getSampleAsImage(projectId: number, sampleId: number, queryParams: getSampleAsImageQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download a sample in it\'s original format as uploaded to the ingestion service.
+     * @summary Download file
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     */
+    getSampleAsRaw(projectId: number, sampleId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Get a sample as an video file. This only applies to samples with video data.
+     * @summary Get video file
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param afterInputBlock Whether to process the image through the input block first
+     */
+    getSampleAsVideo(projectId: number, sampleId: number, queryParams: getSampleAsVideoQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Get metadata for all samples in a project.
+     * @summary Get project sample metadata
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     */
+    getSampleMetadata(projectId: number, queryParams: getSampleMetadataQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetSampleMetadataResponse>;
+    /**
+     * Get a slice of a sample.
+     * @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
+     */
+    getSampleSlice(projectId: number, sampleId: number, queryParams: getSampleSliceQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetSampleResponse>;
+    /**
+     * Get the original, uncropped, downsampled data.
+     * @summary Get the original downsampled data
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param limitPayloadValues Limit the number of payload values in the response
+     * @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
+     */
+    getUncroppedDownsampledSample(projectId: number, sampleId: number, queryParams: getUncroppedDownsampledSampleQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetSampleResponse>;
+    /**
+     * t-SNE2 output of the raw dataset
+     * @summary Check data explorer features
+     * @param projectId Project ID
+     */
+    hasDataExplorerFeatures(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<HasDataExplorerFeaturesResponse>;
+    /**
+     * Determine if data diversity metrics have been calculated
+     * @summary Check if data diversity metrics exist
+     * @param projectId Project ID
+     */
+    hasDiversityData(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<HasDataExplorerFeaturesResponse>;
+    /**
+     * Retrieve all raw data by category.
+     * @summary List samples
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param excludeSensors Whether to exclude sensors in the response (as these can slow down requests when you have large pages).
+     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
+     * @param filename Only include samples whose filename includes the given filename
+     * @param maxLength Only include samples shorter than the given length, in milliseconds
+     * @param minLength Only include samples longer than the given length, in milliseconds
+     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
+     * @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)
+     */
+    listSamples(projectId: number, queryParams: listSamplesQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListSamplesResponse>;
+    /**
+     * Move a sample to another category (e.g. from test to training).
+     * @summary Move sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param moveRawDataRequest
+     */
+    moveSample(projectId: number, sampleId: number, moveRawDataRequest: MoveRawDataRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.
+     * @summary Rebalance dataset
+     * @param projectId Project ID
+     */
+    rebalanceDataset(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<RebalanceDatasetResponse>;
+    /**
+     * Sets the file name of the sample. This name does not need to be unique, but it\'s highly recommended to do so.
+     * @summary Rename sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param renameSampleRequest
+     */
+    renameSample(projectId: number, sampleId: number, renameSampleRequest: RenameSampleRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * If a sample failed processing, retry the processing operation.
+     * @summary Retry processing
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     */
+    retryProcessing(projectId: number, sampleId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Run the auto-segmenter over all unlabeled data.
+     * @summary Run auto-segmenter job
+     * @param projectId Project ID
+     * @param runAutoSegmenterRequest
+     */
+    runAutoSegmenter(projectId: number, runAutoSegmenterRequest: RunAutoSegmenterRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Set labels for all auto-segment clusters.
+     * @summary Save auto-segmenter clusters
+     * @param projectId Project ID
+     * @param saveAutoSegmenterClustersRequest
+     */
+    saveAutoSegmenterClusters(projectId: number, saveAutoSegmenterClustersRequest: SaveAutoSegmenterClustersRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<SaveAutoSegmenterClustersResponse>;
+    /**
+     * Slice a sample into multiple segments. The original file will be marked as deleted, but you can crop any created segment to retrieve the original file.
+     * @summary Segment sample
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param segmentSampleRequest
+     */
+    segmentSample(projectId: number, sampleId: number, segmentSampleRequest: SegmentSampleRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Set data explorer configuration, like the type of data, and the input / dsp block to use.
+     * @summary Set data explorer settings
+     * @param projectId Project ID
+     * @param dataExplorerSettings
+     */
+    setDataExplorerSettings(projectId: number, dataExplorerSettings: DataExplorerSettings, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Set the bounding boxes for a sample
+     * @summary Set bounding boxes
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param sampleBoundingBoxesRequest
+     */
+    setSampleBoundingBoxes(projectId: number, sampleId: number, sampleBoundingBoxesRequest: SampleBoundingBoxesRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Adds or updates the metadata associated to a sample.
+     * @summary Set sample metadata
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param setSampleMetadataRequest
+     */
+    setSampleMetadata(projectId: number, sampleId: number, setSampleMetadataRequest: SetSampleMetadataRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Split a video sample into individual frames.
+     * @summary Split sample into frames
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param splitSampleInFramesRequest
+     */
+    splitSampleInFrames(projectId: number, sampleId: number, splitSampleInFramesRequest: SplitSampleInFramesRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
+     * @summary Store the last segment length
+     * @param projectId Project ID
+     * @param storeSegmentLengthRequest
+     */
+    storeSegmentLength(projectId: number, storeSegmentLengthRequest: StoreSegmentLengthRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Track objects between two samples. Source sample should have bounding boxes set.
+     * @summary Track objects
+     * @param projectId Project ID
+     * @param trackObjectsRequest
+     */
+    trackObjects(projectId: number, trackObjectsRequest: TrackObjectsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<TrackObjectsResponse>;
+    /**
+     * Used internally (from a data pipeline) to upload a picture of the data explorer
+     * @summary Upload a data explorer screenshot
+     * @param projectId Project ID
+     * @param image
+     */
+    uploadDataExplorerScreenshot(projectId: number, params: uploadDataExplorerScreenshotFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};