edge-impulse-api 1.93.8 → 1.93.10

package/build/browser/edge-impulse-api.d.ts

@@ -2103,7 +2103,7 @@ export enum DatasetVersionsApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
-type getDatasetVersionRawDataQueryParams = {
+type getDatasetVersionRawDataChangesQueryParams = {
     category: RawDataFilterCategory;
     limit?: number;
     offset?: number;
@@ -2127,14 +2127,13 @@ type getDatasetVersionRawDataQueryParams = {
     metadata?: string;
     minDate?: Date;
     maxDate?: Date;
-};
-type listDatasetVersionChangesQueryParams = {
-    limit?: number;
-    offset?: number;
+    changeActions?: string;
 };
 type listDatasetVersionsQueryParams = {
     limit?: number;
     offset?: number;
+    search?: string;
+    type?: string;
 };
 export type DatasetVersionsApiOpts = {
     extraHeaders?: Record<string, string>;
@@ -2171,8 +2170,8 @@ export class DatasetVersionsApi {
         };
     }): Promise<GetDatasetVersionResponse>;
     /**
-     * Get the full snapshot raw data contents of a specific dataset for this project.
-     * @summary Get dataset version raw-data contents
+     * Get raw data samples from a specific dataset snapshot for this project, including per-sample change metadata when available.
+     * @summary Get dataset version raw-data samples with changes
      * @param projectId Project ID
      * @param datasetVersionId Dataset version ID
      * @param category Which of the three acquisition categories to retrieve data from
@@ -2198,55 +2197,21 @@ export class DatasetVersionsApi {
      * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties:     - \&quot;key\&quot;: Metadata key to filter on.     - \&quot;op\&quot;: Operator (\&quot;eq\&quot; for positive match, \&quot;neq\&quot; for negative match).     - \&quot;values\&quot;: (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified:     - { \&quot;no_metadata\&quot;: boolean } - If true, include samples without any metadata     - { \&quot;filters_combinator\&quot;: (\&quot;and\&quot; | \&quot;or\&quot;) } - Specifies the combinator and matching mode:         - \&quot;and\&quot;: All filter items must match (logical AND).         - \&quot;or\&quot;: Any filter item may match (logical OR); samples with metadata keys not present in the filters are included.
      * @param minDate Only include samples that where added after the date given
      * @param maxDate Only include samples that were added before the date given
+     * @param changeActions Only include changes with an action within the given list of actions, given as a JSON string
      */
-    getDatasetVersionRawData(projectId: number, datasetVersionId: number, queryParams: getDatasetVersionRawDataQueryParams, options?: {
+    getDatasetVersionRawDataChanges(projectId: number, datasetVersionId: number, queryParams: getDatasetVersionRawDataChangesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GetDatasetVersionRawDataResponse>;
-    /**
-     * Get a raw sample from a specific dataset version.
-     * @summary Get dataset version raw sample
-     * @param projectId Project ID
-     * @param datasetVersionId Dataset version ID
-     * @param sampleId Sample ID
-     */
-    getDatasetVersionRawSample(projectId: number, datasetVersionId: number, sampleId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GetDatasetVersionRawDataSampleResponse>;
-    /**
-     * Get a sample\'s changes in a specific dataset version for this project.
-     * @summary Get dataset version sample change details
-     * @param projectId Project ID
-     * @param datasetVersionId Dataset version ID
-     * @param sampleId Sample ID
-     */
-    getDatasetVersionSampleChangeDetails(projectId: number, datasetVersionId: number, sampleId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GetDatasetVersionSampleChangeDetailsResponse>;
-    /**
-     * List details of the changes in a specific dataset version for this project.
-     * @summary List dataset version changes
-     * @param projectId Project ID
-     * @param datasetVersionId Dataset version ID
-     * @param limit Maximum number of results
-     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
-     */
-    listDatasetVersionChanges(projectId: number, datasetVersionId: number, queryParams?: listDatasetVersionChangesQueryParams, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<ListDatasetVersionChangesResponse>;
+    }): Promise<GetDatasetVersionRawDataChangesResponse>;
     /**
      * Get a list of all dataset versions for this project.
      * @summary List dataset versions
      * @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.
+     * @param search Search query
+     * @param type Only include dataset versions with a type within the given list of types, given as a JSON string
      */
     listDatasetVersions(projectId: number, queryParams?: listDatasetVersionsQueryParams, options?: {
         headers: {
@@ -5294,6 +5259,17 @@ export class OrganizationCreateProjectApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Creates a signed link to securely upload a custom block archive directly to S3.
+     * @summary Create pre-signed S3 upload link for a custom block archive
+     * @param organizationId Organization ID
+     * @param createCustomBlockUploadLinkRequest
+     */
+    createCustomBlockUploadLink(organizationId: number, createCustomBlockUploadLinkRequest: CreateCustomBlockUploadLinkRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateCustomBlockUploadLinkResponse>;
     /**
      * Remove a transformation job. This will stop all running jobs.
      * @summary Delete transformation job
@@ -5317,6 +5293,17 @@ export class OrganizationCreateProjectApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Verifies a staged custom block archive and starts a custom block build job.
+     * @summary Finalize custom block upload
+     * @param organizationId Organization ID
+     * @param finalizeCustomBlockUploadRequest
+     */
+    finalizeCustomBlockUpload(organizationId: number, finalizeCustomBlockUploadRequest: FinalizeCustomBlockUploadRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
     /**
      * Get the current status of a transformation job job.
      * @summary Get transformation job status
@@ -9015,6 +9002,7 @@ type getRawDataMetadataDistributionQueryParams = {
     excludeDisabledSamples?: boolean;
 };
 type getRawDataProjectMetadataQueryParams = {
+    datasetVersionId?: number;
     includeDisabled?: 'both' | 'enabled';
 };
 type getSampleQueryParams = {
@@ -9715,6 +9703,7 @@ export class RawDataApi {
      * Get the raw data metadata for this project
      * @summary Get project dataset metadata
      * @param projectId Project ID
+     * @param datasetVersionId Dataset version ID. If not set, the current dataset version is used
      * @param includeDisabled Whether to include enabled-only samples, or both enabled and disabled samples (defaults to both).
      */
     getRawDataProjectMetadata(projectId: number, queryParams?: getRawDataProjectMetadataQueryParams, options?: {
@@ -9959,7 +9948,7 @@ export class RawDataApi {
         };
     }): Promise<RebalanceDatasetResponse>;
     /**
-     * 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. Returns immediately on small datasets, or starts a job on larger datasets. To get the dataset ratio (as returned by the v1 endpoint), use getDatasetRatio.
+     * 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. Returns immediately on small datasets, or starts a job on larger datasets. To get the dataset ratio (as returned by the v1 endpoint), use getDatasetRatio. For richer, more powerful dataset splitting with configurable ratios, stratification, and grouping, use splitDataset (`/v1/api/{projectId}/split`).
      * @summary Rebalance dataset
      * @param projectId Project ID
      */
@@ -13874,6 +13863,50 @@ export type CountSamplesResponse = {
 };
 
 
+export type CreateCustomBlockUploadLinkRequest = {
+    /**
+    * file name
+    */
+    fileName: string;
+    /**
+    * file size in bytes
+    */
+    fileSize: number;
+    /**
+    * hash to identify file changes
+    */
+    fileHash: string;
+    type: CreateCustomBlockUploadLinkRequestTypeEnum;
+    blockId: number;
+};
+export type CreateCustomBlockUploadLinkRequestTypeEnum = 'transform' | 'deploy' | 'dsp' | 'transferLearning';
+export const CreateCustomBlockUploadLinkRequestTypeEnumValues: string[];
+
+
+export type CreateCustomBlockUploadLinkResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    /**
+    * S3 Upload Link
+    */
+    url?: string;
+    /**
+    * S3 File Tag
+    */
+    ETag?: string;
+    /**
+    * S3 object key for the staged upload
+    */
+    uploadKey: string;
+};
+
+
 export type CreateDeveloperProfileResponse = {
     /**
     * Whether the operation succeeded
@@ -15506,6 +15539,18 @@ export type DatasetVersionPendingWindow = {
 };
 
 
+export type DatasetVersionRawDataChangeDetailItem = {
+    sample: Sample;
+    change?: DatasetVersionChangeItem;
+};
+
+
+export type DatasetVersionRawDataChangeDetails = {
+    totalCount: number;
+    changeDetails: DatasetVersionRawDataChangeDetailItem[];
+};
+
+
 export type DatasetVersionSummary = {
     /**
     * Total number of raw mutation events in this dataset version window. A single sample can contribute multiple
@@ -16776,6 +16821,30 @@ export type Feature = 'signup-thank-you-page' | 'stripe-live-mode' | 'azure-stor
 export const FeatureValues: string[];
 
 
+export type FinalizeCustomBlockUploadRequest = {
+    /**
+    * S3 object key for the staged upload
+    */
+    uploadKey: string;
+    /**
+    * file name
+    */
+    fileName: string;
+    /**
+    * file size in bytes
+    */
+    fileSize: number;
+    /**
+    * hash to identify file changes
+    */
+    fileHash: string;
+    type: FinalizeCustomBlockUploadRequestTypeEnum;
+    blockId: number;
+};
+export type FinalizeCustomBlockUploadRequestTypeEnum = 'transform' | 'deploy' | 'dsp' | 'transferLearning';
+export const FinalizeCustomBlockUploadRequestTypeEnumValues: string[];
+
+
 export type FindSegmentSampleRequest = {
     /**
     * If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.
@@ -17118,7 +17187,7 @@ export type GetDatasetRatioResponse = {
 };
 
 
-export type GetDatasetVersionRawDataResponse = {
+export type GetDatasetVersionRawDataChangesResponse = {
     /**
     * Whether the operation succeeded
     */
@@ -17127,21 +17196,8 @@ export type GetDatasetVersionRawDataResponse = {
     * Optional error description (set if 'success' was false)
     */
     error?: string;
-    samples: Sample[];
     totalCount: number;
-};
-
-
-export type GetDatasetVersionRawDataSampleResponse = {
-    /**
-    * Whether the operation succeeded
-    */
-    success: boolean;
-    /**
-    * Optional error description (set if 'success' was false)
-    */
-    error?: string;
-    sample: Sample;
+    changeDetails: DatasetVersionRawDataChangeDetailItem[];
 };
 
 
@@ -17158,19 +17214,6 @@ export type GetDatasetVersionResponse = {
 };
 
 
-export type GetDatasetVersionSampleChangeDetailsResponse = {
-    /**
-    * Whether the operation succeeded
-    */
-    success: boolean;
-    /**
-    * Optional error description (set if 'success' was false)
-    */
-    error?: string;
-    change: DatasetVersionChangeItem;
-};
-
-
 export type GetDeploymentHistoryResponse = {
     /**
     * Whether the operation succeeded
@@ -19816,11 +19859,11 @@ export type LastUpdatedByDatasetVersionRestore = {
     /**
     * The ID of the dataset version that last updated the sample.
     */
-    datasetVersionId?: number;
+    datasetVersionId: number;
     /**
     * A random grouping ID to keep restore snapshots isolated.
     */
-    groupKey?: string;
+    groupKey: string;
     /**
     * The actor that started the dataset restore operation.
     */
@@ -19947,20 +19990,6 @@ export type ListApiKeysResponse = {
 };
 
 
-export type ListDatasetVersionChangesResponse = {
-    /**
-    * Whether the operation succeeded
-    */
-    success: boolean;
-    /**
-    * Optional error description (set if 'success' was false)
-    */
-    error?: string;
-    changes: DatasetVersionChangeItem[];
-    totalCount: number;
-};
-
-
 export type ListDatasetVersionsResponse = {
     /**
     * Whether the operation succeeded
@@ -23556,11 +23585,34 @@ export type ProjectDatasetMetadataBase = {
     isTimeseries: boolean;
     isFeatures: boolean;
     metadataFilterOptions: MetadataFilterOptions;
+    /**
+    * Breakdown of the number of samples with mutation events in the dataset version.
+    */
+    changeActionCounts?: ProjectDatasetMetadataBaseChangeActionCounts;
 };
 export type ProjectDatasetMetadataBaseTypeEnum = 'classes' | 'regression';
 export const ProjectDatasetMetadataBaseTypeEnumValues: string[];
 
 
+/**
+* Breakdown of the number of samples with mutation events in the dataset version.
+*/
+export type ProjectDatasetMetadataBaseChangeActionCounts = {
+    /**
+    * Number of samples in this window with at least one insert mutation.
+    */
+    insert?: number;
+    /**
+    * Number of samples in this window with at least one update mutation.
+    */
+    update?: number;
+    /**
+    * Number of samples in this window with at least one delete mutation.
+    */
+    delete?: number;
+};
+
+
 /**
 * Dataset ratio info for a single category and label
 */
@@ -23604,6 +23656,10 @@ export type ProjectDatasetMetadataClassesCategory = {
     isTimeseries: boolean;
     isFeatures: boolean;
     metadataFilterOptions: MetadataFilterOptions;
+    /**
+    * Breakdown of the number of samples with mutation events in the dataset version.
+    */
+    changeActionCounts?: ProjectDatasetMetadataBaseChangeActionCounts;
     fullLabelCount: number;
     labels: RawDataLabelDistributionLabel[];
 };
@@ -23758,6 +23814,10 @@ export type ProjectDatasetMetadataRegressionCategory = {
     isTimeseries: boolean;
     isFeatures: boolean;
     metadataFilterOptions: MetadataFilterOptions;
+    /**
+    * Breakdown of the number of samples with mutation events in the dataset version.
+    */
+    changeActionCounts?: ProjectDatasetMetadataBaseChangeActionCounts;
     labelsCount: number;
     minLabel: number;
     maxLabel: number;