edge-impulse-api 1.92.23 → 1.92.24

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

@@ -21,8 +21,8 @@ import { CropSampleRequest } from '../model/cropSampleRequest';
 import { CropSampleResponse } from '../model/cropSampleResponse';
 import { DataExplorerPredictionsResponse } from '../model/dataExplorerPredictionsResponse';
 import { DataExplorerSettings } from '../model/dataExplorerSettings';
-import { DatasetStratificationOptions } from '../model/datasetStratificationOptions';
-import { DatasetStratificationPreviewResponse } from '../model/datasetStratificationPreviewResponse';
+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';
@@ -1129,15 +1129,15 @@ export declare class RawDataApi {
         };
     }): Promise<GetSampleResponse>;
     /**
-     * Returns the results of a previously requested stratification preview job. This endpoint is used to retrieve the results after a stratification preview job has been started.
-     * @summary Get stratify preview results
+     * 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
      */
-    getStratifyPreviewResults(projectId: number, options?: {
+    getSplitPreviewResults(projectId: number, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<DatasetStratificationPreviewResponse>;
+    }): Promise<DatasetSplitPreviewResponse>;
     /**
      * Get the original, uncropped, downsampled data.
      * @summary Get the original downsampled data
@@ -1380,50 +1380,50 @@ export declare class RawDataApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * 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
+     * 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 sampleId Sample ID
-     * @param splitSampleInFramesRequest
+     * @param datasetSplitOptions
      */
-    splitSampleInFrames(projectId: number, sampleId: number, splitSampleInFramesRequest: SplitSampleInFramesRequest, options?: {
+    splitDataset(projectId: number, datasetSplitOptions: DatasetSplitOptions, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
-     * @summary Store the last segment length
+     * 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 storeSegmentLengthRequest
+     * @param datasetSplitOptions
      */
-    storeSegmentLength(projectId: number, storeSegmentLengthRequest: StoreSegmentLengthRequest, options?: {
+    splitDatasetPreview(projectId: number, datasetSplitOptions: DatasetSplitOptions, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<DatasetSplitPreviewResponse | StartJobResponse>;
     /**
-     * Performs a deterministic, in-place stratified split of the project\'s dataset into \"training\", \"testing\", and optional \"validation\" sets, based on the chosen stratification options. Stratification can use the label, one or more metadata keys, or both as a composite group. 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:     { \"stratifyByLabel\": true, \"metadataKeys\": [\"site\", \"scanner\"], \"excludeDisabledSamples\": false, \"trainingSplitRatio\": 0.8, \"testingSplitRatio\": 0.1, \"validationSplitRatio\": 0.1 }     With these options, samples are grouped by the combination of label, site, and scanner. Within each group, 80% are set to \"training\", 10% to \"testing\", and 10% to \"validation\".
-     * @summary Stratify dataset
+     * 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
      * @param projectId Project ID
-     * @param datasetStratificationOptions
+     * @param sampleId Sample ID
+     * @param splitSampleInFramesRequest
      */
-    stratifyDataset(projectId: number, datasetStratificationOptions: DatasetStratificationOptions, options?: {
+    splitSampleInFrames(projectId: number, sampleId: number, splitSampleInFramesRequest: SplitSampleInFramesRequest, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse | StartJobResponse>;
     /**
-     * Returns a preview of how the project\'s dataset would be balanced if the current stratification options were applied. For each group (composite of label and/or metadata keys), shows the number and percentage of samples that would be assigned to each split (\"training\"/\"testing\"). This does not update the dataset, only provides a summary. Returns immediately on small datasets, or starts a job on larger datasets.
-     * @summary Stratify dataset preview
+     * 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 datasetStratificationOptions
+     * @param storeSegmentLengthRequest
      */
-    stratifyDatasetPreview(projectId: number, datasetStratificationOptions: DatasetStratificationOptions, options?: {
+    storeSegmentLength(projectId: number, storeSegmentLengthRequest: StoreSegmentLengthRequest, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<DatasetStratificationPreviewResponse | StartJobResponse>;
+    }): Promise<GenericApiResponse>;
     /**
      * Track objects between two samples. Source sample should have bounding boxes set.
      * @summary Track objects

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

@@ -4433,12 +4433,12 @@ class RawDataApi {
         return this.handleResponse(response, 'GetSampleResponse');
     }
     /**
-     * Returns the results of a previously requested stratification preview job. This endpoint is used to retrieve the results after a stratification preview job has been started.
-     * @summary Get stratify preview results
+     * 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
      */
-    async getStratifyPreviewResults(projectId, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/api/{projectId}/get-stratify-preview-results'
+    async getSplitPreviewResults(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/get-split-preview-results'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = {
@@ -4457,7 +4457,7 @@ class RawDataApi {
         let localVarFormParams;
         // verify required parameter 'projectId' is not null or undefined
         if (projectId === null || projectId === undefined) {
-            throw new Error('Required parameter projectId was null or undefined when calling getStratifyPreviewResults.');
+            throw new Error('Required parameter projectId was null or undefined when calling getSplitPreviewResults.');
         }
         localVarHeaderParams = {
             ...localVarHeaderParams,
@@ -4503,7 +4503,7 @@ class RawDataApi {
             }
         }
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DatasetStratificationPreviewResponse');
+        return this.handleResponse(response, 'DatasetSplitPreviewResponse');
     }
     /**
      * Get the original, uncropped, downsampled data.
@@ -6145,16 +6145,14 @@ class RawDataApi {
         return this.handleResponse(response, 'GenericApiResponse');
     }
     /**
-     * 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
+     * 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 sampleId Sample ID
-     * @param splitSampleInFramesRequest
+     * @param datasetSplitOptions
      */
-    async splitSampleInFrames(projectId, sampleId, splitSampleInFramesRequest, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/split'
-            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
-            .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
+    async splitDataset(projectId, datasetSplitOptions, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/split'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = {
             'User-Agent': 'edgeimpulse-api nodejs',
@@ -6172,15 +6170,11 @@ class RawDataApi {
         let localVarFormParams;
         // verify required parameter 'projectId' is not null or undefined
         if (projectId === null || projectId === undefined) {
-            throw new Error('Required parameter projectId was null or undefined when calling splitSampleInFrames.');
+            throw new Error('Required parameter projectId was null or undefined when calling splitDataset.');
         }
-        // verify required parameter 'sampleId' is not null or undefined
-        if (sampleId === null || sampleId === undefined) {
-            throw new Error('Required parameter sampleId was null or undefined when calling splitSampleInFrames.');
-        }
-        // verify required parameter 'splitSampleInFramesRequest' is not null or undefined
-        if (splitSampleInFramesRequest === null || splitSampleInFramesRequest === undefined) {
-            throw new Error('Required parameter splitSampleInFramesRequest was null or undefined when calling splitSampleInFrames.');
+        // verify required parameter 'datasetSplitOptions' is not null or undefined
+        if (datasetSplitOptions === null || datasetSplitOptions === undefined) {
+            throw new Error('Required parameter datasetSplitOptions was null or undefined when calling splitDataset.');
         }
         localVarHeaderParams = {
             ...localVarHeaderParams,
@@ -6196,7 +6190,7 @@ class RawDataApi {
             method: 'POST',
             headers: { ...localVarHeaderParams },
         };
-        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(splitSampleInFramesRequest, "SplitSampleInFramesRequest"));
+        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(datasetSplitOptions, "DatasetSplitOptions"));
         let requestOptions = localVarRequestOptions;
         let url = localVarUrl;
         const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
@@ -6230,13 +6224,13 @@ class RawDataApi {
         return this.handleResponse(response, 'GenericApiResponse | StartJobResponse');
     }
     /**
-     * When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
-     * @summary Store the last segment length
+     * 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 storeSegmentLengthRequest
+     * @param datasetSplitOptions
      */
-    async storeSegmentLength(projectId, storeSegmentLengthRequest, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/api/{projectId}/raw-data/store-segment-length'
+    async splitDatasetPreview(projectId, datasetSplitOptions, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/split-preview'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = {
@@ -6255,11 +6249,11 @@ class RawDataApi {
         let localVarFormParams;
         // verify required parameter 'projectId' is not null or undefined
         if (projectId === null || projectId === undefined) {
-            throw new Error('Required parameter projectId was null or undefined when calling storeSegmentLength.');
+            throw new Error('Required parameter projectId was null or undefined when calling splitDatasetPreview.');
         }
-        // verify required parameter 'storeSegmentLengthRequest' is not null or undefined
-        if (storeSegmentLengthRequest === null || storeSegmentLengthRequest === undefined) {
-            throw new Error('Required parameter storeSegmentLengthRequest was null or undefined when calling storeSegmentLength.');
+        // verify required parameter 'datasetSplitOptions' is not null or undefined
+        if (datasetSplitOptions === null || datasetSplitOptions === undefined) {
+            throw new Error('Required parameter datasetSplitOptions was null or undefined when calling splitDatasetPreview.');
         }
         localVarHeaderParams = {
             ...localVarHeaderParams,
@@ -6275,7 +6269,7 @@ class RawDataApi {
             method: 'POST',
             headers: { ...localVarHeaderParams },
         };
-        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(storeSegmentLengthRequest, "StoreSegmentLengthRequest"));
+        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(datasetSplitOptions, "DatasetSplitOptions"));
         let requestOptions = localVarRequestOptions;
         let url = localVarUrl;
         const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
@@ -6306,17 +6300,19 @@ class RawDataApi {
             }
         }
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'GenericApiResponse');
+        return this.handleResponse(response, 'DatasetSplitPreviewResponse | StartJobResponse');
     }
     /**
-     * Performs a deterministic, in-place stratified split of the project\'s dataset into \"training\", \"testing\", and optional \"validation\" sets, based on the chosen stratification options. Stratification can use the label, one or more metadata keys, or both as a composite group. 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:     { \"stratifyByLabel\": true, \"metadataKeys\": [\"site\", \"scanner\"], \"excludeDisabledSamples\": false, \"trainingSplitRatio\": 0.8, \"testingSplitRatio\": 0.1, \"validationSplitRatio\": 0.1 }     With these options, samples are grouped by the combination of label, site, and scanner. Within each group, 80% are set to \"training\", 10% to \"testing\", and 10% to \"validation\".
-     * @summary Stratify dataset
+     * 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
      * @param projectId Project ID
-     * @param datasetStratificationOptions
+     * @param sampleId Sample ID
+     * @param splitSampleInFramesRequest
      */
-    async stratifyDataset(projectId, datasetStratificationOptions, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/api/{projectId}/stratify'
-            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+    async splitSampleInFrames(projectId, sampleId, splitSampleInFramesRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/split'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = {
             'User-Agent': 'edgeimpulse-api nodejs',
@@ -6334,11 +6330,15 @@ class RawDataApi {
         let localVarFormParams;
         // verify required parameter 'projectId' is not null or undefined
         if (projectId === null || projectId === undefined) {
-            throw new Error('Required parameter projectId was null or undefined when calling stratifyDataset.');
+            throw new Error('Required parameter projectId was null or undefined when calling splitSampleInFrames.');
         }
-        // verify required parameter 'datasetStratificationOptions' is not null or undefined
-        if (datasetStratificationOptions === null || datasetStratificationOptions === undefined) {
-            throw new Error('Required parameter datasetStratificationOptions was null or undefined when calling stratifyDataset.');
+        // verify required parameter 'sampleId' is not null or undefined
+        if (sampleId === null || sampleId === undefined) {
+            throw new Error('Required parameter sampleId was null or undefined when calling splitSampleInFrames.');
+        }
+        // verify required parameter 'splitSampleInFramesRequest' is not null or undefined
+        if (splitSampleInFramesRequest === null || splitSampleInFramesRequest === undefined) {
+            throw new Error('Required parameter splitSampleInFramesRequest was null or undefined when calling splitSampleInFrames.');
         }
         localVarHeaderParams = {
             ...localVarHeaderParams,
@@ -6354,7 +6354,7 @@ class RawDataApi {
             method: 'POST',
             headers: { ...localVarHeaderParams },
         };
-        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(datasetStratificationOptions, "DatasetStratificationOptions"));
+        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(splitSampleInFramesRequest, "SplitSampleInFramesRequest"));
         let requestOptions = localVarRequestOptions;
         let url = localVarUrl;
         const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
@@ -6388,13 +6388,13 @@ class RawDataApi {
         return this.handleResponse(response, 'GenericApiResponse | StartJobResponse');
     }
     /**
-     * Returns a preview of how the project\'s dataset would be balanced if the current stratification options were applied. For each group (composite of label and/or metadata keys), shows the number and percentage of samples that would be assigned to each split (\"training\"/\"testing\"). This does not update the dataset, only provides a summary. Returns immediately on small datasets, or starts a job on larger datasets.
-     * @summary Stratify dataset preview
+     * 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 datasetStratificationOptions
+     * @param storeSegmentLengthRequest
      */
-    async stratifyDatasetPreview(projectId, datasetStratificationOptions, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/api/{projectId}/stratify-preview'
+    async storeSegmentLength(projectId, storeSegmentLengthRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/store-segment-length'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = {
@@ -6413,11 +6413,11 @@ class RawDataApi {
         let localVarFormParams;
         // verify required parameter 'projectId' is not null or undefined
         if (projectId === null || projectId === undefined) {
-            throw new Error('Required parameter projectId was null or undefined when calling stratifyDatasetPreview.');
+            throw new Error('Required parameter projectId was null or undefined when calling storeSegmentLength.');
         }
-        // verify required parameter 'datasetStratificationOptions' is not null or undefined
-        if (datasetStratificationOptions === null || datasetStratificationOptions === undefined) {
-            throw new Error('Required parameter datasetStratificationOptions was null or undefined when calling stratifyDatasetPreview.');
+        // verify required parameter 'storeSegmentLengthRequest' is not null or undefined
+        if (storeSegmentLengthRequest === null || storeSegmentLengthRequest === undefined) {
+            throw new Error('Required parameter storeSegmentLengthRequest was null or undefined when calling storeSegmentLength.');
         }
         localVarHeaderParams = {
             ...localVarHeaderParams,
@@ -6433,7 +6433,7 @@ class RawDataApi {
             method: 'POST',
             headers: { ...localVarHeaderParams },
         };
-        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(datasetStratificationOptions, "DatasetStratificationOptions"));
+        localVarRequestOptions.body = JSON.stringify(models_1.ObjectSerializer.serialize(storeSegmentLengthRequest, "StoreSegmentLengthRequest"));
         let requestOptions = localVarRequestOptions;
         let url = localVarUrl;
         const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
@@ -6464,7 +6464,7 @@ class RawDataApi {
             }
         }
         const response = await fetch(url, requestOptions);
-        return this.handleResponse(response, 'DatasetStratificationPreviewResponse | StartJobResponse');
+        return this.handleResponse(response, 'GenericApiResponse');
     }
     /**
      * Track objects between two samples. Source sample should have bounding boxes set.