Get parameter sets

Get performance calibration parameter sets

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/parameter-sets

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

File

Body

success*boolean

Whether the operation succeeded

errorstring

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

parameterSets*array of PerformanceCalibrationParameterSet (object)

detections*array of PerformanceCalibrationDetection (object)

All of the detections using this parameter set

time*integer

The time of the detection in milliseconds

label*string

The label that was detected

isBest*boolean

Whether this is considered the best parameter set

labels*array of string

All of the possible labels in the detections array

itemsstring

aggregateStats*object

falsePositiveRate*number

falseNegativeRate*number

stats*array of object

label*string

truePositives*integer

falsePositives*integer

falseNegatives*integer

trueNegatives*integer

falsePositiveRate*number

falseNegativeRate*number

falsePositiveDetailsarray of PerformanceCalibrationFalsePositive (object)

The details of every false positive detection.

type*enum

The type of false positive. Incorrect is when a detection matches the wrong ground truth. Duplicate is when the same ground truth was detected more than once. The first correct detection is considered a true positive but subsequent detections are considered false positives. Spurious is when the detection was not associated with any ground truth.

incorrectduplicatespurious

detectionTime*integer

The time of the detection in milliseconds

groundTruthLabelstring

The label of any associated ground truth

groundTruthStartnumber

The start time of any associated ground truth

sampleIdsarray of integer

All of the sample IDs in the affected region

itemsinteger

falseNegativeTimes*array of number

The times in ms at which false negatives occurred. These correspond to specific items in the ground truth.

itemsnumber

params*PerformanceCalibrationParameters (object)

type*enum

The post-processing algorithm type.

standard

version*integer

The version number of the post-processing algorithm.

Example: 1

parametersStandardPerformanceCalibrationParametersStandard (object)

averageWindowDurationMs*number

The length of the averaging window in milliseconds.

Example: 1000

detectionThreshold*number

The minimum threshold for detection, from 0-1.

Example: 0.8

suppressionMs*number

The amount of time new matches will be ignored after a positive result.

Example: 500

windowSizeMs*number

The size of the input block window in milliseconds.

Request

Response