Get diversity metrics data

Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/diversity

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

dataarray of object

labelIdnumber

maxDistance*number

clusterInfos*array of object

idx*integer

Unique index of the cluster

indexes*array of integer

Indexes of all windows contained in the cluster (for debugging)

itemsinteger

windows*array of array of integer

The sample ID and window start and end of every window in the cluster

itemsinteger

samplesarray of Sample (object)

Details of every sample in the cluster

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

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)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

vendiScore*number

Raw vendi score

vendiRatio*number

Vendi score expressed as ratio from 0 to 1

count*integer

The number if windows in the cluster

distance*number

The distance of the cluster from the origin

leftIdx*nullable integer

The cluster id on the left branch of the dendrogram

rightIdx*nullable integer

The cluster id on the right branch of the dendrogram

Request

Response