Get parameter sets

Get performance calibration parameter sets

GET /api/{projectId}/performance-calibration/parameter-sets

Try it

Get parameter sets

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/parameter-sets \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "parameterSets": [
    {
      "detections": [
        {
          "time": 123,
          "label": "<string>"
        }
      ],
      "isBest": true,
      "labels": [
        "<string>"
      ],
      "aggregateStats": {
        "falsePositiveRate": 123,
        "falseNegativeRate": 123
      },
      "stats": [
        {
          "label": "<string>",
          "truePositives": 123,
          "falsePositives": 123,
          "falseNegatives": 123,
          "trueNegatives": 123,
          "falsePositiveRate": 123,
          "falseNegativeRate": 123,
          "falseNegativeTimes": [
            123
          ],
          "falsePositiveDetails": [
            {
              "type": "incorrect",
              "detectionTime": 123,
              "groundTruthLabel": "<string>",
              "groundTruthStart": 123,
              "sampleIds": [
                123
              ]
            }
          ]
        }
      ],
      "params": {
        "type": "standard",
        "version": 1,
        "parametersStandard": {
          "averageWindowDurationMs": 1000,
          "detectionThreshold": 0.8,
          "suppressionMs": 500
        }
      },
      "windowSizeMs": 123
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Query Parameters

impulseId · integer

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

Response

200 - application/json

File

success · boolean · required

Whether the operation succeeded

parameterSets · object[] · required

Show child attributes

parameterSets. detections · object[] · required

All of the detections using this parameter set

Show child attributes

parameterSets.detections. time · integer · required

The time of the detection in milliseconds

parameterSets.detections. label · string · required

The label that was detected

parameterSets. isBest · boolean · required

Whether this is considered the best parameter set

parameterSets. labels · string[] · required

All of the possible labels in the detections array

parameterSets. aggregateStats · object · required

Show child attributes

parameterSets.aggregateStats. falsePositiveRate · number · required

parameterSets.aggregateStats. falseNegativeRate · number · required

parameterSets. stats · object[] · required

Show child attributes

parameterSets.stats. label · string · required

parameterSets.stats. truePositives · integer · required

parameterSets.stats. falsePositives · integer · required

parameterSets.stats. falseNegatives · integer · required

parameterSets.stats. trueNegatives · integer · required

parameterSets.stats. falsePositiveRate · number · required

parameterSets.stats. falseNegativeRate · number · required

parameterSets.stats. falseNegativeTimes · number[] · required

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

parameterSets.stats. falsePositiveDetails · object[]

The details of every false positive detection.

Show child attributes

parameterSets.stats.falsePositiveDetails. type · enum<string> · required

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.

Available options: incorrect, duplicate, spurious

parameterSets.stats.falsePositiveDetails. detectionTime · integer · required

The time of the detection in milliseconds

parameterSets.stats.falsePositiveDetails. groundTruthLabel · string

The label of any associated ground truth

parameterSets.stats.falsePositiveDetails. groundTruthStart · number

The start time of any associated ground truth

parameterSets.stats.falsePositiveDetails. sampleIds · integer[]

All of the sample IDs in the affected region

parameterSets. params · object · required

Show child attributes

parameterSets.params. type · enum<string> · required

The post-processing algorithm type.

Available options: standard

parameterSets.params. version · integer · required

The version number of the post-processing algorithm.

Example:

1

parameterSets.params. parametersStandard · object

Show child attributes

parameterSets.params.parametersStandard. averageWindowDurationMs · number · required

The length of the averaging window in milliseconds.

Example:

1000

parameterSets.params.parametersStandard. detectionThreshold · number · required

The minimum threshold for detection, from 0-1.

Example:

0.8

parameterSets.params.parametersStandard. suppressionMs · number · required

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

Example:

500

parameterSets. windowSizeMs · number · required

The size of the input block window in milliseconds.

error · string

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