Propose changes

Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

jobId*integer

Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Propose changes

Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

jobId*integer

Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "jobId": 0,
      "proposedChanges": {}
    }),
});
const data = await response.json();