Jobs

Train model (Anomaly)

Take the output from a DSP block and train an anomaly detection model using K-means or GMM. Updates are streamed over the websocket API.

post/api/{projectId}/jobs/train/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/jobs/train/anomaly/:learnId/post.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

Request body

axesinteger[] required

Which axes (indexes from DSP script) to include in the training set

clusterCountinteger

Number of clusters for K-means, or number of components for GMM

minimumConfidenceRatingnumber required

DEPRECATED, use "thresholds" instead. Minimum confidence rating required before tagging as anomaly

skipEmbeddingsAndMemoryboolean

If set, skips creating embeddings and measuring memory (used in tests)

Example request

{
  "axes": [
    0,
    11,
    22
  ],
  "clusterCount": 32,
  "minimumConfidenceRating": 0.3,
  "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."
    }
  ]
}

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Job identifier. Status updates will include this identifier.

Example response

{
  "id": 12873488112
}

Changes

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