Get AI Actions proposed changes

Get proposed changes from an AI Actions job.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes

Path parameters

projectId*integer

Project ID

jobId*integer

Job ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

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.

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "proposedChanges": [
    {
      "proposedChanges": {
        "label": "text",
        "isDisabled": false,
        "boundingBoxes": [
          {
            "label": "text"
          }
        ],
        "structuredLabels": [
          {
            "label": "text"
          }
        ]
      }
    }
  ]
}