edge-impulse-linux 1.4.1 → 1.4.3

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

@@ -21,6 +21,7 @@ import { FindSegmentSampleResponse } from '../model/findSegmentSampleResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetDataExplorerFeaturesResponse } from '../model/getDataExplorerFeaturesResponse';
 import { GetDataExplorerSettingsResponse } from '../model/getDataExplorerSettingsResponse';
+import { GetSampleMetadataResponse } from '../model/getSampleMetadataResponse';
 import { GetSampleResponse } from '../model/getSampleResponse';
 import { HasDataExplorerFeaturesResponse } from '../model/hasDataExplorerFeaturesResponse';
 import { ListSamplesResponse } from '../model/listSamplesResponse';
@@ -46,20 +47,142 @@ export declare enum RawDataApiApiKeys {
     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;
+};
+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;
+};
+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;
+};
+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;
+};
+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;
+};
+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 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);
+    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;
     /**
@@ -77,7 +200,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
      */
-    batchDelete(projectId: number, 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, options?: {
+    batchDelete(projectId: number, queryParams: batchDeleteQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -97,7 +220,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
      */
-    batchDisable(projectId: number, 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, options?: {
+    batchDisable(projectId: number, queryParams: batchDisableQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -118,7 +241,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
      */
-    batchEditLabels(projectId: number, category: 'training' | 'testing' | 'anomaly', editSampleLabelRequest: EditSampleLabelRequest, labels?: string, filename?: string, maxLength?: number, minLength?: number, minFrequency?: number, maxFrequency?: number, signatureValidity?: 'both' | 'valid' | 'invalid', includeDisabled?: 'both' | 'enabled' | 'disabled', ids?: string, options?: {
+    batchEditLabels(projectId: number, editSampleLabelRequest: EditSampleLabelRequest, queryParams: batchEditLabelsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -138,7 +261,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
      */
-    batchEnable(projectId: number, 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, options?: {
+    batchEnable(projectId: number, queryParams: batchEnableQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -159,7 +282,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
      */
-    batchMove(projectId: number, category: 'training' | 'testing' | 'anomaly', moveRawDataRequest: MoveRawDataRequest, labels?: string, filename?: string, maxLength?: number, minLength?: number, minFrequency?: number, maxFrequency?: number, signatureValidity?: 'both' | 'valid' | 'invalid', includeDisabled?: 'both' | 'enabled' | 'disabled', ids?: string, options?: {
+    batchMove(projectId: number, moveRawDataRequest: MoveRawDataRequest, queryParams: batchMoveQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -200,7 +323,7 @@ export declare class RawDataApi {
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
      */
-    countSamples(projectId: number, category: 'training' | 'testing' | 'anomaly', labels?: string, filename?: string, maxLength?: number, minLength?: number, minFrequency?: number, maxFrequency?: number, signatureValidity?: 'both' | 'valid' | 'invalid', includeDisabled?: 'both' | 'enabled' | 'disabled', options?: {
+    countSamples(projectId: number, queryParams: countSamplesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -352,7 +475,7 @@ export declare class RawDataApi {
      * @param sampleId Sample ID
      * @param limitPayloadValues Limit the number of payload values in the response
      */
-    getSample(projectId: number, sampleId: number, limitPayloadValues?: number, options?: {
+    getSample(projectId: number, sampleId: number, queryParams: getSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -366,7 +489,7 @@ export declare class RawDataApi {
      * @param sliceStart Begin index of the slice
      * @param sliceEnd End index of the slice
      */
-    getSampleAsAudio(projectId: number, sampleId: number, axisIx: number, sliceStart?: number, sliceEnd?: number, options?: {
+    getSampleAsAudio(projectId: number, sampleId: number, queryParams: getSampleAsAudioQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -378,7 +501,7 @@ export declare class RawDataApi {
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
      */
-    getSampleAsImage(projectId: number, sampleId: number, afterInputBlock?: boolean, options?: {
+    getSampleAsImage(projectId: number, sampleId: number, queryParams: getSampleAsImageQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -401,11 +524,22 @@ export declare class RawDataApi {
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
      */
-    getSampleAsVideo(projectId: number, sampleId: number, afterInputBlock?: boolean, options?: {
+    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
@@ -414,7 +548,7 @@ export declare class RawDataApi {
      * @param sliceStart Begin index of the slice
      * @param sliceEnd End index of the slice
      */
-    getSampleSlice(projectId: number, sampleId: number, sliceStart: number, sliceEnd: number, options?: {
+    getSampleSlice(projectId: number, sampleId: number, queryParams: getSampleSliceQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -428,7 +562,7 @@ 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
      */
-    getUncroppedDownsampledSample(projectId: number, sampleId: number, limitPayloadValues?: number, zoomStart?: number, zoomEnd?: number, options?: {
+    getUncroppedDownsampledSample(projectId: number, sampleId: number, queryParams: getUncroppedDownsampledSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -460,7 +594,7 @@ export declare class RawDataApi {
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
      */
-    listSamples(projectId: number, 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', options?: {
+    listSamples(projectId: number, queryParams: listSamplesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -499,6 +633,17 @@ export declare class RawDataApi {
             [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>;
     /**
      * 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
@@ -586,9 +731,10 @@ export declare class RawDataApi {
      * @param projectId Project ID
      * @param image
      */
-    uploadDataExplorerScreenshot(projectId: number, image: RequestFile, options?: {
+    uploadDataExplorerScreenshot(projectId: number, params: uploadDataExplorerScreenshotFormParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
 }
+export {};