Asset

This page is about the asset object in Ango Hub's export file. For more information on assets as they are used in Ango Hub, check out the page named Assets.

The asset is the main unit in the Ango Annotation Format. When obtaining an export from Ango Hub, you are essentially getting a list of assets.

This page details assets and their available metadata in the export format.

Structure Overview

{
   asset, // string, URL to the asset. May be signed.
   externalId, // string, externalId of the asset
   metadata, // object, metadata of the asset. See below for more.
   batches, // list, batches to which the asset belongs.
   task // object, information pertaining to labeling task, including annotations and more. See below for more.
}

Asset Object Properties

PropertyDescriptionExample

asset

the URL to the asset. If you have imported the asset as an URL, this will be the same URL. If you have imported it through drag and drop, this will be a signed URL allowing you to, for a period of 120000 seconds from export generation, download it from the Ango Private Bucket where it resides. WARNING: For multi-image assets, the asset URL will point to the first image (page 0) of the multi-image asset. To get the URLs of all images in the asset, parse the dataset list below.

"asset": "https://angohub-private-assets.s3.eu-central-1.amazonaws.com/e32d6ab2-d6f7-4e77-b671-88f16ec1f1e8.webm?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20230825%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20230825T070837Z&X-Amz-Expires=120000&X-Amz-Signature=509890db535e004df9286186dcffb680f63af7526956e6dc4f683c3295a0b6e3&X-Amz-SignedHeaders=host&x-id=GetObject"

dataset

URLs of all images in the assets, starting from page 0 onwards. Only in multi-image assets.

"dataset": [
    "https://angohub-public-assets.s3.eu-central-1.amazonaws.com/3e6e15b9-c32c-4b73-97f9-dbda784926ab.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20231009%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20231009T134740Z&X-Amz-Expires=120000&X-Amz-Signature=70790d6813a471f78f51261006f45971af8c0bb73c5266ed90225da2a7e7d5f6&X-Amz-SignedHeaders=host&x-id=GetObject",
    "https://angohub-public-assets.s3.eu-central-1.amazonaws.com/8b363eb9-5b7f-414c-89b8-b6907f29447b.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20231009%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20231009T134740Z&X-Amz-Expires=120000&X-Amz-Signature=fab97fcb3a6e457e4acf0525651047942e7349973758b0a533ea03e453bad039&X-Amz-SignedHeaders=host&x-id=GetObject"
    ]

assetId

ID of the asset. Only in multi-image assets.

"taskId": "64e5e5b985eb730015b4ebd9"

externalId

The external ID assigned to the asset at import time.

"externalId": "video-webm.webm"

metadata

Asset metadata is automatically fetched by Hub when the asset is first opened in the labeling editor.

If the asset is an image, the width and height of the image in pixels. If the asset is a video, the width/height in pixels of the video, the total number of frames (frameTotal) and the frame rate (frameRate) of the video specified during upload. (default 30fps if nothing was specified) If the asset is a PDF, the total number of pages. If the asset is a DICOM, the total number of frames.

// image
"metadata": {
    "width": 1200,
    "height": 800
  }
// video
"metadata": {
    "width": 1200,
    "height": 1200,
    "frameTotal": 507,
    "frameRate": 30
  }
// PDF
"metadata": {
    "width": 1200,
    "height": 1200,
    "frameTotal": 507,
    "frameRate": 30
  }

// DICOM
"metadata": {
    "width": 512,
    "height": 512,
    "frameTotal": 96
  }

batches

Batches to which the asset belongs.

"batches": ["batch_1", "batch_2"]

The information related to the labeling task that was exported attached to this asset. This includes the annotations themselves as well as metadata related to the task (e.g. annotator identity, annotation time/date, etc.) Documentation for the task property can be found here.

