edge-impulse-api 1.95.5 → 1.95.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10167,10 +10167,12 @@ type getProjectDataAxesSummaryQueryParams = {
10167
10167
  };
10168
10168
  type getProjectInfoQueryParams = {
10169
10169
  impulseId?: number;
10170
+ truncateLabels?: boolean;
10170
10171
  };
10171
10172
  type getProjectTrainingDataSummaryQueryParams = {
10172
10173
  includeDisabled?: boolean;
10173
10174
  includeNotProcessed?: boolean;
10175
+ truncateLabels?: boolean;
10174
10176
  };
10175
10177
  type listDownloadsQueryParams = {
10176
10178
  impulseId?: number;
@@ -10589,6 +10591,7 @@ export class ProjectsApi {
10589
10591
  * @summary Project information
10590
10592
  * @param projectId Project ID
10591
10593
  * @param impulseId Impulse ID. If this is unset then the default impulse is used.
10594
+ * @param truncateLabels If true, only a slice of labels will be returned.
10592
10595
  */
10593
10596
  getProjectInfo(projectId: number, queryParams?: getProjectInfoQueryParams, options?: {
10594
10597
  headers: {
@@ -10643,6 +10646,7 @@ export class ProjectsApi {
10643
10646
  * @param projectId Project ID
10644
10647
  * @param includeDisabled Whether to include disabled samples. Defaults to true
10645
10648
  * @param includeNotProcessed Whether to include non-processed samples. Defaults to true
10649
+ * @param truncateLabels If true, only a slice of labels will be returned.
10646
10650
  */
10647
10651
  getProjectTrainingDataSummary(projectId: number, queryParams?: getProjectTrainingDataSummaryQueryParams, options?: {
10648
10652
  headers: {
@@ -11464,6 +11468,7 @@ type getRawDataMetadataDistributionQueryParams = {
11464
11468
  };
11465
11469
  type getRawDataProjectMetadataQueryParams = {
11466
11470
  datasetVersionId?: number;
11471
+ truncateLabels?: boolean;
11467
11472
  includeDisabled?: 'both' | 'enabled';
11468
11473
  };
11469
11474
  type getSampleQueryParams = {
@@ -12267,6 +12272,7 @@ export class RawDataApi {
12267
12272
  * @summary Get project dataset metadata
12268
12273
  * @param projectId Project ID
12269
12274
  * @param datasetVersionId Dataset version ID. If not set, the current dataset version is used
12275
+ * @param truncateLabels If true, only a slice of labels will be returned.
12270
12276
  * @param includeDisabled Whether to include enabled-only samples, or both enabled and disabled samples (defaults to both).
12271
12277
  */
12272
12278
  getRawDataProjectMetadata(projectId: number, queryParams?: getRawDataProjectMetadataQueryParams, options?: {
@@ -26855,10 +26861,26 @@ export type ProjectDataSummary = {
26855
26861
  */
26856
26862
  totalLengthMs: number;
26857
26863
  /**
26858
- * Labels in the training set
26864
+ * Labels in the training set.
26859
26865
  */
26860
26866
  labels: string[];
26861
26867
  /**
26868
+ * Total number of distinct labels in the training set.
26869
+ */
26870
+ totalLabels: number;
26871
+ /**
26872
+ * Minimum regression value. Only set for regression datasets.
26873
+ */
26874
+ min?: number;
26875
+ /**
26876
+ * Maximum regression value. Only set for regression datasets.
26877
+ */
26878
+ max?: number;
26879
+ /**
26880
+ * Mean regression value. Only set for regression datasets.
26881
+ */
26882
+ mean?: number;
26883
+ /**
26862
26884
  * Number of files in the training set
26863
26885
  */
26864
26886
  dataCount: number;
@@ -27132,6 +27154,10 @@ export type ProjectDatasetMetadataRegressionCategory = {
27132
27154
  groupsPerLabelMapKey?: {
27133
27155
  [key: string]: RawDataLabelDistributionRegressionValueGroupsPerKey;
27134
27156
  };
27157
+ fullLabelCount: number;
27158
+ fullLabelMax?: number;
27159
+ fullLabelMin?: number;
27160
+ fullLabelMean?: number;
27135
27161
  };
27136
27162
  export type ProjectDatasetMetadataRegressionCategoryTypeEnum = 'regression';
27137
27163
  export const ProjectDatasetMetadataRegressionCategoryTypeEnumValues: string[];
@@ -27336,10 +27362,26 @@ export type ProjectInfoResponse = {
27336
27362
  */
27337
27363
  totalLengthMs: number;
27338
27364
  /**
27339
- * Labels in the testing set
27365
+ * Labels in the testing set.
27340
27366
  */
27341
27367
  labels: string[];
27342
27368
  /**
27369
+ * Total number of distinct labels in the testing set.
27370
+ */
27371
+ totalLabels: number;
27372
+ /**
27373
+ * Minimum regression value. Only set for regression datasets.
27374
+ */
27375
+ min?: number;
27376
+ /**
27377
+ * Maximum regression value. Only set for regression datasets.
27378
+ */
27379
+ max?: number;
27380
+ /**
27381
+ * Mean regression value. Only set for regression datasets.
27382
+ */
27383
+ mean?: number;
27384
+ /**
27343
27385
  * Number of files in the testing set
27344
27386
  */
27345
27387
  dataCount: number;
@@ -27350,10 +27392,26 @@ export type ProjectInfoResponse = {
27350
27392
  */
27351
27393
  totalLengthMs: number;
27352
27394
  /**
27353
- * Labels in the validation set
27395
+ * Labels in the validation set.
27354
27396
  */
27355
27397
  labels: string[];
27356
27398
  /**
27399
+ * Total number of distinct labels in the validation set.
27400
+ */
27401
+ totalLabels: number;
27402
+ /**
27403
+ * Minimum regression value. Only set for regression datasets.
27404
+ */
27405
+ min?: number;
27406
+ /**
27407
+ * Maximum regression value. Only set for regression datasets.
27408
+ */
27409
+ max?: number;
27410
+ /**
27411
+ * Mean regression value. Only set for regression datasets.
27412
+ */
27413
+ mean?: number;
27414
+ /**
27357
27415
  * Number of files in the validation set
27358
27416
  */
27359
27417
  dataCount: number;
@@ -27364,10 +27422,26 @@ export type ProjectInfoResponse = {
27364
27422
  */
27365
27423
  totalLengthMs: number;
27366
27424
  /**
27367
- * Labels in the post-processing set
27425
+ * Labels in the post-processing set.
27368
27426
  */
27369
27427
  labels: string[];
27370
27428
  /**
27429
+ * Total number of distinct labels in the post-processing set.
27430
+ */
27431
+ totalLabels: number;
27432
+ /**
27433
+ * Minimum regression value. Only set for regression datasets.
27434
+ */
27435
+ min?: number;
27436
+ /**
27437
+ * Maximum regression value. Only set for regression datasets.
27438
+ */
27439
+ max?: number;
27440
+ /**
27441
+ * Mean regression value. Only set for regression datasets.
27442
+ */
27443
+ mean?: number;
27444
+ /**
27371
27445
  * Number of files in the post-processing set
27372
27446
  */
27373
27447
  dataCount: number;
@@ -27711,6 +27785,22 @@ export type ProjectTrainingDataSummaryResponse = {
27711
27785
  * Labels in the training set
27712
27786
  */
27713
27787
  labels: string[];
27788
+ /**
27789
+ * Total number of distinct labels in the training set.
27790
+ */
27791
+ totalLabels: number;
27792
+ /**
27793
+ * Minimum regression value. Only set for regression datasets.
27794
+ */
27795
+ min?: number;
27796
+ /**
27797
+ * Maximum regression value. Only set for regression datasets.
27798
+ */
27799
+ max?: number;
27800
+ /**
27801
+ * Mean regression value. Only set for regression datasets.
27802
+ */
27803
+ mean?: number;
27714
27804
  dataCount: number;
27715
27805
  /**
27716
27806
  * Whether there are samples in the training dataset that are both time-series data and have multiple labels
@@ -49000,6 +49000,7 @@ class ProjectsApi {
49000
49000
  * @summary Project information
49001
49001
  * @param projectId Project ID
49002
49002
  * @param impulseId Impulse ID. If this is unset then the default impulse is used.
49003
+ * @param truncateLabels If true, only a slice of labels will be returned.
49003
49004
  */
49004
49005
  async getProjectInfo(projectId, queryParams, options = { headers: {} }) {
49005
49006
  const localVarPath = this.basePath + '/api/{projectId}'
@@ -49026,6 +49027,9 @@ class ProjectsApi {
49026
49027
  if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.impulseId) !== null) {
49027
49028
  queryParameters['impulseId'] = queryParams.impulseId;
49028
49029
  }
49030
+ if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateLabels) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateLabels) !== null) {
49031
+ queryParameters['truncateLabels'] = queryParams.truncateLabels;
49032
+ }
49029
49033
  localVarHeaderParams = {
49030
49034
  ...localVarHeaderParams,
49031
49035
  ...options.headers,
@@ -49285,6 +49289,7 @@ class ProjectsApi {
49285
49289
  * @param projectId Project ID
49286
49290
  * @param includeDisabled Whether to include disabled samples. Defaults to true
49287
49291
  * @param includeNotProcessed Whether to include non-processed samples. Defaults to true
49292
+ * @param truncateLabels If true, only a slice of labels will be returned.
49288
49293
  */
49289
49294
  async getProjectTrainingDataSummary(projectId, queryParams, options = { headers: {} }) {
49290
49295
  const localVarPath = this.basePath + '/api/{projectId}/data-summary'
@@ -49314,6 +49319,9 @@ class ProjectsApi {
49314
49319
  if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.includeNotProcessed) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.includeNotProcessed) !== null) {
49315
49320
  queryParameters['includeNotProcessed'] = queryParams.includeNotProcessed;
49316
49321
  }
49322
+ if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateLabels) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateLabels) !== null) {
49323
+ queryParameters['truncateLabels'] = queryParams.truncateLabels;
49324
+ }
49317
49325
  localVarHeaderParams = {
49318
49326
  ...localVarHeaderParams,
49319
49327
  ...options.headers,
@@ -55785,6 +55793,7 @@ class RawDataApi {
55785
55793
  * @summary Get project dataset metadata
55786
55794
  * @param projectId Project ID
55787
55795
  * @param datasetVersionId Dataset version ID. If not set, the current dataset version is used
55796
+ * @param truncateLabels If true, only a slice of labels will be returned.
55788
55797
  * @param includeDisabled Whether to include enabled-only samples, or both enabled and disabled samples (defaults to both).
55789
55798
  */
55790
55799
  async getRawDataProjectMetadata(projectId, queryParams, options = { headers: {} }) {
@@ -55812,6 +55821,9 @@ class RawDataApi {
55812
55821
  if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.datasetVersionId) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.datasetVersionId) !== null) {
55813
55822
  queryParameters['datasetVersionId'] = queryParams.datasetVersionId;
55814
55823
  }
55824
+ if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateLabels) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.truncateLabels) !== null) {
55825
+ queryParameters['truncateLabels'] = queryParams.truncateLabels;
55826
+ }
55815
55827
  if (typeof (queryParams === null || queryParams === void 0 ? void 0 : queryParams.includeDisabled) !== 'undefined' && (queryParams === null || queryParams === void 0 ? void 0 : queryParams.includeDisabled) !== null) {
55816
55828
  queryParameters['includeDisabled'] = queryParams.includeDisabled;
55817
55829
  }