edge-impulse-api 1.93.8 → 1.93.9

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?: {
-        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?: {
+    getDatasetVersionRawDataChanges(projectId: number, datasetVersionId: number, queryParams: getDatasetVersionRawDataChangesQueryParams, 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: {
@@ -9015,6 +8980,7 @@ type getRawDataMetadataDistributionQueryParams = {
     excludeDisabledSamples?: boolean;
 };
 type getRawDataProjectMetadataQueryParams = {
+    datasetVersionId?: number;
     includeDisabled?: 'both' | 'enabled';
 };
 type getSampleQueryParams = {
@@ -9715,6 +9681,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?: {
@@ -15506,6 +15473,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
@@ -17118,7 +17097,7 @@ export type GetDatasetRatioResponse = {
 };
 
 
-export type GetDatasetVersionRawDataResponse = {
+export type GetDatasetVersionRawDataChangesResponse = {
     /**
     * Whether the operation succeeded
     */
@@ -17127,21 +17106,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 +17124,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 +19769,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 +19900,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 +23495,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 +23566,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 +23724,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;