Check if label noise metrics exist

Determine if label noise metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GET /api/{projectId}/raw-data/data-quality/label-noise/exists

Try it

Check if label noise metrics exist

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/label-noise/exists \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "hasFeatures": true,
  "error": "<string>",
  "inputBlock": {
    "id": 2,
    "type": "time-series",
    "name": "Time series",
    "title": "Time series",
    "windowSizeMs": 2004,
    "windowIncreaseMs": 123,
    "frequencyHz": 60,
    "classificationWindowIncreaseMs": 123,
    "padZeros": true,
    "labelingMethodMultiLabel": {
      "type": "end-of-window",
      "labels": [
        "<string>"
      ]
    },
    "imageWidth": 28,
    "imageHeight": 28,
    "resizeMode": "squash",
    "resizeMethod": "squash",
    "cropAnchor": "middle-center",
    "createdBy": "createImpulse",
    "createdAt": "2023-11-07T05:31:56Z",
    "datasetSubset": {
      "includePercentage": 123,
      "seed": 123
    }
  }
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

hasFeatures · boolean · required

error · string

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

inputBlock · object

Show child attributes

inputBlock. id · integer · required

Identifier for this block. Make sure to up this number when creating a new block via getNewBlockId, and don't re-use identifiers. If the block hasn't changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).

Required range: x >= 1

inputBlock. type · enum<string> · required

Block type (either time-series, image or features)

Available options: time-series, image, features

Example:

"time-series"

inputBlock. name · string · required

Block name, will be used in menus

Example:

"Time series"

inputBlock. title · string · required

Block title, used in the impulse UI

Example:

"Time series"

inputBlock. windowSizeMs · integer

Size of the sliding window in milliseconds

Example:

2004

inputBlock. windowIncreaseMs · integer

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

inputBlock. frequencyHz · number

(Input only) Frequency of the input data in Hz

Example:

60

inputBlock. classificationWindowIncreaseMs · integer

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

inputBlock. padZeros · boolean

Whether to zero pad data when a data item is too short

inputBlock. labelingMethodMultiLabel · object

How to pick the label for multi-label samples

Show child attributes

inputBlock.labelingMethodMultiLabel. type · enum<string> · required

Available options: end-of-window, anywhere-in-window

inputBlock.labelingMethodMultiLabel. labels · string[]

Required when choosing "anywhere-in-window". The list of classes that should trigger detection (e.g. "interference").

inputBlock. imageWidth · integer

Width all images are resized to before training

Example:

28

inputBlock. imageHeight · integer

Width all images are resized to before training

Example:

28

inputBlock. resizeMode · enum<string>

Input images are resized automatically before training and testing, to match the impulse input shape. This determines the resize mode used when the aspect ratio of the input data is different to the aspect ratio of the impulse.

Available options: squash, fit-short, fit-long, crop

Example:

"squash"

inputBlock. resizeMethod · enum<string>

Resize method to use when resizing images

Available options: lanczos3, nearest

Example:

"squash"

inputBlock. cropAnchor · enum<string>

If images are resized using a crop, choose where to anchor the crop

Available options: top-left, top-center, top-right, middle-left, middle-center, middle-right, bottom-left, bottom-center, bottom-right

Example:

"middle-center"

inputBlock. createdBy · string

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example:

"createImpulse"

inputBlock. createdAt · string<date-time>

The datetime that the block version was created. Cannot be set via API.

inputBlock. datasetSubset · object

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

Show child attributes

inputBlock.datasetSubset. includePercentage · number · required

Number between 0 and 100, with the % of data that should be included

inputBlock.datasetSubset. seed · integer

Seed number (optional). If not specified, the seed is set to 0.