edge-impulse-linux 1.4.7 → 1.5.0

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

@@ -20,10 +20,11 @@ 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 { GetAutoLabelerResponse } from '../model/getAutoLabelerResponse';
 import { GetDataExplorerFeaturesResponse } from '../model/getDataExplorerFeaturesResponse';
 import { GetDataExplorerSettingsResponse } from '../model/getDataExplorerSettingsResponse';
 import { GetDiversityDataResponse } from '../model/getDiversityDataResponse';
+import { GetLabelNoiseDataResponse } from '../model/getLabelNoiseDataResponse';
 import { GetSampleMetadataResponse } from '../model/getSampleMetadataResponse';
 import { GetSampleResponse } from '../model/getSampleResponse';
 import { HasDataExplorerFeaturesResponse } from '../model/hasDataExplorerFeaturesResponse';
@@ -35,12 +36,13 @@ import { ObjectDetectionLabelQueueCountResponse } from '../model/objectDetection
 import { ObjectDetectionLabelQueueResponse } from '../model/objectDetectionLabelQueueResponse';
 import { RebalanceDatasetResponse } from '../model/rebalanceDatasetResponse';
 import { RenameSampleRequest } from '../model/renameSampleRequest';
-import { RunAutoSegmenterRequest } from '../model/runAutoSegmenterRequest';
+import { RunAutoLabelerRequest } from '../model/runAutoLabelerRequest';
 import { SampleBoundingBoxesRequest } from '../model/sampleBoundingBoxesRequest';
-import { SaveAutoSegmenterClustersRequest } from '../model/saveAutoSegmenterClustersRequest';
-import { SaveAutoSegmenterClustersResponse } from '../model/saveAutoSegmenterClustersResponse';
+import { SaveAutoLabelerClustersRequest } from '../model/saveAutoLabelerClustersRequest';
+import { SaveAutoLabelerClustersResponse } from '../model/saveAutoLabelerClustersResponse';
 import { SegmentSampleRequest } from '../model/segmentSampleRequest';
 import { SetSampleMetadataRequest } from '../model/setSampleMetadataRequest';
+import { SetSampleStructuredLabelsRequest } from '../model/setSampleStructuredLabelsRequest';
 import { SplitSampleInFramesRequest } from '../model/splitSampleInFramesRequest';
 import { StartJobResponse } from '../model/startJobResponse';
 import { StoreSegmentLengthRequest } from '../model/storeSegmentLengthRequest';
@@ -134,7 +136,7 @@ declare type getAllImportedFromQueryParams = {
     limit?: number;
     offset?: number;
 };
-declare type getAutoSegmenterImageQueryParams = {
+declare type getAutoLabelerImageQueryParams = {
     image: string;
 };
 declare type getSampleQueryParams = {
@@ -465,22 +467,22 @@ export declare class RawDataApi {
         };
     }): Promise<GetAllImportedFromResponse>;
     /**
-     * Retrieve the results of the auto-segmenter (after running `StartJobResponse`)
-     * @summary Get auto-segmenter results
+     * Retrieve the results of the auto-labeler (after running `StartJobResponse`)
+     * @summary Get auto-labeler results
      * @param projectId Project ID
      */
