Learn

Anomaly information

Get information about an anomaly block, such as its dependencies. Use the impulse blocks to find the learnId.

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/training/anomaly/:learnId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

learnIdinteger required

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

Response

successboolean required

Whether the operation succeeded

errorstring

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

namestring required

trainedboolean required

Whether the block is trained

clusterCountinteger

Number of clusters for K-means, or number of components for GMM (in config)

selectedAxesinteger[] required

Selected clusters (in config)

minimumConfidenceRatingnumber required

DEPRECATED, see "thresholds" instead. Minimum confidence rating for this block, scores above this number will be flagged as anomaly.

Example response

{
  "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.