Test pretrained model

Test out a pretrained model (using raw features) - upload first via uploadPretrainedModel. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob.

POST /api/{projectId}/pretrained-model/test

Try it

Test pretrained model

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/pretrained-model/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "features": [
    123
  ],
  "modelInfo": {
    "input": {
      "inputType": "time-series",
      "frequencyHz": 123,
      "windowLengthMs": 123
    },
    "model": {
      "modelType": "classification",
      "labels": [
        "<string>"
      ]
    }
  }
}
'

200

{
  "success": true,
  "error": "<string>",
  "result": {},
  "boundingBoxes": [
    {
      "label": "<string>",
      "x": 123,
      "y": 123,
      "width": 123,
      "height": 123,
      "score": 123
    }
  ]
}

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.

Body

application/json

features · number[] · required

modelInfo · object · required

Show child attributes

modelInfo. input · object · required

Option 1

Show child attributes

modelInfo.input. inputType · enum<string> · required

Available options: time-series

modelInfo.input. frequencyHz · number · required

modelInfo.input. windowLengthMs · integer · required

modelInfo. model · object · required

Option 1

Show child attributes

modelInfo.model. modelType · enum<string> · required

Available options: classification

modelInfo.model. labels · string[] · required

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

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

result · object

Classification value per label. For a neural network this will be the confidence, for anomalies the anomaly score.

Show child attributes

result. {key} · number

boundingBoxes · object[]

Show child attributes

boundingBoxes. label · string · required

boundingBoxes. x · number · required

boundingBoxes. y · number · required

boundingBoxes. width · number · required

boundingBoxes. height · number · required

boundingBoxes. score · number · required