-    getAutoSegmenter(projectId: number, options?: {
+    getAutoLabeler(projectId: number, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GetAutoSegmenterResponse>;
+    }): Promise<GetAutoLabelerResponse>;
     /**
-     * Grab a segment image from the auto-segmenter
-     * @summary Get auto-segmenter image
+     * Grab a segment image from the auto-labeler
+     * @summary Get auto-labeler image
      * @param projectId Project ID
-     * @param image Which image to receive from the auto-segmenter
+     * @param image Which image to receive from the auto-labeler
      */
-    getAutoSegmenterImage(projectId: number, queryParams: getAutoSegmenterImageQueryParams, options?: {
+    getAutoLabelerImage(projectId: number, queryParams: getAutoLabelerImageQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -516,8 +518,8 @@ export declare class RawDataApi {
         };
     }): Promise<GetDataExplorerSettingsResponse>;
     /**
-     * Structure describing the similarity and diversity of a dataset
-     * @summary Get diversity visualization data
+     * Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the `calculateDataQualityMetrics` endpoint.
+     * @summary Get diversity metrics data
      * @param projectId Project ID
      */
     getDiversityData(projectId: number, options?: {
@@ -525,6 +527,16 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GetDiversityDataResponse>;
+    /**
+     * Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the `calculateDataQualityMetrics` endpoint.
+     * @summary Get label noise data
+     * @param projectId Project ID
+     */
+    getLabelNoiseData(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetLabelNoiseDataResponse>;
     /**
      * Get all unlabeled items from the object detection queue.
      * @summary Object detection label queue
@@ -655,7 +667,7 @@ export declare class RawDataApi {
         };
     }): Promise<HasDataExplorerFeaturesResponse>;
     /**
-     * Determine if data diversity metrics have been calculated
+     * Determine if data diversity metrics have been calculated. To calculate these metrics, use the `calculateDataQualityMetrics` endpoint.
      * @summary Check if data diversity metrics exist
      * @param projectId Project ID
      */
@@ -664,6 +676,16 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<HasDataExplorerFeaturesResponse>;
+    /**
+     * Determine if label noise metrics have been calculated. To calculate these metrics, use the `calculateDataQualityMetrics` endpoint.
+     * @summary Check if label noise metrics exist
+     * @param projectId Project ID
+     */
+    hasLabelNoiseData(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<HasDataExplorerFeaturesResponse>;
     /**
      * Retrieve all raw data by category.
      * @summary List samples
@@ -698,6 +720,17 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Clears the bounding box labels and moves item back to labeling queue
+     * @summary Move sample to labeling queue
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     */
+    moveToLabelingQueue(projectId: number, sampleId: number, 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
@@ -732,27 +765,27 @@ export declare class RawDataApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * Run the auto-segmenter over all unlabeled data.
-     * @summary Run auto-segmenter job
+     * Run the auto-labeler over all unlabeled data.
+     * @summary Run auto-labeler job
      * @param projectId Project ID
-     * @param runAutoSegmenterRequest
+     * @param runAutoLabelerRequest
      */
-    runAutoSegmenter(projectId: number, runAutoSegmenterRequest: RunAutoSegmenterRequest, options?: {
+    runAutoLabeler(projectId: number, runAutoLabelerRequest: RunAutoLabelerRequest, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<StartJobResponse>;
     /**
      * Set labels for all auto-segment clusters.
-     * @summary Save auto-segmenter clusters
+     * @summary Save auto-labeler clusters
      * @param projectId Project ID
-     * @param saveAutoSegmenterClustersRequest
+     * @param saveAutoLabelerClustersRequest
      */
-    saveAutoSegmenterClusters(projectId: number, saveAutoSegmenterClustersRequest: SaveAutoSegmenterClustersRequest, options?: {
+    saveAutoLabelerClusters(projectId: number, saveAutoLabelerClustersRequest: SaveAutoLabelerClustersRequest, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<SaveAutoSegmenterClustersResponse>;
+    }): Promise<SaveAutoLabelerClustersResponse>;
     /**
      * 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
@@ -800,6 +833,18 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Set structured labels for a sample. If a sample has structured labels the `label` column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see `valuesCount` to get the upper bound). endIndex is _inclusive_. If you pass in an incorrect array (e.g. missing values) you\'ll get an error back.
+     * @summary Update structured labels
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param setSampleStructuredLabelsRequest
+     */
+    setSampleStructuredLabels(projectId: number, sampleId: number, setSampleStructuredLabelsRequest: SetSampleStructuredLabelsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Split a video sample into individual frames.
      * @summary Split sample into frames