Preview samples for AI Actions

Get a number of random samples to show in the AI Actions screen. If saveConfig is passed in, then a valid actionId is required in the URL. If you don’t need to save the config (e.g. when creating a new action), you can use -1.

POST /api/{projectId}/ai-actions/{actionId}/preview-samples

Try it

Preview samples for AI Actions

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}/preview-samples \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "saveConfig": true,
  "dataCategory": "allData",
  "maxDataPreviewCount": 123,
  "dataMetadataKey": "<string>",
  "dataMetadataValue": "<string>"
}
'

200

{
  "success": true,
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "created": "2023-11-07T05:31:56Z",
      "lastModified": "2023-11-07T05:31:56Z",
      "category": "training",
      "coldstorageFilename": "<string>",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceType": "<string>",
      "sensors": [
        {
          "name": "accX",
          "units": "<string>"
        }
      ],
      "valuesCount": 123,
      "added": "2023-11-07T05:31:56Z",
      "boundingBoxes": [
        {
          "label": "<string>",
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "isDisabled": true,
      "isProcessing": true,
      "processingError": true,
      "isCropped": true,
      "projectId": 123,
      "sha256Hash": "<string>",
      "signatureMethod": "HS256",
      "signatureKey": "<string>",
      "deviceName": "<string>",
      "totalLengthMs": 123,
      "thumbnailVideo": "<string>",
      "thumbnailVideoFull": "<string>",
      "processingJobId": 123,
      "processingErrorString": "<string>",
      "metadata": {},
      "projectOwnerName": "<string>",
      "projectName": "<string>",
      "projectLabelingMethod": "single_label",
      "structuredLabels": [
        {
          "startIndex": 123,
          "endIndex": 123,
          "label": "<string>"
        }
      ],
      "structuredLabelsList": [
        "<string>"
      ],
      "createdBySyntheticDataJobId": 123,
      "imageDimensions": {
        "width": 123,
        "height": 123
      },
      "videoUrl": "<string>",
      "videoUrlFull": "<string>"
    }
  ],
  "totalCount": 123,
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

actionId · integer · required

AI Action ID

Body

application/json

saveConfig · boolean · required

If this is passed in, the previewConfig of the AI action is overwritten (requires actionId to be a valid action).

dataCategory · enum<string> · required

Type of data to preview. A random subset of this data will be returned.

Available options: allData, unlabeledData, enabledData, dataWithoutMetadataKey, dataWithMetadata

maxDataPreviewCount · integer · required

Max. amount of data items to return.

dataMetadataKey · string

Metadata key to filter on. Required if dataCategory is equal to "dataWithoutMetadataKey" or "dataWithMetadata".

dataMetadataValue · string

Metadata value to filter on. Required if dataCategory is equal to "dataWithMetadata".

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

samples · object[] · required

Show child attributes

samples. id · integer · required

Example:

2

samples. filename · string · required

Example:

"idle01.d8Ae"

samples. signatureValidate · boolean · required

Whether signature validation passed

Example:

true

samples. created · string<date-time> · required

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

samples. lastModified · string<date-time> · required

Timestamp when the sample was last modified.

samples. category · enum<string> · required

Available options: training, testing, post-processing

Example:

"training"

samples. coldstorageFilename · string · required

samples. label · string · required

Example:

"healthy-machine"

samples. intervalMs · number · required

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example:

16

samples. frequency · number · required

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example:

62.5

samples. originalIntervalMs · number · required

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example:

16

samples. originalFrequency · number · required

Frequency of the sample in the source data (before resampling).

Example:

62.5

samples. deviceType · string · required

samples. sensors · object[] · required

Show child attributes

samples.sensors. name · string · required

Name of the axis

Example:

"accX"

samples.sensors. units · string · required

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

samples. valuesCount · integer · required

Number of readings in this file

samples. added · string<date-time> · required

Timestamp when the sample was added to the current acquisition bucket.

samples. boundingBoxes · object[] · required

Show child attributes

samples.boundingBoxes. label · string · required

samples.boundingBoxes. x · integer · required

samples.boundingBoxes. y · integer · required

samples.boundingBoxes. width · integer · required

samples.boundingBoxes. height · integer · required

samples. boundingBoxesType · enum<string> · required

Available options: object_detection, constrained_object_detection

samples. chartType · enum<string> · required

Available options: chart, image, video, table

samples. isDisabled · boolean · required

True if the current sample is excluded from use

samples. isProcessing · boolean · required

True if the current sample is still processing (e.g. for video)

samples. processingError · boolean · required

Set when processing this sample failed

samples. isCropped · boolean · required

Whether the sample is cropped from another sample (and has crop start / end info)

samples. projectId · integer · required

Unique identifier of the project this sample belongs to

samples. sha256Hash · string · required

Data sample SHA 256 hash (including CBOR envelope if applicable)

samples. signatureMethod · string

Example:

"HS256"

samples. signatureKey · string

Either the shared key or the public key that was used to validate the sample

samples. deviceName · string

samples. totalLengthMs · number

Total length (in ms.) of this file

samples. thumbnailVideo · string

samples. thumbnailVideoFull · string

samples. processingJobId · integer

Set when sample is processing and a job has picked up the request

samples. processingErrorString · string

Error (only set when processing this sample failed)

samples. metadata · object

Sample free form associated metadata

Show child attributes

samples.metadata. {key} · string

samples. projectOwnerName · string

Name of the owner of the project this sample belongs to

samples. projectName · string

Name of the project this sample belongs to

samples. projectLabelingMethod · enum<string>

What labeling flow the project this sample belongs to uses

Available options: single_label, object_detection

samples. structuredLabels · object[]

Show child attributes

samples.structuredLabels. startIndex · integer · required

Start index of the label (e.g. 0)

samples.structuredLabels. endIndex · integer · required

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

samples.structuredLabels. label · string · required

The label for this section.

samples. structuredLabelsList · string[]

samples. createdBySyntheticDataJobId · integer

If this sample was created by a synthetic data job, it's referenced here.

samples. imageDimensions · object

Show child attributes

samples.imageDimensions. width · integer · required

samples.imageDimensions. height · integer · required

samples. videoUrl · string

Video link, cropped and in original resolution.

samples. videoUrlFull · string

Video link in original resolution.

totalCount · integer · required

error · string

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