- 29 May 2024
- Print
- DarkLight
- PDF
Item JSON Format
- Updated On 29 May 2024
- Print
- DarkLight
- PDF
Item
An 'Item' is a Dataloop entity that represents the required data for annotation. It can consist of a single file or multiple files. For instance, a 'Video Item' comprises a sole video file, while a 'Lidar Item' includes multiple PCD frames stitched into one item, presenting them as a sequence. Each Dataloop Annotation Studio has its unique item structure.
Download an Item
A JSON structure represents the item. Refer to the Export selected/queried items section to learn about downloading the item JSON file.
JSON is a minimal text-based data exchange format that is used primarily to transmit data between a server and a web application. To understand more about JSON, go here.
Format Details
{
"id": "61d5eb9d14b5b8ea83e18037",
"datasetId": "61d5e83f5575066ffd58fcda",
"createdAt": "2022-01-05T19:03:57.000Z",
"dir": "/",
"filename": "/panda.jpg",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"originalname": "panda.jpg",
"size": 1681485,
"encoding": "7bit",
"mimetype": "image/jpeg",
"taskStatusLog": [
{
"status": {
"taskId": "61d5eb2f3e1b9e55742d498c",
"assignmentId": "61d5eb2f3e1b9eb7c22d498d",
"status": "completed",
"creator": "vakasix267@zoeyy.com",
"timestamp": "2022-01-05T19:09:21.823Z"
},
"action": "created"
},
{
"status": {
"taskId": "61d5eb2f3e1b9e55742d498c",
"assignmentId": "61d5eb2f3e1b9eb7c22d498d",
"status": "completed",
"creator": "vakasix267@zoeyy.com",
"timestamp": "2022-01-05T19:26:16.095Z"
},
"action": "deleted"
},
{
"status": {
"taskId": "61d5eb2f3e1b9e55742d498c",
"assignmentId": "61d5eb2f3e1b9eb7c22d498d",
"status": "completed",
"creator": "vakasix267@zoeyy.com",
"timestamp": "2022-01-05T19:31:38.290Z"
},
"action": "created"
}
],
"refs": [
{
"type": "pipelineExecution",
"id": "61d5eb9da833ff055cdb16e5",
"pipelineId": "61cdb7e058f16ab159713d38"
},
{
"type": "task",
"id": "61d5eb2f3e1b9e55742d498c",
"metadata": {
"creator": "vakasix267@zoeyy.com",
"status": "completed",
"timestamp": "2022-01-05T19:31:38.290Z"
}
},
{
"type": "assignment",
"id": "61d5eb2f3e1b9eb7c22d498d",
"metadata": {
"creator": "vakasix267@zoeyy.com",
"status": "completed",
"timestamp": "2022-01-05T19:31:38.290Z"
}
}
],
"isBinary": true,
"executionLogs": {
"image-preprocess": {
"default_module": {
"on_create": {
"61d5eb9da833ff954bdb16e4": {
"status": "success",
"progress": 100
}
}
}
},
"pipeline-utils": {
"default_module": {
"move_to_task": {
"61d5eb9da833ff1cabdb16fa": {
"status": "success",
"progress": 100
},
"61d5eb9da833ff1b1bdb16fb": {
"status": "success",
"progress": 100
},
"61d5eb9da833ff4278db1708": {
"status": "success",
"progress": 100
}
}
}
}
},
"channels": 3,
"exif": {},
"height": 3872,
"thumbnailAnnotationsId": "61d5eba014b5b85774e1803d",
"thumbnailId": "61d5eba014b5b89da1e1803a",
"width": 2592
}
},
"name": "panda.jpg",
"url": "https://rc-gate.dataloop.ai/api/v1/items/61d5eb9d14b5b8ea83e18037",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/61d5e83f5575066ffd58fcda",
"creator": "oren.a@dataloop.ai",
"annotationsCount": 1,
"annotated": true,
"stream": "https://rc-gate.dataloop.ai/api/v1/items/61d5eb9d14b5b8ea83e18037/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/61d5eb9d14b5b8ea83e18037/thumbnail",
"annotations": [. . .]
}
Dictionary Table
Key Name | Definition | Parent Key |
---|---|---|
id | Item/image ID | N/A |
datasetId | Dataset ID | N/A |
createdAt | Time and date the item/image was uploaded | N/A |
dir | Image location directory in dataset | N/A |
filename | Item/image full path | N/A |
type | Item type | N/A |
hidden | System property | N/A |
metadata | This key holds all the item's information | N/A |
system | This key holds all the item's system information | metadata |
originalname | Original item's name when created | system |
size | Image size in bytes | system |
encoding | encoding | system |
mimetype | Media type | system |
taskStatusLog | List of item statuses in given tasks | system |
status | Information about the status of the item in a given task | taskStatusLog |
taskId | Task id | status |
assignmentId | Assignment id | status |
status | The status of the item in this task | status |
creator | Creator of the status | status |
timestamp | When the task status was created | status |
action | The action (created/deleted) on the status of this item | taskStatusLog |
refs | Task assignment list reference | system |
type | task or assignment | refs |
id | ID of the task/assignment that the item is linked with | refs |
metadata | Information about the item in this task/assignment | refs |
creator | Username of the creator of the status of the item in this task/assignment | metadata |
status | Status of this item in this task/assignment – completed/discard/complete/custom status created by the task creator (this attribute will not show if no status has been created yet) | metadata |
timestamp | Date and time when the status was created | metadata |
isBinary | Is the item a binary file | system |
executionLogs | Information about executions the item went through | system |
image-preprocess | Information about preprocess the item went through (e.g., export metadata) | executionLogs |
default-module | Name of the module | image-preprocess |
on_create | Name of the function | default-module |
61d5eb9da833ff954bdb16e4 | Execution ID | on_create |
status | Execution progress | 61d5eb9da833ff954bdb16e4 |
progress | Execution status | 61d5eb9da833ff954bdb16e4 |
pipeline-utils | FaaS name (as seen in application hub library) | executionLogs |
default_module | App module name | pipeline-utils |
move_to_task | Function name | default_module |
61d5eb9da833ff1cabdb16fa | Execution of the move_to_task function | move_to_task |
status | The status of the execution | 61d5eb9da833ff1cabdb16fa |
progress | The progress of the execution | 61d5eb9da833ff1cabdb16fa |
channels | Image color dimensions (1 black and white; 3 color (rgb); 4 with transparency effect) | system |
exif | [exif](https://docs.dataloop.ai/docs/exif-orientation-value){target="_blank"} information | system |
height | Image resolution | system |
thumbnailAnnotationsId | Thumbnail Annotation id | system |
thumbnailId | Thumbnail id | system |
width | Image resolution | system |
name | Updated item name | N/A |
url | API URL for items | N/A |
dataset | API URL for dataset | N/A |
creator | Item creator | N/A |
annotationsCount | Number of annotations | N/A |
annotated | True shows that the item is annotated | N/A |
stream | API URL for stream | N/A |
thumbnail | API URL for thumbnail | N/A |
annotations | Information about annotations | N/A |