--- title: "Get label noise data" method: GET path: "/api/{projectId}/raw-data/data-quality/label-noise" tags: ["Raw data"] --- # Get label noise data `GET /api/{projectId}/raw-data/data-quality/label-noise` ## Request - Base URL: `https://studio.edgeimpulse.com/v1` - URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/label-noise` - Auth: one of: - API key in header `x-api-key` - API key in cookie `jwt` - API key in header `x-jwt-token` - OAuth 2 - Authorization code: `/v1/oauth/authorize` - Client credentials - Implicit: `/v1/oauth/authorize` - Password - Token URL: `/v1/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the `calculateDataQualityMetrics` endpoint. ## Path parameters - `projectId` integer, required ## Response `200` OK - GetLabelNoiseDataResponse - `success` boolean, required: Whether the operation succeeded - `error` string: Optional error description (set if 'success' was false) - `data` object, required - `cosineSimilarity` CosineSimilarityData: Describes the results of running the cosine similarity label noise detection method. - `similarButDifferentLabel` CosineSimilarityIssue[], required: A list of samples that have windows that are similar to windows of other samples that have a different label. - `id` integer, required: The ID of this sample - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - `index` integer, required: Index of the sensor (globally, so you can refer back to it in e.g. getSampleAsAudio) - `name` string, required: Name of the axis - `units` string, required: Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml). - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - `label` string, required - `x` integer, required - `y` integer, required - `width` integer, required - `height` integer, required - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - `startIndex` integer, required: Start index of the label (e.g. 0) - `endIndex` integer, required: End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3. - `label` string, required: The label for this section. - `labelMap` SampleLabelMapLabels - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - `width` integer, required - `height` integer, required - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - `type` 'key-values', required - `labels` object, required - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - LastUpdatedByUser: The user who last updated a sample. - … - LastUpdatedByProjectApiKey: The project API key that last updated a sample. - … - LastUpdatedByOAuthClient: The OAuth client that last updated a sample, and the user it is acting on behalf of. - … - LastUpdatedByDatasetVersionRestore: The dataset restore that last updated a sample. - … - `datastreams` SampleDatastream[], required - `index` integer, required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `intervalMs` number, required: Interval between two windows (1000 / frequency). - `frequencyHz` number, required: Frequency of the datastream - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this datastream. - `imageDimensions` object - … - `totalLengthMs` number, required: Total length (in ms.) of the datastream - `label` integer, required: The label of this sample, in index form - `issues` object[], required: A list of samples that have windows that are symptomatic of this issue. - `id` integer, required: The ID of this sample - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - … - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - … - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - … - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - … - `datastreams` SampleDatastream[], required - … - `label` integer, required: The label of this sample, in index form - `windows` object[], required: The windows in this sample that are symptomatic of this issue. - `windowStart` integer, required: The start time of this window in milliseconds - `windowEnd` integer, required: The end time of this window in milliseconds - `score` number, required: The cosine similarity score between this window and a window from the sample in the parent object. - `differentButSameLabel` CosineSimilarityIssue[], required: A list of samples that have windows that are dissimilar to windows of other samples that have the same label. - `id` integer, required: The ID of this sample - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - `index` integer, required: Index of the sensor (globally, so you can refer back to it in e.g. getSampleAsAudio) - `name` string, required: Name of the axis - `units` string, required: Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml). - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - `label` string, required - `x` integer, required - `y` integer, required - `width` integer, required - `height` integer, required - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - `startIndex` integer, required: Start index of the label (e.g. 0) - `endIndex` integer, required: End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3. - `label` string, required: The label for this section. - `labelMap` SampleLabelMapLabels - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - `width` integer, required - `height` integer, required - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - `type` 'key-values', required - `labels` object, required - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - LastUpdatedByUser: The user who last updated a sample. - … - LastUpdatedByProjectApiKey: The project API key that last updated a sample. - … - LastUpdatedByOAuthClient: The OAuth client that last updated a sample, and the user it is acting on behalf of. - … - LastUpdatedByDatasetVersionRestore: The dataset restore that last updated a sample. - … - `datastreams` SampleDatastream[], required - `index` integer, required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `intervalMs` number, required: Interval between two windows (1000 / frequency). - `frequencyHz` number, required: Frequency of the datastream - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this datastream. - `imageDimensions` object - … - `totalLengthMs` number, required: Total length (in ms.) of the datastream - `label` integer, required: The label of this sample, in index form - `issues` object[], required: A list of samples that have windows that are symptomatic of this issue. - `id` integer, required: The ID of this sample - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - … - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - … - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - … - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - … - `datastreams` SampleDatastream[], required - … - `label` integer, required: The label of this sample, in index form - `windows` object[], required: The windows in this sample that are symptomatic of this issue. - `windowStart` integer, required: The start time of this window in milliseconds - `windowEnd` integer, required: The end time of this window in milliseconds - `score` number, required: The cosine similarity score between this window and a window from the sample in the parent object. - `neighbors` NeighborsData: Describes the results of running the nearest neighbors label noise detection method. - `scoresAndNeighbors` NeighborsScore[], required: The label noise score and nearest neighbors for each window of data in the project that shows a potential label noise issue. - `id` integer, required: The ID of the sample this window belongs to - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - `index` integer, required: Index of the sensor (globally, so you can refer back to it in e.g. getSampleAsAudio) - `name` string, required: Name of the axis - `units` string, required: Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml). - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - `label` string, required - `x` integer, required - `y` integer, required - `width` integer, required - `height` integer, required - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - `startIndex` integer, required: Start index of the label (e.g. 0) - `endIndex` integer, required: End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3. - `label` string, required: The label for this section. - `labelMap` SampleLabelMapLabels - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - `width` integer, required - `height` integer, required - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - `type` 'key-values', required - `labels` object, required - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - LastUpdatedByUser: The user who last updated a sample. - … - LastUpdatedByProjectApiKey: The project API key that last updated a sample. - … - LastUpdatedByOAuthClient: The OAuth client that last updated a sample, and the user it is acting on behalf of. - … - LastUpdatedByDatasetVersionRestore: The dataset restore that last updated a sample. - … - `datastreams` SampleDatastream[], required - `index` integer, required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `intervalMs` number, required: Interval between two windows (1000 / frequency). - `frequencyHz` number, required: Frequency of the datastream - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this datastream. - `imageDimensions` object - … - `totalLengthMs` number, required: Total length (in ms.) of the datastream - `windowStart` integer, required: The start time of this window in milliseconds - `windowEnd` integer, required: The end time of this window in milliseconds - `score` number, required: The label noise score for this window, from 0 to the total number of windows. - `neighborWindows` object[], required: Details of the nearest neighbors to this window - `id` integer, required: The ID of the sample this window belongs to - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - … - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - … - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - … - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - … - `datastreams` SampleDatastream[], required - … - `windowStart` integer, required: The start time of this window in milliseconds - `windowEnd` integer, required: The end time of this window in milliseconds - `numNeighbors` integer, required: The number of neighbors used in the nearest neighbors algorithm. - `crossValidation` CrossValidationData: Describes the results of running the cross validation label noise detection method. - `scores` object[], required - `id` integer, required: The ID of the sample this window belongs to - `sample` Sample - `id` integer, required - `filename` string, required - `signatureValidate` boolean, required: Whether signature validation passed - `signatureMethod` string - `signatureKey` string: Either the shared key or the public key that was used to validate the sample - `created` string, date-time, required: Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service. - `lastModified` string, date-time, required: Timestamp when the sample was last modified. - `category` 'training' | 'testing' | 'validation' | 'post-processing', required - `coldstorageFilename` string, required - `label` string, required - `intervalMs` number, required: Interval between two windows (1000 / frequency). NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `frequency` number, required: Frequency of the sample. NOTE: Previously this value could change depending on whether the sample was resampled. This behavior has been removed. - `originalIntervalMs` number, required: DEPRECATED. See "intervalMs". - `originalFrequency` number, required: DEPRECATED. See "frequency". - `deviceName` string - `deviceType` string, required - `sensors` Sensor[], required - `index` integer, required: Index of the sensor (globally, so you can refer back to it in e.g. getSampleAsAudio) - `name` string, required: Name of the axis - `units` string, required: Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml). - `valuesCount` integer, required: Number of readings in this file. If you have multiple datastreams, this is the value count from the datastream with the highest frequency. - `totalLengthMs` number: Total length (in ms.) of this file - `added` string, date-time, required: Timestamp when the sample was added to the current acquisition bucket. - `boundingBoxes` BoundingBox[], required - `label` string, required - `x` integer, required - `y` integer, required - `width` integer, required - `height` integer, required - `boundingBoxesType` 'object_detection' | 'constrained_object_detection', required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `thumbnailVideo` string - `thumbnailVideoFull` string - `isDisabled` boolean, required: True if the current sample is excluded from use - `isProcessing` boolean, required: True if the current sample is still processing (e.g. for video) - `processingJobId` integer: Set when sample is processing and a job has picked up the request - `processingError` boolean, required: Set when processing this sample failed - `processingErrorString` string: Error (only set when processing this sample failed) - `isCropped` boolean, required: Whether the sample is cropped from another sample (and has crop start / end info) - `metadata` object: Sample free form associated metadata - `projectId` integer, required: Unique identifier of the project this sample belongs to - `projectOwnerName` string: Name of the owner of the project this sample belongs to - `projectName` string: Name of the project this sample belongs to - `projectLabelingMethod` 'single_label' | 'object_detection' | 'label_map' - `sha256Hash` string, required: Data sample SHA 256 hash (including CBOR envelope if applicable) - `structuredLabels` StructuredLabel[] - `startIndex` integer, required: Start index of the label (e.g. 0) - `endIndex` integer, required: End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3. - `label` string, required: The label for this section. - `labelMap` SampleLabelMapLabels - … - `structuredLabelsList` string[] - `createdBySyntheticDataJobId` integer: If this sample was created by a synthetic data job, it's referenced here. - `imageDimensions` object - `width` integer, required - `height` integer, required - `videoUrl` string: Video link, cropped and in original resolution. - `videoUrlFull` string: Video link in original resolution. - `labelMap` SampleLabelMapLabels - `type` 'key-values', required - `labels` object, required - `lastUpdatedBy` union: Information about the entity that last updated a sample. This can be a user, a project API key, an OAuth client, or a dataset version restore operation. - LastUpdatedByUser: The user who last updated a sample. - … - LastUpdatedByProjectApiKey: The project API key that last updated a sample. - … - LastUpdatedByOAuthClient: The OAuth client that last updated a sample, and the user it is acting on behalf of. - … - LastUpdatedByDatasetVersionRestore: The dataset restore that last updated a sample. - … - `datastreams` SampleDatastream[], required - `index` integer, required - `chartType` 'chart' | 'image' | 'video' | 'table', required - `intervalMs` number, required: Interval between two windows (1000 / frequency). - `frequencyHz` number, required: Frequency of the datastream - `sensors` Sensor[], required - … - `valuesCount` integer, required: Number of readings in this datastream. - `imageDimensions` object - … - `totalLengthMs` number, required: Total length (in ms.) of the datastream - `windowStart` integer, required: The start time of this window in milliseconds - `windowEnd` integer, required: The end time of this window in milliseconds - `label` integer, required: The label of this window, in index form - `probability` number, required: The probability of this window being the label it was assigned, as estimated by a classifier trained on the whole dataset. - `score` number, required: The z-score of the probability with respect to other class members, so that outliers (i.e. windows whose probability is low) can be easily spotted. This assumes that most correctly labelled class members will have a high probability. --- [API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)