Learn

Anomaly metadata

Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId.

get/api/{projectId}/training/anomaly/{learnId}/metadata

Request

Path parameters

projectIdinteger required

Project ID

learnIdinteger required

Learn Block ID, use the impulse functions to retrieve the ID

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

createdstring date-time required

Date when the model was trained

scalenumber[] required

Scale input for StandardScaler. Values are scaled like this (where ix is axis index): input[ix] = (input[ix] - mean[ix]) / scale[ix];

meannumber[] required

Mean input for StandardScaler. Values are scaled like this (where ix is axis index): input[ix] = (input[ix] - mean[ix]) / scale[ix];

axesinteger[] required

Which axes were included during training (by index)

defaultMinimumConfidenceRatingnumber required

DEPRECATED, see "thresholds" instead. Default minimum confidence rating required before tagging as anomaly, based on scores of training data (GMM only).

availableModelTypesKerasModelTypeEnum[]

The types of model that are available

recommendedModelType'int8' | 'float32' | 'akida' | 'requiresRetrain'
hasTrainedModelboolean

Example response

{
  "modelValidationMetrics": [
    {
      "confusionMatrix": [
        [
          31,
          1,
          0
        ],
        [
          2,
          27,
          3
        ],
        [
          1,
          0,
          39
        ]
      ]
    }
  ],
  "thresholds": [
    {
      "key": "min_score",
      "description": "Score threshold",
      "helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.