Get AI Actions proposed changes

Get proposed changes from an AI Actions job.

GET /api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes

Try it

Get AI Actions proposed changes

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "proposedChanges": [
    {
      "sampleId": 123,
      "step": 123,
      "proposedChanges": {
        "label": "<string>",
        "isDisabled": true,
        "boundingBoxes": [
          {
            "label": "<string>",
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123
          }
        ],
        "metadata": {},
        "structuredLabels": [
          {
            "startIndex": 123,
            "endIndex": 123,
            "label": "<string>"
          }
        ]
      }
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

jobId · integer · required

Job ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

proposedChanges · object[] · required

Show child attributes

proposedChanges. sampleId · integer · required

proposedChanges. step · integer · required

proposedChanges. proposedChanges · object · required

Show child attributes

proposedChanges.proposedChanges. label · string

New label (single-label)

proposedChanges.proposedChanges. isDisabled · boolean

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

proposedChanges.proposedChanges. boundingBoxes · 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).

Show child attributes

proposedChanges.proposedChanges.boundingBoxes. label · string · required

proposedChanges.proposedChanges.boundingBoxes. x · integer · required

proposedChanges.proposedChanges.boundingBoxes. y · integer · required

proposedChanges.proposedChanges.boundingBoxes. width · integer · required

proposedChanges.proposedChanges.boundingBoxes. height · integer · required

proposedChanges.proposedChanges. metadata · object

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).

Show child attributes

proposedChanges.proposedChanges.metadata. {key} · string

proposedChanges.proposedChanges. structuredLabels · object[]

New label (multi-label)

Show child attributes

proposedChanges.proposedChanges.structuredLabels. startIndex · integer · required

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

proposedChanges.proposedChanges.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.

proposedChanges.proposedChanges.structuredLabels. label · string · required

The label for this section.

error · string

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