Train model (Anomaly)

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "axes": [
    0,
    11,
    22
  ],
  "minimumConfidenceRating": 0.3,
  "clusterCount": 32,
  "skipEmbeddingsAndMemory": true,
  "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.",
      "value": 0.5,
      "suggestedValue": 123,
      "suggestedValueText": "<string>"
    }
  ]
}
'

{
  "success": true,
  "id": 12873488112,
  "error": "<string>"
}

POST

api

{projectId}

jobs

train

anomaly

{learnId}

Train model (Anomaly)

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "axes": [
    0,
    11,
    22
  ],
  "minimumConfidenceRating": 0.3,
  "clusterCount": 32,
  "skipEmbeddingsAndMemory": true,
  "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.",
      "value": 0.5,
      "suggestedValue": 123,
      "suggestedValueText": "<string>"
    }
  ]
}
'

{
  "success": true,
  "id": 12873488112,
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

projectId

integer

required

Project ID

learnId

integer

required

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

Body

application/json

axes

integer[]

required

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

Example:

[0, 11, 22]

minimumConfidenceRating

number

required

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

Example:

0.3

clusterCount

integer

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

Example:

32

skipEmbeddingsAndMemory

boolean

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

thresholds

object[]

List of configurable thresholds for this block.

Show child attributes

thresholds.key

string

required

Identifier to reference the threshold. You'll need to refer to the threshold by this key when you set the threshold).

Example:

"min_score"

thresholds.description

string

required

User-friendly description of the threshold.

Example:

"Score threshold"

thresholds.helpText

string

required

Additional help text (shown in the UI under a "?" icon)

Example:

"Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded."

thresholds.value

number

required

Current value of the threshold

Example:

0.5

thresholds.suggestedValue

number

If the threshold has a suggested value, e.g. a max. absolute error for regression projects; or the min. anomaly score for visual anomaly detection, then this is the numeric value of that threshold.

thresholds.suggestedValueText

string

If the threshold has a suggested value, e.g. a max. absolute error for regression projects; or the min. anomaly score for visual anomaly detection, then this is the stringified value of that threshold.

Response

200 - application/json

success

boolean

required

Whether the operation succeeded

integer

required

Job identifier. Status updates will include this identifier.

Example:

12873488112

error

string

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

Train model (Keras)

Export Keras block

⌘I

OVERVIEW

STUDIO API ENDPOINTS

Train model (Anomaly)

Authorizations

Path Parameters

Body

Response