"task": {
    "taskId": "64e5e5b985eb730015b4ebd9",
    "stage": "Complete",
    "stageId": "Complete",
    "updatedAt": "2023-08-23T11:36:38.027Z",
    "updatedBy": "lorenzo@imerit.net",
    "totalDuration": 49596,
    "tools": [
      {
        "bounding-box": {
          "x": 301.6699801192843,
          "y": 429.05027932960894,
          "height": 173.76536312849163,
          "width": 118.09145129224652
        },
        "objectId": "765742a3b676d3f26898792",
        "classifications": [],
        "metadata": {
          "createdAt": "2023-08-23T11:20:32.792Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "schemaId": "b1c6805d054f0e44ae11500",
        "page": 504,
        "title": "bb"
      }
    ],
    "classifications": [
      {
        "objectId": "3d5cd10ba190b29d2850724",
        "schemaId": "6421df1fa34ac13204ea157",
        "tool": "radio",
        "title": "rdo",
        "answer": "1",
        "metadata": {
          "createdAt": "2023-08-23T11:20:51.725Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "classifications": []
      }
    ],
    "relations": [
      {
        "from": "9f4487231d385821865b486",
        "to": "9a1311e463600e8eb98f342",
        "objectId": "73b8926ffd17e3b000e4752",
        "schemaId": "8f8e617174718e80bbea268",
        "direction": "straight",
        "metadata": {
          "createdAt": "2023-08-23T11:32:33.752Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "page": 0,
        "title": "sng"
      }
    ],
    "stageHistory": [
      {
        "stage": "Start",
        "stageId": "Start",
        "duration": 0,
        "completedAt": "2023-08-23T10:55:53.495Z",
        "tools": [],
        "classifications": [],
        "relations": []
      },
      { ... }
    ]
  }

Sample Asset

{
  "asset": "https://angohub-private-assets.s3.eu-central-1.amazonaws.com/e32d6ab2-d6f7-4e77-b671-88f16ec1f1e8.webm?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIATAGM6WLISC5CRH7S%2F20230825%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20230825T070837Z&X-Amz-Expires=120000&X-Amz-Signature=509890db535e004df9286186dcffb680f63af7526956e6dc4f683c3295a0b6e3&X-Amz-SignedHeaders=host&x-id=GetObject",
  "externalId": "video-webm.webm",
  "metadata": {
    "frameTotal": 507,
    "frameRate": 30
  },
  "batches": [],
  "task": {
    "taskId": "64e5e5b985eb730015b4ebd9",
    "stage": "Complete",
    "stageId": "Complete",
    "updatedAt": "2023-08-23T11:36:38.027Z",
    "updatedBy": "lorenzo@imerit.net",
    "totalDuration": 49596,
    "tools": [
      {
        "bounding-box": {
          "x": 301.6699801192843,
          "y": 429.05027932960894,
          "height": 173.76536312849163,
          "width": 118.09145129224652
        },
        "objectId": "765742a3b676d3f26898792",
        "classifications": [],
        "metadata": {
          "createdAt": "2023-08-23T11:20:32.792Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "schemaId": "b1c6805d054f0e44ae11500",
        "page": 504,
        "title": "bb"
      },
      {
        "polygon": [
          [
            593.6779324055666,
            1121.9664804469273
          ],
          [
            443.3797216699801,
            1349.36312849162
          ],
          [
            576.5009940357853,
            1375.1061452513966
          ]
        ],
        "objectId": "408deff4664cc342d236127",
        "classifications": [],
        "metadata": {
          "createdAt": "2023-08-23T11:20:37.127Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "schemaId": "a966c7799383465850cd803",
        "page": 504,
        "title": "gon"
      },
      {
        "objectId": "765742a3b676d3f26898792",
        "schemaId": "b1c6805d054f0e44ae11500",
        "classifications": [],
        "bounding-box": {
          "x": 801.948310139165,
          "y": 1428.7374301675977,
          "height": 173.76536312849163,
          "width": 118.09145129224652
        },
        "metadata": {
          "createdAt": "2023-08-23T11:20:40.952Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "page": 506,
        "title": "bb"
      },
      {
        "objectId": "408deff4664cc342d236127",
        "schemaId": "a966c7799383465850cd803",
        "classifications": [],
        "polygon": [
          [
            217.93240556660038,
            229.54189944134077
          ],
          [
            67.63419483101391,
            456.9385474860335
          ],
          [
            200.75546719681907,
            482.68156424581
          ]
        ],
        "metadata": {
          "createdAt": "2023-08-23T11:20:42.215Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "page": 506,
        "title": "gon"
      }
    ],
    "classifications": [
      {
        "objectId": "3d5cd10ba190b29d2850724",
        "schemaId": "6421df1fa34ac13204ea157",
        "tool": "radio",
        "title": "rdo",
        "answer": "1",
        "metadata": {
          "createdAt": "2023-08-23T11:20:51.725Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "classifications": []
      },
      {
        "objectId": "f4e53917c222c8e62dbb715",
        "schemaId": "1ea7a275ce5c9cf30a6f148",
        "tool": "checkbox",
        "title": "chk",
        "answer": [
          "1"
        ],
        "metadata": {
          "createdAt": "2023-08-23T11:20:52.716Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "classifications": []
      },
      {
        "objectId": "0b057a52a2bb648b197f180",
        "schemaId": "a2b4a50bb90eb6523b88376",
        "tool": "single-dropdown",
        "title": "sdr",
        "answer": "1",
        "metadata": {
          "createdAt": "2023-08-23T11:20:54.180Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "classifications": []
      },
      {
        "objectId": "19ae5491832a3bd42704684",
        "schemaId": "11f6ed8e4ac4852d3422341",
        "tool": "multi-dropdown",
        "title": "mdr",
        "answer": [
          "1"
        ],
        "metadata": {
          "createdAt": "2023-08-23T11:20:55.684Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "classifications": []
      },
      {
        "objectId": "7ed41243066d9b09e652723",
        "schemaId": "c2b5eb27e55b186f84f3898",
        "tool": "tree-dropdown",
        "title": "tre",
        "answer": [
          "1",
          "1 / 2"
        ],
        "metadata": {
          "createdAt": "2023-08-23T11:20:59.723Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label",
          "updatedAt": "2023-08-23T11:21:01.940Z",
          "updatedBy": "lorenzo@imerit.net",
          "updatedIn": "Label"
        },
        "classifications": []
      },
      {
        "objectId": "bde3bab1fbdbcecdc891100",
        "schemaId": "6590a72d09f1760a4578032",
        "tool": "text",
        "title": "txt",
        "answer": "2",
        "metadata": {
          "createdAt": "2023-08-23T11:21:01.100Z",
          "createdBy": "lorenzo@imerit.net",
          "createdIn": "Label"
        },
        "classifications": []
      }
    ],
    "relations": [],
    "stageHistory": [
      {
        "stage": "Start",
        "stageId": "Start",
        "duration": 0,
        "completedAt": "2023-08-23T10:55:53.495Z",
        "tools": [],
        "classifications": [],
        "relations": []
      },
      {
        "stage": "Label",
        "stageId": "Label",
        "duration": 46753,
        "completedAt": "2023-08-23T11:21:04.393Z",
        "completedBy": "lorenzo@imerit.net",
        "tools": [
          {
            "bounding-box": {
              "x": 301.6699801192843,
              "y": 429.05027932960894,
              "height": 173.76536312849163,
              "width": 118.09145129224652
            },
            "objectId": "765742a3b676d3f26898792",
            "classifications": [],
            "schemaId": "b1c6805d054f0e44ae11500",
            "page": 504,
            "title": "bb"
          },
          {
            "polygon": [
              [
                593.6779324055666,
                1121.9664804469273
              ],
              [
                443.3797216699801,
                1349.36312849162
              ],
              [
                576.5009940357853,
                1375.1061452513966
              ]
            ],
            "objectId": "408deff4664cc342d236127",
            "classifications": [],
            "schemaId": "a966c7799383465850cd803",
            "page": 504,
            "title": "gon"
          },
          {
            "objectId": "765742a3b676d3f26898792",
            "schemaId": "b1c6805d054f0e44ae11500",
            "classifications": [],
            "bounding-box": {
              "x": 801.948310139165,
              "y": 1428.7374301675977,
              "height": 173.76536312849163,
              "width": 118.09145129224652
            },
            "page": 506,
            "title": "bb"
          },
          {
            "objectId": "408deff4664cc342d236127",
            "schemaId": "a966c7799383465850cd803",
            "classifications": [],
            "polygon": [
              [
                217.93240556660038,
                229.54189944134077
              ],
              [
                67.63419483101391,
                456.9385474860335
              ],
              [
                200.75546719681907,
                482.68156424581
              ]
            ],
            "page": 506,
            "title": "gon"
          }
        ],
        "classifications": [
          {
            "objectId": "3d5cd10ba190b29d2850724",
            "schemaId": "6421df1fa34ac13204ea157",
            "tool": "radio",
            "title": "rdo",
            "answer": "1",
            "classifications": []
          },
          {
            "objectId": "f4e53917c222c8e62dbb715",
            "schemaId": "1ea7a275ce5c9cf30a6f148",
            "tool": "checkbox",
            "title": "chk",
            "answer": [
              "1"
            ],
            "classifications": []
          },
          {
            "objectId": "0b057a52a2bb648b197f180",
            "schemaId": "a2b4a50bb90eb6523b88376",
            "tool": "single-dropdown",
            "title": "sdr",
            "answer": "1",
            "classifications": []
          },
          {
            "objectId": "19ae5491832a3bd42704684",
            "schemaId": "11f6ed8e4ac4852d3422341",
            "tool": "multi-dropdown",
            "title": "mdr",
            "answer": [
              "1"
            ],
            "classifications": []
          },
          {
            "objectId": "7ed41243066d9b09e652723",
            "schemaId": "c2b5eb27e55b186f84f3898",
            "tool": "tree-dropdown",
            "title": "tre",
            "answer": [
              "1",
              "1 / 2"
            ],
            "classifications": []
          },
          {
            "objectId": "bde3bab1fbdbcecdc891100",
            "schemaId": "6590a72d09f1760a4578032",
            "tool": "text",
            "title": "txt",
            "answer": "2",
            "classifications": []
          }
        ],
        "relations": []
      },
      {
        "stage": "Review",
        "stageId": "5e8f78a7-ef6a-473d-b02f-f4024c9ee486",
        "duration": 2843,
        "reviewStatus": "Accepted",
        "completedAt": "2023-08-23T11:36:38.074Z",
        "completedBy": "lorenzo@imerit.net",
        "tools": [
          {
            "bounding-box": {
              "x": 301.6699801192843,
              "y": 429.05027932960894,
              "height": 173.76536312849163,
              "width": 118.09145129224652
            },
            "objectId": "765742a3b676d3f26898792",
            "classifications": [],
            "schemaId": "b1c6805d054f0e44ae11500",
            "page": 504,
            "title": "bb"
          },
          {
            "polygon": [
              [
                593.6779324055666,
                1121.9664804469273
              ],
              [
                443.3797216699801,
                1349.36312849162
              ],
              [
                576.5009940357853,
                1375.1061452513966
              ]
            ],
            "objectId": "408deff4664cc342d236127",
            "classifications": [],
            "schemaId": "a966c7799383465850cd803",
            "page": 504,
            "title": "gon"
          },
          {
            "objectId": "765742a3b676d3f26898792",
            "schemaId": "b1c6805d054f0e44ae11500",
            "classifications": [],
            "bounding-box": {
              "x": 801.948310139165,
              "y": 1428.7374301675977,
              "height": 173.76536312849163,
              "width": 118.09145129224652
            },
            "page": 506,
            "title": "bb"
          },
          {
            "objectId": "408deff4664cc342d236127",
            "schemaId": "a966c7799383465850cd803",
            "classifications": [],
            "polygon": [
              [
                217.93240556660038,
                229.54189944134077
              ],
              [
                67.63419483101391,
                456.9385474860335
              ],
              [
                200.75546719681907,
                482.68156424581
              ]
            ],
            "page": 506,
            "title": "gon"
          }
        ],
        "classifications": [
          {
            "objectId": "3d5cd10ba190b29d2850724",
            "schemaId": "6421df1fa34ac13204ea157",
            "tool": "radio",
            "title": "rdo",
            "answer": "1",
            "classifications": []
          },
          {
            "objectId": "f4e53917c222c8e62dbb715",
            "schemaId": "1ea7a275ce5c9cf30a6f148",
            "tool": "checkbox",
            "title": "chk",
            "answer": [
              "1"
            ],
            "classifications": []
          },
          {
            "objectId": "0b057a52a2bb648b197f180",
            "schemaId": "a2b4a50bb90eb6523b88376",
            "tool": "single-dropdown",
            "title": "sdr",
            "answer": "1",
            "classifications": []
          },
          {
            "objectId": "19ae5491832a3bd42704684",
            "schemaId": "11f6ed8e4ac4852d3422341",
            "tool": "multi-dropdown",
            "title": "mdr",
            "answer": [
              "1"
            ],
            "classifications": []
          },
          {
            "objectId": "7ed41243066d9b09e652723",
            "schemaId": "c2b5eb27e55b186f84f3898",
            "tool": "tree-dropdown",
            "title": "tre",
            "answer": [
              "1",
              "1 / 2"
            ],
            "classifications": []
          },
          {
            "objectId": "bde3bab1fbdbcecdc891100",
            "schemaId": "6590a72d09f1760a4578032",
            "tool": "text",
            "title": "txt",
            "answer": "2",
            "classifications": []
          }
        ],
        "relations": []
      }
    ]
  }
}

Last updated