Get AI Actions config

Get an AI Actions config

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}

Path parameters

projectId*integer

Project ID

actionId*integer

AI Action ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

action*AIAction (object)

id*integer

namestring

Manually set name (optional)

displayName*string

Name to show to the user when interacting with this action (e.g. in a table, or when running the action). Will return either "name" (if present), or a name derived from the transformation block.

config*AIActionsConfig (object)

dataCategory*AIActionsDataCategory (enum)

allDataunlabeledDatadataWithoutMetadataKeydataWithMetadata

dataMetadataKeystring

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

dataMetadataValuestring

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

steps*array of AIActionsConfigStep (object)

transformationBlockId*integer

The selected transformation block ID.

parameters*object

Parameters for the transformation block. These map back to the parameters in OrganizationTransformationBlock 'parameters' property.

Other propertiesstring

previewConfig*AIActionsConfig (object)

dataCategory*AIActionsDataCategory (enum)

allDataunlabeledDatadataWithoutMetadataKeydataWithMetadata

dataMetadataKeystring

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

dataMetadataValuestring

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

steps*array of AIActionsConfigStep (object)

transformationBlockId*integer

The selected transformation block ID.

parameters*object

Parameters for the transformation block. These map back to the parameters in OrganizationTransformationBlock 'parameters' property.

Other propertiesstring

maxDataPreviewCount*integer

When rendering preview items, the max amount of items to show (pass this into the previewAIActionsSamples)

gridColumnCount*integer

Number of grid columns to use during preview.

lastPreviewStateobject

Contains the last preview state, this is filled with whatever was ran last, so when you refresh an AI Action it'll always have the exact same state as before refresh.

samples*array of Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

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

created*string (date-time)

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.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

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

Example: 16

frequency*number

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

Example: 62.5

originalIntervalMs*number

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

Example: 16

originalFrequency*number

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

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

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

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

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

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

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

processingJobIdinteger

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

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

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

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

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

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

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

endIndex*integer

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

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

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

imageDimensionsobject

width*integer

height*integer

proposedChanges*array of object

sampleId*integer

step*integer

proposedChanges*SampleProposedChanges (object)

labelstring

New label (single-label)

isDisabledboolean

True if the current sample should be disabled; or false if it should not be disabled.

boundingBoxesarray of BoundingBox (object)

List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).

label*string

x*integer

y*integer

width*integer

height*integer

metadataobject

Free form associated metadata. The existing metadata on the sample will be replaced (so if you want to add new metadata, use the existing list as a basis).

Other propertiesstring

structuredLabelsarray of StructuredLabel (object)

New label (multi-label)

startIndex*integer

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

endIndex*integer

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

label*string

The label for this section.

setMetadataAfterRunning*array of object

After the action runs, add this key/value pair as metadata on the affected samples.

key*string

value*string

cacheUnchangedSteps*boolean

If enabled, will load cached results from the previous preview job for unchanged jobs. Disable this if you're developing your own custom AI Labeling job, and want to always re-run all steps.

Request

Response