Video Annotation Output
This page describes Video JSON, a data format for describing Video data in JavaScript Object Notation (JSON). This JSON code includes the entity's data related to our software and its metadata.
The Video Annotation JSON file records KeyFrames and automated frames, not reflected frames. In other words, an annotation in a specific frame that has not changed since the previous frame is not recorded in the JSON file. If the annotation is not the same as in the previous frame (for example, due to change in position, label, attribute, etc.), the annotation is recorded in the JSON file.
- Read more about different types of frames at Understanding KeyFrames, Interpolation, and Tracking.
- To download the JSON file of an item’s annotations, see Export selected/queried items.
Important
DDOE recommends you read frame through the SDK, as it allows you to read annotations at any frame/point in time, even in reflected frames (which are not recorded in the JSON).
{
"annotations": [
{
// Item metadata (the video file being annotated)
"id": "67cf2185f561d468353ad582", // Unique ID of the video item
"datasetId": "67cf2015fcc9e5df26713ad5", // Dataset ID this item belongs to
"url": "https://gate.dataloop.ai/api/v1/items/67cf2185f561d468353ad582", // API URL to access this item
"dataset": "https://gate.dataloop.ai/api/v1/datasets/67cf2015fcc9e5df26713ad5", // API URL of the dataset
"createdAt": "2025-03-10T17:29:40.993Z", // Timestamp when item was created
"dir": "/", // Directory path in the dataset
"filename": "/video.webm", // Full filename with path
"type": "file", // Item type (file)
"hidden": false, // Visibility flag
"metadata": {
"fps": 59.94006309148265, // Frames per second
"startTime": 0, // Start time in seconds
"system": {
"duration": 13.514, // Video duration in seconds
"encoding": "7bit", // File encoding
"ffmpeg": {
// FFmpeg-extracted metadata about the video stream
"codec_name": "vp9", // Codec used
"coded_width": 768, // Width of video frames
"coded_height": 432, // Height of video frames
"pix_fmt": "yuv420p", // Pixel format
"r_frame_rate": "19001/317", // Raw frame rate ratio
"tags": {
"DURATION": "00:00:13.514000000", // Duration as string
"ENCODER": "Lavc60.31.102 libvpx-vp9" // Encoder used
}
},
"format": {
"bit_rate": "867322", // Bitrate in bits per second
"duration": "13.554000", // Format-level duration
"format_name": "matroska,webm", // File format
"size": "1469461" // File size in bytes
},
"mimetype": "video/webm", // MIME type
"originalname": "video.webm", // Original filename
"thumbnailId": "67cf2187c3d298a06ce46b4f", // ID of generated thumbnail
"width": 768, // Display width
"height": 432 // Display height
}
},
"name": "video.webm", // Display name
"creator": "user@dataloop.ai", // Item creator
"updatedAt": "2025-03-10T17:29:45.059Z", // Last update time
"updatedBy": "pipelines@dataloop.ai", // User or service that updated
"stream": "https://gate.dataloop.ai/api/v1/items/67cf2185f561d468353ad582/stream", // Video stream endpoint
"thumbnail": "https://gate.dataloop.ai/api/v1/items/67cf2185f561d468353ad582/thumbnail", // Thumbnail preview
"annotations": [
{
// Annotation 1: Polygonal segment (used for shape tracking or segmentation)
"id": "67cf21eb47ee89b8f70be123",
"type": "segment", // Type: segmented polygon
"label": "Male", // Assigned label/class
"coordinates": [
[ { "x": ..., "y": ... }, ... ] // List of polygon vertices (single frame)
],
"metadata": {
"system": {
"frame": 0, // Starting frame
"endFrame": 809, // Ending frame
"startTime": 0, // Start time in seconds
"endTime": 13.50932845639703, // End time in seconds
"automated": false, // Not generated automatically
"coordinateVersion": "v1", // Annotation version format
"recipeId": "67cf2016930b028030d4b87c" // Labeling recipe ID
}
},
"creator": "user@dataloop.ai", // Who created this annotation
"createdAt": "2025-03-10T17:31:23.476Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T17:31:23.476Z",
"source": "ui" // Annotation made via user interface
},
{
// Annotation 2: Bounding box annotation
"id": "67cf21eb47ee89ee610be122",
"type": "box", // Type: bounding box
"label": "Male",
"coordinates": [
{ "x": 124.61, "y": 23.31, "z": 0 }, // Top-left corner
{ "x": 430.64, "y": 429.06, "z": 0 } // Bottom-right corner
],
"metadata": {
"system": {
"frame": 0,
"endFrame": 809,
"startTime": 0,
"endTime": 13.50932845639703,
"automated": false,
"coordinateVersion": "v2",
"recipeId": "67cf2016930b028030d4b87c"
}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T17:31:23.476Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T17:31:23.476Z",
"source": "ui"
}
],
"annotationsCount": 2, // Total number of annotations on the video
"annotated": true // Flag indicating item has been annotated
}
]
}
📌 Key Video-Specific Highlights
- Segment annotations (
type: "segment") use polygon points per frame to outline objects. - Box annotations (
type: "box") define regions using two corner points. - Temporal metadata like
startTime,endTime,frame, andendFrameis critical for video. fpsanddurationhelp sync annotation timing with video playback.- Annotations can span the entire video or specific frame ranges.
RLHF Annotation Output
This page describes RLHF JSON, a data format for describing RLHF data in JavaScript Object Notation (JSON). For more information on RLHF Studio, see the RLHF Studio.
File or Prompt Layer Format
The following format is a data structure example of a file that contains two prompts. The first prompt contains text and an image, and the second prompt contains text only.
{
// Shebang indicates the Dataloop schema or format identifier
"shebang": "dataloop",
"metadata": {
// 'dltype' declares this file contains prompt-style annotations
"dltype": "prompt"
},
"prompts": {
// Each key (e.g., 'prompt1', 'prompt2') represents a separate prompt sample
"prompt1": [
{
// The first element of the prompt: a natural language question
"mimetype": "application/text", // Indicates this is plain text
"value": "What animal is in this image?" // Human-readable prompt question
},
{
// The second element of the prompt: a linked image input
"mimetype": "image/jpeg", // MIME type indicating image format
"value": "https://gate.dataloop.ai/api/v1/items/6489600c8d5a1c350e55116a/stream"
// URL to stream the image (i.e., input data for the prompt)
}
],
"prompt2": [
{
// Another prompt that only contains a text question without an image
"mimetype": "application/text",
"value": "What is the eye color of this cat?"
// This could potentially be followed by an image or another data type in full usage
}
]
}
}
📌 Explanation
- This structure is used for multi-modal prompts in RLHF workflows, especially combining
text + images. - Each prompt consists of one or more data components, each defined by its
mimetypeandvalue. - This flexible format allows extending prompts with additional media types (e.g., audio, video).
Annotations or Response Layer Format
Data structure of a response.
{
// Metadata about the annotated file (e.g., the JSON prompt file)
"id": "64899218661aa36a1744112c", // Unique ID of the item
"datasetId": "64885c4d71e85c4f03c3758c", // ID of the dataset to which this item belongs
"url": "https://rc-gate.dataloop.ai/api/v1/items/64899218661aa36a1744112c", // API endpoint to access the item
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/64885c4d71e85c4f03c3758c", // API endpoint for the dataset
"createdAt": "2023-06-14T10:10:32.863Z", // Timestamp when the item was created
"dir": "/image_prompts", // Directory path in the dataset
"filename": "/image_prompts/flyingdog.json", // Full path and filename
"type": "file", // File type (in this case, a JSON file)
"hidden": false, // Visibility flag
"metadata": {
"system": {
"encoding": "7bit", // File encoding type
"isBinary": false, // Indicates the file is not binary
"mimetype": "application/json", // MIME type of the file
"originalname": "flyingdog.json", // Original name at upload
"refs": [], // Reference links to other items (if any)
"shebang": {
"dltype": "prompt" // Declares this is a prompt-type data item
},
"size": 161, // Size of the file in bytes
"taskStatusLog": [] // Log of tasks run on the item (empty here)
}
},
"name": "flyingdog.json", // Display name of the item
"creator": "user@dataloop.ai", // Creator of the file
"stream": "https://rc-gate.dataloop.ai/api/v1/items/64899218661aa36a1744112c/stream", // File stream endpoint
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/64899218661aa36a1744112c/thumbnail", // Thumbnail preview URL
// The list of annotations associated with the item
"annotations": [
{
"id": "64899219bf9b191be0acdd2c", // Unique annotation ID
"datasetId": "64885c4d71e85c4f03c3758c", // Same dataset as parent item
"itemId": "64899218661aa36a1744112c", // ID of the item being annotated
"url": "https://rc-gate.dataloop.ai/api/v1/annotations/64899219bf9b191be0acdd2c", // API URL to the annotation
"item": "https://rc-gate.dataloop.ai/api/v1/items/64899218661aa36a1744112c", // Redundant link to item
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/64885c4d71e85c4f03c3758c", // Redundant link to dataset
"type": "binary", // Annotation type: binary classification (used for response scoring, e.g., "yes/no", "good/bad")
"label": "q", // Label or identifier for this response (e.g., "question", "response A")
"coordinates": "https://rc-gate.dataloop.ai/api/v1/items/648992159b8b5e823eda9972/stream",
// The response or output value (in this case, another item—possibly a model's generated response)
"metadata": {
"system": {
"automated": true, // Indicates this was generated by a model
"promptId": "first" // ID linking back to the original prompt in the file
},
"user": {
"annotation_type": "prediction", // Annotation represents a model prediction
"model": {
"confidence": 0.9, // Confidence score of the prediction
"name": "model1" // Name of the model that generated the prediction
},
"stream": true // Indicates this annotation links to a streamed item (likely the generated output)
}
},
"creator": "user@dataloop.ai", // Who created or triggered this annotation
"createdAt": "2023-06-14T10:10:33.092Z", // Creation time
"updatedBy": "user@dataloop.ai", // Last user who updated the annotation
"updatedAt": "2023-06-14T10:10:33.092Z", // Last update time
"hash": "64885c4d71e85c4f03c3758c_64899218661aa36a1744112c_q_lior@dataloop.ai", // Internal hash ID for annotation tracking
"source": "sdk" // Annotation was generated via SDK/API (vs. UI/manual)
}
],
"annotationsCount": 1, // Total number of annotations for this item
"annotated": true // Indicates that the item has at least one annotation
}
📌 Explanation
- This format is used to record model responses, human judgments, or comparative feedback.
- The coordinates field in this case holds a link to the output, not geometric data.
- Annotations include labels and confidence scores, often tied to a specific promptId.
- Suitable for use cases like ranking, binary classification, or scored feedback in RLHF pipelines.
PDF Annotation Output
This page describes PDF annotation JSON, a data format for describing PDF data in JavaScript Object Notation (JSON). This JSON code includes the entity's data related to our software and its metadata.
{
"annotations": [
{
"id": "6763e0935c8f7b03c0b14bf9",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"url": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"createdAt": "2024-12-19T09:00:03.273Z",
"dir": "/",
"filename": "/PDF Annotations.pdf",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"encoding": "7bit",
"isBinary": true,
"mimetype": "application/pdf",
"originalname": "PDF Annotations.pdf",
"refs": [
{
"id": "67b5b7f0a6f018425f8403cd",
"type": "assignment"
},
{
"id": "67b5b7f0a6f018d9ef8403cb",
"type": "task"
}
],
"size": 18020,
"taskStatusLog": []
}
},
"name": "PDF Annotations.pdf",
"creator": "user@gmail.com",
"updatedAt": "2024-12-19T09:00:03.371Z",
"updatedBy": "user@gmail.com",
"stream": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9/stream",
"thumbnail": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9/thumbnail",
"annotations": [
{
"id": "67cf29bc47ee8930050bed2f",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"itemId": "6763e0935c8f7b03c0b14bf9",
"url": "https://gate.dataloop.ai/api/v1/annotations/67cf29bc47ee8930050bed2f",
"item": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"type": "text_mark",
"label": "sentence-2",
"attributes": [],
"coordinates": "featuresofPDFdocumentsistheAnnotations—anumbrellatermthatcoversavarietyofinteractiveobjectsthatcanbeplacedontopofthePDFcontent.",
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "9cd27efb-8062-407f-891f-59b9c1d09053",
"endFrame": 1,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "1",
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "6569aa2b27d7bdd0605b8fc9",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {
"highlight": {
"comment": {
"text": ""
},
"content": {
"text": "featuresofPDFdocumentsistheAnnotations—anumbrellatermthatcoversavarietyofinteractiveobjectsthatcanbeplacedontopofthePDFcontent."
},
"id": "sentence-2",
"position": {
"boundingRect": {
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 688.3746185302734,
"y1": 240.00869750976562,
"y2": 277.8211975097656
},
"pageNumber": 1,
"rects": [
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 688.3746185302734,
"y1": 240.00869750976562,
"y2": 257.2309265136719
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 521.1130218505859,
"y1": 260.5989685058594,
"y2": 277.8211975097656
}
]
}
},
"refs": [
{
"entity": "item",
"ref": "6763e0935c8f7b03c0b14bf9",
"refBy": "id",
"rel": "child"
}
]
}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T18:04:44.123Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T18:04:44.123Z",
"hash": "4e65f74b6295fe695953f47a677c355d3c4cf5cc",
"source": "ui",
"description": "featuresofPDFdocumentsistheAnnotations—anumbrellatermthatcoversavarietyofinteractiveobjectsthatcanbeplacedontopofthePDFcontent."
},
{
"id": "67cf29bc47ee8941790bed30",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"itemId": "6763e0935c8f7b03c0b14bf9",
"url": "https://gate.dataloop.ai/api/v1/annotations/67cf29bc47ee8941790bed30",
"item": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"type": "text_mark",
"label": "paragraph-1",
"attributes": [],
"coordinates": "Intherealworld,theuseofPDFannotationsisvaried.Educatorsoftenusethemtoprovidefeedbackonstudents’work.Inbusiness,theyfacilitatecollaborativedocumentreview,enablingteammemberstoaddcomments,suggestions,orapprovals.Legalprofessionalsuseannotationstoreference",
"metadata": {
"system": {
"attributes": {
"1": "Yes"
},
"automated": false,
"clientId": "3cfb7221-2e7e-4e9b-b697-63c33e4d9192",
"endFrame": 1,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "2",
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "6569aa2b27d7bdd0605b8fc9",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {
"highlight": {
"comment": {
"text": ""
},
"content": {
"text": "Intherealworld,theuseofPDFannotationsisvaried.Educatorsoftenusethemtoprovidefeedbackonstudents’work.Inbusiness,theyfacilitatecollaborativedocumentreview,enablingteammemberstoaddcomments,suggestions,orapprovals.Legalprofessionalsuseannotationstoreference"
},
"id": "paragraph-1",
"position": {
"boundingRect": {
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 726.2897186279297,
"y1": 450.34722900390625,
"y2": 529.34033203125
},
"pageNumber": 1,
"rects": [
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 695.8234710693359,
"y1": 450.34722900390625,
"y2": 467.5694580078125
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 726.2897186279297,
"y1": 470.9375305175781,
"y2": 488.1597595214844
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 659.4998016357422,
"y1": 491.5278015136719,
"y2": 508.7500305175781
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 259.66651916503906,
"y1": 512.1181030273438,
"y2": 529.34033203125
}
]
}
},
"refs": [
{
"entity": "item",
"ref": "6763e0935c8f7b03c0b14bf9",
"refBy": "id",
"rel": "child"
}
]
}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T18:04:44.123Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T18:04:44.123Z",
"hash": "19962b7b2750ecb30a279fb0bee82d461fd37d36",
"source": "ui",
"description": "Intherealworld,theuseofPDFannotationsisvaried.Educatorsoftenusethemtoprovidefeedbackonstudents’work.Inbusiness,theyfacilitatecollaborativedocumentreview,enablingteammemberstoaddcomments,suggestions,orapprovals.Legalprofessionalsuseannotationstoreference"
}
],
"annotationsCount": 2,
"annotated": true
}
]
}
LiDAR Annotation Output
This page describes LiDAR JSON, a data format for describing LiDAR data in JavaScript Object Notation (JSON). DDOE's LiDAR application supports 3D cubes. Since DDOE's platform supports LiDAR sequence files, the JSON file contains information about the frames, the start time, and the end time. Learn more about LiDAR Annotation Studio.
JSON Format
{
"id": "656d78cc97c4a3bd5a863b6b",
"datasetId": "6458d7e0a4aaff79f2f8e16f",
"url": "https://rc-gate.dataloop.ai/api/v1/items/656d78cc97c4a3bd5a863b6b",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6458d7e0a4aaff79f2f8e16f",
"createdAt": "2023-12-17T16:23:14.232Z",
"dir": "/",
"filename": "/name.json",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"encoding": "7bit",
"isBinary": false,
"mimetype": "application/json",
"modalities": [],
"originalname": "frames (69).json",
"refs": [
{
"id": "660d6132ee9acf5df05460c3",
"type": "task"
},
{
"id": "660d6135ee9acf25955460c5",
"type": "assignment"
}
],
"shebang": {
"dltype": "PCDFrames"
},
"size": 499149,
"tags": {
"validation": true
},
"taskStatusLog": []
}
},
"name": "name.json",
"creator": "name@dataloop.ai",
"updatedAt": "2023-12-17T16:23:14.275Z",
"updatedBy": "name@dataloop.ai",
"stream": "https://rc-gate.dataloop.ai/api/v1/items/656d78cc97c4a3bd5a863b6b/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/656d78cc97c4a3bd5a863b6b/thumbnail",
"annotations": [
{
"id": "6628d0a3d079e474881f026c",
"datasetId": "6458d7e0a4aaff79f2f8e16f",
"itemId": "656d78cc97c4a3bd5a863b6b",
"url": "https://rc-gate.dataloop.ai/api/v1/annotations/6628d0a3d079e474881f026c",
"item": "https://rc-gate.dataloop.ai/api/v1/items/656d78cc97c4a3bd5a863b6b",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6458d7e0a4aaff79f2f8e16f",
"type": "ref_semantic_3d",
"label": "A",
"attributes": [],
"coordinates": {
"interpolation": "none",
"mode": "overwrite",
"ref": "6628d13df44c9ef04c78d6ba",
"refType": "id"
},
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "35f92656-7d25-4318-8c0b-888fe093a5f0",
"coordinateVersion": "v1",
"endFrame": 80,
"endTime": 80,
"frame": 2,
"frameNumberBased": true,
"isOnlyLocal": false,
"isOpen": false,
"itemLinks": [],
"objectId": "1",
"openAnnotationVersion": "1.75.2-rc.38",
"recipeId": "6614ee52201e826524c523f0",
"snapshots_": [
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 3,
"label": "A",
"namedAttributes": {},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 5,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 6,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 7,
"label": "A",
"namedAttributes": {},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 8,
"label": "A",
"namedAttributes": {},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 9,
"label": "A",
"namedAttributes": {},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 10,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 11,
"label": "A",
"namedAttributes": {},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 13,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 14,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 15,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 18,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
},
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 19,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
}
],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "name@dataloop.ai",
"createdAt": "2024-04-24T09:28:03.595Z",
"updatedBy": "name@dataloop.ai",
"updatedAt": "2024-04-24T09:31:30.792Z",
"hash": "2d6705cea186f7c7be259cd517d95ea613b4faa8",
"source": "ui"
},
{
"id": "6628d173d079e4563d1f03d7",
"datasetId": "6458d7e0a4aaff79f2f8e16f",
"itemId": "656d78cc97c4a3bd5a863b6b",
"url": "https://rc-gate.dataloop.ai/api/v1/annotations/6628d173d079e4563d1f03d7",
"item": "https://rc-gate.dataloop.ai/api/v1/items/656d78cc97c4a3bd5a863b6b",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6458d7e0a4aaff79f2f8e16f",
"type": "ref_semantic_3d",
"label": "A",
"attributes": [],
"coordinates": {
"interpolation": "none",
"mode": "overwrite",
"ref": "6628d21073ec48d85203e026",
"refType": "id"
},
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "3c00cf62-4ed7-4b08-a946-d23ae36aa62d",
"coordinateVersion": "v1",
"endFrame": 80,
"endTime": 80,
"frame": 18,
"frameNumberBased": true,
"isOnlyLocal": false,
"isOpen": false,
"itemLinks": [],
"objectId": "2",
"openAnnotationVersion": "1.75.2-rc.38",
"recipeId": "6614ee52201e826524c523f0",
"snapshots_": [
{
"attributes": [],
"data": {},
"fixed": true,
"frame": 19,
"label": "A",
"namedAttributes": {
"undefined": null
},
"objectVisible": true,
"type": "ATTRIBUTE_CHANGE"
}
],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "name@dataloop.ai",
"createdAt": "2024-04-24T09:31:31.486Z",
"updatedBy": "name@dataloop.ai",
"updatedAt": "2024-04-24T09:36:54.282Z",
"hash": "eb18f38c53a937d871e288ba2ce805ad2abcb8af",
"source": "ui"
},
{
"id": "6628d2b6403d677a59cbdf91",
"datasetId": "6458d7e0a4aaff79f2f8e16f",
"itemId": "656d78cc97c4a3bd5a863b6b",
"url": "https://rc-gate.dataloop.ai/api/v1/annotations/6628d2b6403d677a59cbdf91",
"item": "https://rc-gate.dataloop.ai/api/v1/items/656d78cc97c4a3bd5a863b6b",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6458d7e0a4aaff79f2f8e16f",
"type": "cube_3d",
"label": "A",
"attributes": [],
"coordinates": {
"direction": {
"x": 1,
"y": 0,
"z": 0
},
"interpolation": "Linear",
"position": {
"x": -5.910163478003942,
"y": 17.759926650242885,
"z": 2.0968759090718523
},
"rotation": {
"x": 0,
"y": 0,
"z": 0
},
"scale": {
"x": 2.8938979884031664,
"y": 1.949486176458691,
"z": 1
}
},
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "e12714d7-b7a7-4847-8c7c-76443ba46984",
"endFrame": 80,
"endTime": 80,
"frame": 19,
"frameNumberBased": true,
"itemLinks": [],
"objectId": "3",
"openAnnotationVersion": "1.75.2-rc.38",
"recipeId": "6614ee52201e826524c523f0",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "name@dataloop.ai",
"createdAt": "2024-04-24T09:36:54.693Z",
"updatedBy": "name@dataloop.ai",
"updatedAt": "2024-04-24T09:36:54.693Z",
"hash": "c2cdf1f722d6aa5cdc652ce0e1bc69a3058ea481",
"source": "ui"
}
],
"annotationsCount": 3,
"annotated": true,
"srcItem": "651d221f250b324a6d215941",
"srcDataset": "6458d7e0a4aaff79f2f8e16f"
}
Instance Segentation Formatting
The instance Segmentation tool segments point clouds.
On the exported JSON format, the indices- the segmented point clouds will diplay below "semanticIndex".
"semanticIndex": {
"type": "index",
"frames": {
"0": [
22,
23,
24,
28,
29
]}
Exporting Instance Segmentation
Please be aware that exporting semantic annotations for LiDAR data can only be performed one file at a time. This is due to the large size of the exported files, which can contain millions of indexed point clouds.
Field Definitions
| Key Name | Definition | Parent Key |
|---|---|---|
| id | Annotation Id | annotations |
| datasetId | Dataset Id | annotations |
| itemId | Id of the item | annotations |
| url | API URL of the annotation | annotations |
| item | API URL of the item | annotations |
| dataset | API URL of the dataset | annotations |
| type | Annotation type | annotations |
| label | Annotation label | annotations |
| attributes | Annotation attributes | annotations |
| metadata | Information about the annotation | annotations |
| system | Annotation system information | metadata |
| status | Annotation status (for example, null/issue/review) | system |
| startTime | Start time of the annotation in the video | system |
| endTime | End time of the annotation in the video | system |
| frame | Frame when the annotation appears in the video | system |
| endFrame | Last frame the annotation appears in the video | system |
| snapshots_ | Snapshot information relevant to video annotation | system |
| fixed | Shows if the frame is a fixed frame | snapshots_ |
| frame | Snapshot frame number | snapshots_ |
| objectVisible | Status of annotation (true = visible, false = hidden) | snapshots_ |
| data | Coordination in each snapshot | snapshots_ |
| position | Index of the center of the 3D cube in relation with the center of the world (0,0,0) | Coordinates (3D Cube |
| rotation | Rotation on each one of the axis: Top view rotation: rotation on the Z axis (Yaw), Front view rotation: rotation on the Y axis (Pitch), Side view rotation: rotation on the X axis (Roll). | Coordinates (3D Cube) |
| scale | Scale of the cube on each one of the axis. | Coordinates (3D Cube) |
| label | Snapshot label | snapshots_ |
| attributes | Snapshots attributes | snapshots_ |
| namedAttributes | The attributes that appear on all annotations | snapshots_ |
| parentId | Id of parent annotation | system |
| clientId | Annotation created in UI (clientId when not saved) | system |
| automated | True = Annotation created by automation process | system |
| objectId | Sequential mark for annotations | system |
| attributes | Information about the annotation attributes | system |
| system | Shows if annotation is a system annotation | system |
| itemLinks | ItemLinks are the connection between ‘snapshot’ annotation (like snapping a frame from a video) to the newly created image item | system |
| openAnnotationVersion | Platform version | system |
| recipeId | Id of the recipe | system |
| user | Metadata added by user via SDK | metadata |
| creator | User who created the annotation | annotations |
| createdAt | Date and time when annotation was created | annotations |
| updatedBy | User who updated the annotation | annotations |
| updatedAt | Date and time when annotation was last updated | annotations |
| hash | Used to map annotation’s data to a string | annotations |
| source | Where the annotation was created: UI/SDK | annotations |
| coordinates (3D Cube) | Object of includes 3D cube data | annotations |
| interpolation | this indicates an interpolation was done. | annotations |
| ref | It displays the reference task ID of the tasks this file was annotated through. | annotations |
| mode | Whether it is an overwrite mode or not. | annotations |
| refType | The type of the reference is an ID. | annotations |
| _id | The item ID | annotations |
| filename | Name of the file | annotations |
| mimetype | The mime type of the file | annotations |
| refs | The references of the task | annotations |
| shebang dltype | It allows UI to present the annotation as LiDAR instead of a JSON type. | annotations |
| size | File size | annotations |
| taskStatusLog | Logs from the task. | annotations |
Text Annotation Input
This page outlines the JSON format used for both input and output in the Text Classification Studio. It defines how NLP (Natural Language Processing) data is structured using JavaScript Object Notation (JSON). The format includes the entity's content along with its associated metadata, making it compatible with DDOE's platform.
Read here about the NLP Annotation Studio.
JSON format
{
"shebang": "dataloop", // Indicates the data is intended for Dataloop platform
"metadata": {
"dltype": "text-classification", // Type of task: text classification
"callId": "3154919731610621952", // Unique call identifier
"companyId": "262834820328732" // Company/project ID within the platform
},
"formatting": "html", // Specifies that the content is HTML-formatted
"elements": [
{
"key": "task-a", // Unique ID for this content block
"annotatable": true, // Set to true so annotators can label this
"content": "<p><strong>[A_17]</strong> Hello, this is XYZ from ABC.<br><br><strong>[T_1881]</strong> Everything went well during the call.<br><br><strong>[SELLER_1017]</strong> Yes, I think we're focused on the right approach.<br><br><strong>[PROSPECT_1881]</strong> I’ll definitely follow up on that.</p>" // HTML content for annotation
},
{
"key": "text-b", // Contextual or reference text
"annotatable": false, // Not for annotation
"content": "<p>Intent: not_decision_maker<br>Does the customer indicate that they are not the decision-maker?<br><br><br><br> <a href=\"https://gong.app.gong.io/call?id=3154919731610621952&highlights=%5B%7B%22type%22%3A%22SHARE%22%2C%22from%22%3A48%2C%22to%22%3A78%7D%5D\">URL to Call 3154919731610621952</a></p>" // Instruction and external reference
},
{
"key": "task-c",
"annotatable": true,
"content": "<p><strong>Hello</strong>, this is XYZ from ABC. Everything went well during the call.</p>"
},
{
"key": "text-d",
"annotatable": false,
"content": "<p>Your html texts</p>"
},
{
"key": "text-e",
"annotatable": false,
"content": "<p>Your html texts</p>"
},
{
"key": "task-e",
"annotatable": true,
"content": "<p>Your html texts</p>"
},
{
"key": "task-g",
"annotatable": true,
"content": "<p>Your html texts</p>"
}
]
}
Text Annotation Outpt
This page outlines the JSON format used for both input and output in the Text Classification Studio. It defines how NLP (Natural Language Processing) data is structured using JavaScript Object Notation (JSON). The format includes the entity's content along with its associated metadata, making it compatible with DDOE's platform.
Read here about the NLP Annotation Studio.
JSON format
{
"annotations": [
{
"id": "6569a9bb64a270e5cc8ae821",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"url": "https://gate.dataloop.ai/api/v1/items/6569a9bb64a270e5cc8ae821",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"createdAt": "2023-12-01T09:39:07.264Z",
"dir": "/",
"filename": "/Architecture.txt",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"encoding": "7bit",
"isBinary": false,
"mimetype": "text/plain",
"originalname": "Architecture.txt",
"refs": [
{
"id": "65941368b9bcb6a3fb4a598d",
"type": "task"
},
{
"id": "65941368b9bcb6ff2b4a598f",
"type": "assignment"
},
{
"id": "67b5b294dcaf2107243df699",
"type": "assignment"
},
{
"id": "67b5b294dcaf213f133df697",
"type": "task"
}
],
"size": 465,
"taskStatusLog": []
}
},
"name": "Architecture.txt",
"creator": "user@dataloop.ai",
"updatedAt": "2023-12-01T09:39:07.304Z",
"updatedBy": "user@dataloop.ai",
"stream": "https://gate.dataloop.ai/api/v1/items/6569a9bb64a270e5cc8ae821/stream",
"thumbnail": "https://gate.dataloop.ai/api/v1/items/6569a9bb64a270e5cc8ae821/thumbnail",
"annotations": [
{
"id": "67b5b27511348cc12361627e",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"itemId": "6569a9bb64a270e5cc8ae821",
"url": "https://gate.dataloop.ai/api/v1/annotations/67b5b27511348cc12361627e",
"item": "https://gate.dataloop.ai/api/v1/items/6569a9bb64a270e5cc8ae821",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"type": "text_mark",
"label": "sentence-2",
"attributes": [],
"coordinates": {
"end": 465,
"label": "sentence-2",
"start": 282,
"type": "block"
},
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "9df88b6b-44f5-4946-a6e8-ce32e2a8553b",
"endFrame": 1,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "4",
"openAnnotationVersion": "1.90.2-prod.0",
"recipeId": "6569aa2b27d7bdd0605b8fc9",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "user@gmail.com",
"createdAt": "2025-02-19T10:29:09.919Z",
"updatedBy": "user@gmail.com",
"updatedAt": "2025-02-19T10:29:09.919Z",
"hash": "83855a80fca7f5ef19fc57f67fcafe7af1fbd666",
"source": "ui"
}
],
"annotationsCount": 1,
"annotated": true
}
]
}
Field Definitions
| Key Name | Definition | Parent Key |
|---|---|---|
| id | Unique identifier for the item | Root |
| datasetId | Identifier for the dataset containing the item | Root |
| url | API URL to access the item | Root |
| dataset | API URL to access the dataset | Root |
| createdAt | Timestamp of when the item was created | Root |
| dir | Directory path of the item | Root |
| filename | File name of the item | Root |
| type | Type of the item (e.g., file) | Root |
| hidden | Boolean indicating if the item is hidden | Root |
| metadata | Metadata associated with the item | Root |
| system | System-related metadata | metadata |
| encoding | Encoding format of the file | system |
| isBinary | Boolean indicating if the file is binary | system |
| mimetype | MIME type of the file | system |
| originalname | Original name of the file | system |
| refs | List of references related to the file | system |
| id | Identifier of the reference | refs |
| type | Type of reference (e.g., task, assignment) | refs |
| size | Size of the file in bytes | system |
| taskStatusLog | Log of task statuses related to the item | system |
| name | Name of the item | Root |
| creator | Email of the user who created the item | Root |
| updatedAt | Timestamp of the last update | Root |
| updatedBy | Email of the user who updated the item | Root |
| stream | API URL to stream the item | Root |
| thumbnail | API URL to access the thumbnail | Root |
| annotations | List of annotations associated with the item | Root |
| id | Unique identifier for the annotation | annotations |
| datasetId | Identifier of the dataset associated with the annotation | annotations |
| itemId | Identifier of the item being annotated | annotations |
| url | API URL to access the annotation | annotations |
| item | API URL to access the annotated item | annotations |
| dataset | API URL to access the dataset of the annotation | annotations |
| type | Type of annotation (e.g., text_mark) | annotations |
| label | Label assigned to the annotation | annotations |
| attributes | List of attributes assigned to the annotation | annotations |
| coordinates | Coordinates of the text annotation | annotations |
| end | Ending position of the annotation in text | coordinates |
| label | Label associated with the annotation block | coordinates |
| start | Starting position of the annotation in text | coordinates |
| type | Type of annotation block | coordinates |
| metadata | Metadata related to the annotation | annotations |
| system | System metadata for annotation | metadata |
| attributes | Additional system attributes | system |
| automated | Boolean indicating if annotation was automated | system |
| clientId | Client ID associated with annotation | system |
| endFrame | End frame of the annotation | system |
| endTime | End time of the annotation | system |
| frame | Frame index of the annotation | system |
| itemLinks | Links to related annotation items | system |
| objectId | Object ID associated with the annotation | system |
| openAnnotationVersion | Version of annotation system | system |
| recipeId | Recipe identifier for annotation | system |
| snapshots_ | Snapshots related to the annotation | system |
| startTime | Start time of the annotation | system |
| system | Boolean indicating if annotation is system-generated | system |
| user | User-related metadata | metadata |
| creator | Email of the user who created the annotation | annotations |
| createdAt | Timestamp when annotation was created | annotations |
| updatedBy | Email of the user who updated the annotation | annotations |
| updatedAt | Timestamp when annotation was last updated | annotations |
| hash | Unique hash identifier for annotation | annotations |
| source | Source of the annotation (e.g., UI) | annotations |
| annotationsCount | Total count of annotations for the item | Root |
| annotated | Boolean indicating if the item has annotations | Root |
Audio Annotation Output
DDOE's Audio transcription studio allows creating and editing audio transcription. The annotations JSON format is similar to Video annotation, where annotations also span across time, but simpler, since there are no annotation coordinates.
{
"annotations": [ // Top-level list of annotated items
{
"id": "67ac977faeb79b24172c7457", // Unique ID of the item
"datasetId": "64b4d464bdf1fccfe1ba5790", // ID of the dataset the item belongs to
"url": "https://gate.dataloop.ai/api/v1/items/67ac977faeb79b24172c7457", // API URL to access the item
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790", // API URL to access the dataset
"createdAt": "2025-02-12T12:43:43.549Z", // Timestamp of item creation
"dir": "/", // Directory path in the dataset
"filename": "/file_example_MP3_1MG.mp3", // Filename including path
"type": "file", // Type of item (e.g., file, folder)
"hidden": false, // Indicates if the item is hidden
"metadata": {
"system": {
"encoding": "7bit", // Encoding type of the file
"isBinary": true, // Indicates if the file is binary
"mimetype": "audio/mpeg", // MIME type of the file
"originalname": "file_example_MP3_1MG.mp3", // Original name of the file
"refs": [], // Placeholder for external references
"size": 1059386, // File size in bytes
"taskStatusLog": [] // Logs related to task processing (if any)
}
},
"name": "file_example_MP3_1MG.mp3", // Display name of the item
"creator": "user@gmail.com", // Email of the user who created the item
"updatedAt": "2025-02-12T12:43:43.642Z", // Timestamp of last update
"updatedBy": "user@gmail.com", // Email of the user who last updated it
"stream": "https://gate.dataloop.ai/api/v1/items/67ac977faeb79b24172c7457/stream", // Streaming endpoint for audio/video
"thumbnail": "https://gate.dataloop.ai/api/v1/items/67ac977faeb79b24172c7457/thumbnail", // Thumbnail preview URL
"annotations": [ // List of annotations on this item
{
"id": "67cee4399b0de1e2d0d6ec3b", // Annotation ID
"datasetId": "64b4d464bdf1fccfe1ba5790", // ID of the dataset the annotation belongs to
"itemId": "67ac977faeb79b24172c7457", // ID of the item this annotation is attached to
"url": "https://gate.dataloop.ai/api/v1/annotations/67cee4399b0de1e2d0d6ec3b", // API URL for the annotation
"item": "https://gate.dataloop.ai/api/v1/items/67ac977faeb79b24172c7457", // Redundant reference to item URL
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790", // Redundant reference to dataset URL
"type": "subtitle", // Type of annotation (e.g., box, polygon, subtitle)
"label": "sentence-1", // Annotation label
"attributes": [], // Additional label attributes
"coordinates": {
"text": "Hello! How is the weather?" // Text content of the subtitle annotation
},
"metadata": {
"system": {
"attributes": {
"1": "Yes" // Custom attribute assigned to object ID "1"
},
"automated": false, // Whether the annotation was generated by automation
"clientId": "4f21b93a-7be8-469c-9294-672d0da6057c", // Internal client tracking ID
"endFrame": 1, // End frame (if part of a video)
"endTime": 11.466, // End time in seconds
"frame": 0, // Starting frame
"isOnlyLocal": false, // Indicates if annotation exists only locally
"isOpen": false, // Indicates if annotation is currently being edited
"itemLinks": [], // Related item references (if any)
"objectId": "1", // ID of the annotated object
"openAnnotationVersion": "1.91.1-prod.3", // Dataloop platform version used for annotation
"recipeId": "6569aa2b27d7bdd0605b8fc9", // ID of the recipe used for labeling
"snapshots_": [], // Annotation snapshots/history
"startTime": 4.224, // Start time in seconds
"system": false // Whether it's a system-generated annotation
},
"user": {} // Placeholder for user metadata
},
"creator": "user1@dataloop.ai", // Creator of the annotation
"createdAt": "2025-03-10T13:08:09.935Z", // Timestamp of annotation creation
"updatedBy": "user1@dataloop.ai", // Last editor of the annotation
"updatedAt": "2025-03-10T13:11:47.479Z", // Timestamp of last update
"hash": "f980c431726214904340fcb3378c1f396c11cacd", // Content hash for versioning/checksum
"source": "ui" // Source of annotation creation (e.g., UI, automation)
}
],
"annotationsCount": 1, // Total number of annotations on the item
"annotated": true // Indicates whether the item has been annotated
}
]
}
GIS Annotation Output
The GIS Annotation JSON Format in DDOE provides a structured representation of each annotation associated with a GIS data item, including spatial, labeling, and metadata details essential for geospatial analysis and annotation tasks. Here’s an explanation of its structure based on the provided content
To download the JSON file of an item’s annotations, click here. This JSON code includes the entity's data related to our software and its metadata.
{
"annotations": [
{
"id": "671b5eab1f899aa6991e529c", // Unique annotation ID
"datasetId": "66f696930998d514b9ee899c", // ID of the dataset the annotation belongs to
"itemId": "6710cbb42b0fa56310b7fae1", // ID of the item (data file) annotated
"url": "https://rc-gate.dataloop.ai/api/v1/annotations/671b5eab1f899aa6991e529c", // Direct API link to the annotation
"item": "https://rc-gate.dataloop.ai/api/v1/items/6710cbb42b0fa56310b7fae1", // Link to the annotated item
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/66f696930998d514b9ee899c", // Link to the dataset
"type": "gis", // Annotation type: GIS (Geographic Information System)
"label": "a", // User-defined label
"attributes": [], // Custom label attributes (empty here)
"metadata": {
"system": {
"status": null,
"startTime": 0, // Annotation start time (if temporal)
"endTime": 0, // Annotation end time
"frame": 0, // Frame index for video or sequence data
"endFrame": 1, // Ending frame
"snapshots_": [], // Historical versions (if any)
"promptId": null, // Related prompt ID (if generated)
"parentId": null, // Parent annotation (if nested)
"clientId": "1b2f5dea-3db7-435c-bf79-fcf016465e9a", // Client tracking ID
"automated": false, // Whether it was auto-generated
"objectId": "2", // Internal object reference
"attributes": {}, // Key-value metadata
"system": false, // Indicates this is a user annotation, not system-generated
"itemLinks": [], // Cross-item links (if applicable)
"openAnnotationVersion": "1.82.1-rc.12", // Platform version used
"recipeId": "66f696940bda130037a247c1" // Labeling recipe used
},
"user": {} // Placeholder for user-defined metadata
},
"creator": "emailid@domain.com", // Creator of the annotation
"createdAt": "2024-10-25T09:02:35.049Z", // When the annotation was created
"updatedBy": "emailid@domain.com", // Last user who updated it
"updatedAt": "2024-10-25T09:02:35.049Z", // When the annotation was last updated
"hash": "e44f16b629aa51a3eac630df38caaf32b6357e18", // Hash for annotation content versioning
"source": "ui", // Annotation source (UI/manual vs automation)
"coordinates": {
"geo_type": "polyline", // Geometry type (point, polyline, polygon, box)
"wgs84_geo_coordinates": [
["N0", "00"],
["N0", "00"]
] // Coordinates in WGS84 latitude/longitude format
}
},
// Additional annotations follow with similar structure...
// Polygon annotation
{
"coordinates": {
"geo_type": "polygon", // Area shape defined by multiple lat/lon points
"wgs84_geo_coordinates": [
[
[-117.1583154259652, 32.681641928697644],
[-117.16166720313508, 32.68021050006596],
[-117.1628413556346, 32.6771172113695],
[-117.15843813221882, 32.67619340733788],
[-117.1555912951791, 32.67854664829772]
]
]
}
},
// Box annotation (a polygon that forms a rectangle)
{
"coordinates": {
"geo_type": "box",
"wgs84_geo_coordinates": [
[
[-117.16522551129627, 32.679954349679235],
[-117.16929932427566, 32.679954349679235],
[-117.16929932427566, 32.682418606459144],
[-117.16522551129627, 32.682418606459144],
[-117.16522551129627, 32.679954349679235]
]
]
}
},
// Point annotation (single lat/lon)
{
"coordinates": {
"geo_type": "point", // Simple coordinate with no area
"wgs84_geo_coordinates": [-117.16739742064368, 32.677908090842784]
}
}
],
"_id": "6710cbb42b0fa56310b7fae1", // ID of the annotated item
"filename": "/Parquet/parquet_xyz (1).json", // File path or name in dataset
"metadata": {
"system": {
"encoding": "7bit", // File encoding
"isBinary": false, // File is not binary
"mimetype": "application/json", // MIME type of the file
"originalname": "parquet_xyz (1).json", // Original name before upload
"refs": [], // Related references or links
"shebang": { "dltype": "gis" }, // Declared data type (GIS-type annotations)
"size": 631, // File size in bytes
"taskStatusLog": [] // Processing history (if part of a task)
}
}
}
Instance Segmentation Annotation Output
This page describes Instance Segmentation annotation JSON, a data format for describing Instance Segmentation Annotation data in JavaScript Object Notation (JSON).
{
"annotations": [
{
"id": "67ceef3bb37fa82ff71ba563",
"datasetId": "67ceef0416595b6856e210e0",
"url": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
"createdAt": "2025-03-10T13:55:07.498Z",
"dir": "/",
"filename": "/images.png",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"channels": 3,
"encoding": "7bit",
"height": 480,
"isBinary": true,
"mimetype": "image/jpeg",
"originalname": "images.png",
"refs": [],
"size": 24018,
"taskStatusLog": [],
"thumbnailId": "67ceef3f20b914f28531df74",
"width": 640
}
},
"name": "images.png",
"creator": "user@dataloop.ai",
"updatedAt": "2025-03-10T13:55:11.205Z",
"updatedBy": "user@dataloop.ai",
"stream": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563/stream",
"thumbnail": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563/thumbnail",
"annotations": [
{
"id": "67cf1a8415680d49f21d7f8d",
"datasetId": "67ceef0416595b6856e210e0",
"itemId": "67ceef3bb37fa82ff71ba563",
"url": "https://gate.dataloop.ai/api/v1/annotations/67cf1a8415680d49f21d7f8d",
"item": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
"type": "binary",
"label": "Bird-1",
"attributes": [],
"coordinates": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAoAAAAHgCAYAAAA10dzkAAAAAXNSR0IArs4c6QAAIABJREFUeF7t3e1y3cYRBFD6/R/aKcpmRMmkLj5mFrvbJ38F4GLONLIducr5681/CBAgQIAAAQIEogT+iprWsA...........xIdxAAAAAElFTkSuQmCC",
"metadata": {
"system": {
"attributes": {
"1": "No"
},
"automated": false,
"clientId": "4a3f3b7f-74cd-41d7-98c6-1c4aa17c85a5",
"endFrame": 1,
"endTime": 0,
"frame": 0,
"isOnlyLocal": false,
"isOpen": false,
"itemLinks": [],
"objectId": 1,
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "64b4d4652679f454253ffddb",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T16:59:48.199Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T16:59:58.278Z",
"hash": "67ceef0416595b6856e210e0_67ceef3bb37fa82ff71ba563_Bird-1_user@dataloop.ai_1",
"source": "ui"
}
],
"annotationsCount": 1,
"annotated": true
}
}
Field Definitions
| Key Name | Definition | Parent Key |
|---|---|---|
| id | Unique identifier for the item | Root |
| datasetId | Unique identifier for the dataset | Root |
| url | URL of the item in the system | Root |
| dataset | URL of the dataset | Root |
| createdAt | Timestamp of when the item was created | Root |
| dir | Directory path of the item | Root |
| filename | Name of the file | Root |
| type | Type of the item (e.g., file) | Root |
| hidden | Boolean indicating if the item is hidden | Root |
| metadata | Metadata information | Root |
| metadata.system | System-level metadata | metadata |
| metadata.system.channels | Number of color channels in the image | metadata.system |
| metadata.system.encoding | Encoding type of the file | metadata.system |
| metadata.system.height | Height of the image in pixels | metadata.system |
| metadata.system.isBinary | Boolean indicating if the file is binary | metadata.system |
| metadata.system.mimetype | MIME type of the image | metadata.system |
| metadata.system.originalname | Original file name | metadata.system |
| metadata.system.refs | References related to the item | metadata.system |
| metadata.system.size | Size of the file in bytes | metadata.system |
| metadata.system.taskStatusLog | Log of task statuses | metadata.system |
| metadata.system.thumbnailId | Unique identifier for the thumbnail image | metadata.system |
| metadata.system.width | Width of the image in pixels | metadata.system |
| name | Name of the item | Root |
| creator | Creator of the item | Root |
| updatedAt | Timestamp of when the item was last updated | Root |
| updatedBy | User who last updated the item | Root |
| stream | Stream URL of the item | Root |
| thumbnail | Thumbnail URL of the item | Root |
| annotations | List of annotations | Root |
| annotations.id | Unique identifier for the annotation | annotations |
| annotations.datasetId | Unique identifier for the dataset related to annotation | annotations |
| annotations.itemId | Unique identifier for the item related to annotation | annotations |
| annotations.url | URL of the annotation | annotations |
| annotations.item | URL of the item related to annotation | annotations |
| annotations.dataset | URL of the dataset related to annotation | annotations |
| annotations.type | Type of annotation (e.g., binary) | annotations |
| annotations.label | Label assigned to the annotation | annotations |
| annotations.attributes | Additional attributes of the annotation | annotations |
| annotations.coordinates | Encoded segmentation mask data | annotations |
Image Annotation Output
{
"annotations": [
{
"id": "67ceef3bb37fa82ff71ba563",
"datasetId": "67ceef0416595b6856e210e0",
"url": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
"createdAt": "2025-03-10T13:55:07.498Z",
"dir": "/",
"filename": "/images.png",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"channels": 3,
"encoding": "7bit",
"height": 480,
"isBinary": true,
"mimetype": "image/jpeg",
"originalname": "images.png",
"refs": [],
"size": 24018,
"taskStatusLog": [],
"thumbnailId": "67ceef3f20b914f28531df74",
"width": 640
}
},
"name": "images.png",
"creator": "user@dataloop.ai",
"updatedAt": "2025-03-10T13:55:11.205Z",
"updatedBy": "user@dataloop.ai",
"stream": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563/stream",
"thumbnail": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563/thumbnail",
"annotations": [
{
"id": "67ceef62995ecd2df020d514",
"datasetId": "67ceef0416595b6856e210e0",
"itemId": "67ceef3bb37fa82ff71ba563",
"url": "https://gate.dataloop.ai/api/v1/annotations/67ceef62995ecd2df020d514",
"item": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
"type": "class",
"label": "Bird-1",
"attributes": [],
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "4e3b6a65-40f4-4ffc-9f63-22199922b8db",
"endFrame": 0,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "1",
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "64b4d4652679f454253ffddb",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T13:55:46.394Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T13:55:46.394Z",
"hash": "824c48b05a2eb5caf95090121db2c11f4d83b5ce",
"source": "ui"
},
{
"id": "67ceef62995ecd68f320d515",
"datasetId": "67ceef0416595b6856e210e0",
"itemId": "67ceef3bb37fa82ff71ba563",
"url": "https://gate.dataloop.ai/api/v1/annotations/67ceef62995ecd68f320d515",
"item": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
"type": "box",
"label": "Bird-1",
"attributes": [],
"coordinates": [
{
"x": 51.09,
"y": 127.96,
"z": 0
},
{
"x": 464.82000000000005,
"y": 376.36,
"z": 0
}
],
"metadata": {
"system": {
"attributes": {
"1": "No"
},
"automated": false,
"clientId": "2bfa1965-9482-4cb0-8a6f-c151ef7b6535",
"coordinateVersion": "v2",
"endFrame": 0,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "2",
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "64b4d4652679f454253ffddb",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T13:55:46.394Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T13:55:46.394Z",
"hash": "304f3b1f01262e17a862d98a745a47cde8b90504",
"source": "ui"
}
],
"annotationsCount": 2,
"annotated": true
}]
}
Fields Description
| Key Name | Definition | Parent Key |
|---|---|---|
| id | Unique identifier for the item | Root |
| datasetId | Unique identifier for the dataset | Root |
| url | URL to access the item | Root |
| dataset | URL to access the dataset | Root |
| createdAt | Timestamp when the item was created | Root |
| dir | Directory path of the item | Root |
| filename | Name of the file | Root |
| type | Type of the item (e.g., file) | Root |
| hidden | Boolean indicating if the item is hidden | Root |
| metadata | Metadata associated with the item | Root |
| metadata.system | System-level metadata | metadata |
| channels | Number of color channels in the image | metadata.system |
| encoding | Encoding type of the file | metadata.system |
| height | Height of the image in pixels | metadata.system |
| isBinary | Boolean indicating if the file is binary | metadata.system |
| mimetype | MIME type of the file | metadata.system |
| originalname | Original name of the file | metadata.system |
| refs | List of reference items | metadata.system |
| size | Size of the file in bytes | metadata.system |
| taskStatusLog | Log of task statuses | metadata.system |
| thumbnailId | Unique identifier for the thumbnail | metadata.system |
| width | Width of the image in pixels | metadata.system |
| name | Name of the item | Root |
| creator | Creator of the item | Root |
| updatedAt | Timestamp when the item was last updated | Root |
| updatedBy | User who last updated the item | Root |
| stream | URL to stream the image | Root |
| thumbnail | URL to the thumbnail image | Root |
| annotations | List of annotations for the item | Root |
| annotations.id | Unique identifier for the annotation | annotations[] |
| annotations.datasetId | Dataset ID associated with the annotation | annotations[] |
| annotations.itemId | Item ID the annotation belongs to | annotations[] |
| annotations.url | URL to access the annotation | annotations[] |
| annotations.item | URL to the annotated item | annotations[] |
| annotations.dataset | URL to the dataset of the annotation | annotations[] |
| annotations.type | Type of annotation (e.g., class, box) | annotations[] |
| annotations.label | Label of the annotation | annotations[] |
| annotations.attributes | List of attributes associated with the annotation | annotations[] |
| coordinates | List of coordinate points for the annotation | annotations[] |
| coordinates.x | X-coordinate of the annotation point | coordinates |
| coordinates.y | Y-coordinate of the annotation point | coordinates |
| coordinates.z | Z-coordinate of the annotation point (depth, if applicable) | coordinates |
| annotations.metadata | Metadata related to the annotation | annotations[] |
| metadata.system | System-related metadata for the annotation | annotations.metadata |
| attributes | Attributes related to the annotation | metadata.system |
| automated | Boolean indicating if the annotation was generated automatically | metadata.system |
| clientId | Client identifier | metadata.system |
| coordinateVersion | Version of the coordinate system used | metadata.system |
| endFrame | End frame of the annotation | metadata.system |
| endTime | End time of the annotation (in seconds) | metadata.system |
| frame | Frame number of the annotation | metadata.system |
| itemLinks | List of linked items | metadata.system |
| objectId | Object ID associated with the annotation | metadata.system |
| openAnnotationVersion | Version of the annotation tool | metadata.system |
| recipeId | Recipe ID used for annotation | metadata.system |
| snapshots_ | Snapshots related to the annotation | metadata.system |
| startTime | Start time of the annotation (in seconds) | metadata.system |
| system | Boolean indicating if it's a system annotation | metadata.system |
| user | User-related metadata | metadata |
| creator | User who created the annotation | annotations[] |
| createdAt | Timestamp when the annotation was created | annotations[] |
| updatedBy | User who last updated the annotation | annotations[] |
| updatedAt | Timestamp when the annotation was last updated | annotations[] |
| hash | Hash value associated with the annotation | annotations[] |
| source | Source of the annotation (e.g., UI) | annotations[] |
| annotationsCount | Total count of annotations | Root |
| annotated | Boolean indicating if the item is annotated | Root |
Item Output
An 'Item' is a DDOE 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 DDOE Annotation Studio has its unique item structure.
PCD Format
{
"id": "65029ac313c0345fc63a5b5c",
"datasetId": "6458d7e0a4aaff79f2f8e16f",
"url": "https://rc-gate.dataloop.ai/api/v1/items/65029ac313c0345fc63a5b5c",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6458d7e0a4aaff79f2f8e16f",
"createdAt": "2023-09-14T05:31:47.195Z",
"dir": "/098/velodyne_points",
"filename": "/098/velodyne_points/72.pcd",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"encoding": "7bit",
"groundItemId": "6502a0d544ea32436f810445",
"isBinary": false,
"mimetype": "application/pcd",
"originalname": "72.pcd",
"preprocessPhase": "ITEM_UPLOADED",
"refs": [
{
"id": "651ea7f0a5b5caf51279263c",
"type": "task"
},
{
"id": "651ea7f2a5b5cab4bc79263d",
"type": "assignment"
},
],
"size": 13888853,
"taskStatusLog": []
},
"user": {
"lidar_ground_detection": {
"groundMapId": "65084f1b932416453f8a14ac"
}
}
},
"name": "72.pcd",
"creator": "user@dataloop.ai",
"updatedAt": "2023-09-14T05:31:47.999Z",
"updatedBy": "user@dataloop.ai",
"stream": "https://rc-gate.dataloop.ai/api/v1/items/65029ac313c0345fc63a5b5c/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/65029ac313c0345fc63a5b5c/thumbnail",
"annotations": [],
"annotationsCount": 0,
"annotated": false
}
MP3 Format
{
"id": "66cd77785e170e08c6b895d6",
"datasetId": "650038ff86b54fd9dbec7568",
"url": "https://rc-gate.dataloop.ai/api/v1/items/66cd77785e170e08c6b895d6",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/650038ff86b54fd9dbec7568",
"createdAt": "2024-08-27T06:51:36.195Z",
"dir": "/",
"filename": "/Audio file.mp3",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"audioSpeakers": {
"male1": "John",
"male2": "Smith"
},
"encoding": "7bit",
"isBinary": true,
"mimetype": "audio/mpeg",
"originalname": "Audio file.mp3",
"refs": [],
"size": 5289384,
"taskStatusLog": []
}
},
"name": "Audio file.mp3",
"creator": "user@dataloop.ai",
"updatedAt": "2024-09-25T10:54:13.904Z",
"updatedBy": "user@dataloop.ai",
"stream": "https://rc-gate.dataloop.ai/api/v1/items/66cd77785e170e08c6b895d6/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/66cd77785e170e08c6b895d6/thumbnail",
"annotations": [],
"annotationsCount": 0,
"annotated": false
}
MP4 Format
{
"id": "65950dd53dd3b69ea61ad32b",
"datasetId": "655f1387ee8ab462056613f8",
"url": "https://rc-gate.dataloop.ai/api/v1/items/65950dd53dd3b69ea61ad32b",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/655f1387ee8ab462056613f8",
"createdAt": "2024-01-03T07:33:40.281Z",
"dir": "/videos",
"filename": "/videos/pexels-cottonbro-5722113 (2160p).mp4",
"type": "file",
"hidden": false,
"metadata": {
"fps": 25,
"startTime": 0,
"system": {
"duration": 38.76,
"encoding": "7bit",
"ffmpeg": {
"avg_frame_rate": "25/1",
"bit_rate": "17389016",
"bits_per_raw_sample": "8",
"chroma_location": "left",
"closed_captions": 0,
"codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
"codec_name": "h264",
"codec_tag": "0x31637661",
"codec_tag_string": "avc1",
"codec_type": "video",
"coded_height": 4096,
"coded_width": 2160,
"color_primaries": "bt709",
"color_range": "tv",
"color_space": "bt709",
"color_transfer": "bt709",
"disposition": {
"attached_pic": 0,
"clean_effects": 0,
"comment": 0,
"default": 1,
"dub": 0,
"forced": 0,
"hearing_impaired": 0,
"karaoke": 0,
"lyrics": 0,
"original": 0,
"timed_thumbnails": 0,
"visual_impaired": 0
},
"duration": "38.760000",
"duration_ts": 969,
"has_b_frames": 2,
"height": 4096,
"index": 0,
"is_avc": "true",
"level": 52,
"nal_length_size": "4",
"nb_frames": "969",
"nb_read_frames": "969",
"nb_read_packets": "969",
"pix_fmt": "yuv420p",
"profile": "High",
"r_frame_rate": "25/1",
"refs": 5,
"start_pts": 0,
"start_time": "0.000000",
"tags": {
"creation_time": "2020-10-28T12:15:28.000000Z",
"encoder": "AVC Coding",
"handler_name": "L-SMASH Video Handler",
"language": "und",
"vendor_id": "[0][0][0][0]"
},
"time_base": "1/25",
"width": 2160
},
"fps": 25,
"height": 4096,
"isBinary": true,
"mimetype": "video/mp4",
"nb_frames": 969,
"nb_streams": 1,
"originalname": "pexels-cottonbro-5722113 (2160p).mp4",
"refs": [],
"size": 84263510,
"startTime": 0,
"taskStatusLog": [],
"thumbnailId": "65950dd83dd3b675491ad343",
"width": 2160
}
},
"name": "pexels-cottonbro-5722113 (2160p).mp4",
"creator": "user@dataloop.ai",
"updatedAt": "2024-01-03T07:33:41.337Z",
"updatedBy": "pipelines@dataloop.ai",
"stream": "https://rc-gate.dataloop.ai/api/v1/items/65950dd53dd3b69ea61ad32b/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/65950dd53dd3b69ea61ad32b/thumbnail",
"annotations": [],
"annotationsCount": 0,
"annotated": false
}
JPG Format
{
"id": "66cec643520f02585d37af68",
"datasetId": "66cec624f37040beca7d3273",
"url": "https://rc-gate.dataloop.ai/api/v1/items/66cec643520f02585d37af68",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/66cec624f37040beca7d3273",
"createdAt": "2024-08-28T06:40:02.821Z",
"dir": "/turtle",
"filename": "/turtle/05e2720400.jpg",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"channels": 3,
"encoding": "7bit",
"height": 450,
"isBinary": true,
"mimetype": "image/jpeg",
"originalname": "05e2720400.jpg",
"refs": [],
"size": 38747,
"taskStatusLog": [],
"thumbnailId": "66cec6559e5384504e9a633b",
"width": 800
}
},
"name": "05e2720400.jpg",
"creator": "bot.b0b59f22-e9fc-484a-94f1-3e38313fadb4@bot.dataloop.ai",
"updatedAt": "2024-08-28T06:40:21.703Z",
"updatedBy": "user@dataloop.ai",
"stream": "https://rc-gate.dataloop.ai/api/v1/items/66cec643520f02585d37af68/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/66cec643520f02585d37af68/thumbnail",
"annotations": [],
"annotationsCount": 0,
"annotated": false
}
TXT Format
{
"id": "6746c0e1c80dc16a03dd5ede",
"datasetId": "6746c0bc7e10823d1c9aefd5",
"url": "https://rc-gate.dataloop.ai/api/v1/items/6746c0e1c80dc16a03dd5ede",
"dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6746c0bc7e10823d1c9aefd5",
"createdAt": "2024-11-27T06:49:04.926Z",
"dir": "/honeypot",
"filename": "/honeypot/food_87.txt",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"document": {
"source": "food_87.txt"
},
"encoding": "7bit",
"isBinary": false,
"mimetype": "text/plain",
"originalname": "food_87.txt",
"refs": [],
"size": 2691,
"tags": {
"test": true
},
"taskStatusLog": []
}
},
"name": "food_87.txt",
"creator": "bot.b0b59f22-e9fc-484a-94f1-3e38313fadb4@bot.dataloop.ai",
"updatedAt": "2025-01-20T13:00:37.038Z",
"updatedBy": "rubiks@dataloop.ai",
"stream": "https://rc-gate.dataloop.ai/api/v1/items/6746c0e1c80dc16a03dd5ede/stream",
"thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/6746c0e1c80dc16a03dd5ede/thumbnail",
"annotations": [],
"annotationsCount": 0,
"annotated": false
}
GIS Item
The GIS Item JSON structure in DDOE provides a comprehensive format that encapsulates all necessary data and metadata for each annotated entity within the system. This structure is designed to represent an 'Item' — a core data unit in DDOE's platform — and its associated information for annotation purposes. Here’s a breakdown based on the provided content:
Type: XYZ
XYZ is a tiled web map format that loads map tiles dynamically from a specified URL using the {z}/{x}/{y} pattern. It is commonly used for raster-based layers like OpenStreetMap (OSM) and supports zoom levels for smooth navigation. Optional layers (XYZ, OSM, COG) can be added for enhanced visualization.
{
"shebang": "dataloop", //A fixed identifier indicating that the data structure is in Dataloop's format. For the type of Web Map Item, it should be dataloop only and mandatory.
"metadata": {
"dltype": "gis" //For the type of Web Map Item, it should be gis only and mandatory
},
"layer": { // Representing the Tile Layer - it's a mandatory layer object
"name": "XYZ Image", // User-defined name for the GIS item
"type": "xyz", // Currently supporting "xyz", "osm" and "cog" types only
"url": "https://dummy-tile.com/surveys/1723928/tiles/{z}/{x}/{y}?auth_token=fM68PVOJO8p5m2sPo4Cqdcoi4sLSsecR&datatype_name=vexcel_urban_vertical_jpg"
},
"optionalLayers": // Representing the Optional Layers array, which can have multiple layers("xyz", "osm" and "cog")
[
{
"name": "OpenStreetMap", // Name of the optional layer (OpenStreetMap in this case).
"type": "osm", // Specifies that this optional layer is an OpenStreetMap (OSM) layer.
"url": "", // URL for the optional layer (empty in this case, meaning default OSM tiles may be used).
"ref": "<item_id>" // Reference to the item ID associated with this optional layer.
},
}
],
"zoom":20, // It's an optional zoom level, which can be between 0 to 28
"minZoom":0, // It's an optional min zoom level, which can be between 0 to 28
"maxZoom":30, // It's an optional max zoom level, which can be between 1 to 28
"epsg":"4326", // Representing the file's Coordinate System . (3857, 3035, 4326)
"bounds": [ // The coordinates that represents the (square) area within the map that the user can view, and should add/edit the annotations. I.e. the bounds where the projection is valid. Optional field.
[-118.33559370040894, 33.82662439264756],//top left
[-118.33497619628906, 33.82610016009953]//bottom right
],
"aoi": [ // Coordinates representing the Area of Interest -- The areas within the bounds of the tile layer, where I allow to create annotations. I.e. the “boarders of the canvas”. Optional field.
[-118.33545684814453, 33.826504880358854],
[-118.33545684814453, 33.82621967238824],
[-118.33511352539062, 33.82621967238824],
[-118.33511352539062, 33.826504880358854],
[-118.33545684814453, 33.826504880358854]
]
}
Field Definitions
| Key Name | Definition | Parent Key |
|---|---|---|
| shebang | A fixed identifier indicating that the data structure is in DDOE's format. | N/A |
| metadata | Stores additional metadata about the Web Map Item. | N/A |
| dltype | For the type of Web Map Item, it should be gis only and mandatory | metadata |
| layer | Representing the Tile Layer - it's a mandatory layer object | N/A |
| name | Name of the base map layer. | layer |
| type | Defines the tile layer type. | layer |
| url | URL template for the tile source. | layer |
| optionalLayers | Array of additional tile layers that can be used alongside the base layer. | N/A |
| name | Name of the optional map layer | optionalLayers |
| type | Type of the optional layer ("xyz", "osm", "cog") | optionalLayers |
| url | URL for the tile source | optionalLayers |
| zoom | Defines the initial zoom level of the map. | N/A |
| minZoom | Defines the minimum zoom level allowed. | N/A |
| maxZoom | Defines the maximum zoom level allowed. | N/A |
| epsg | Specifies the Coordinate Reference System (CRS). 4326 → WGS 84 (Latitude/Longitude), 3857 → Web Mercator, and 3035 → Lambert Azimuthal Equal-Area. | N/A |
| bounds | Defines the bounding box that limits the map area where users can view or edit annotations. First value: [longitude, latitude] (Top-left corner), and Second value: [longitude, latitude] (Bottom-right corner) | N/A |
| aoi | Defines the Area of Interest (AOI), which is the section of the map where annotations are allowed. I.e. the “boarders of the canvas”. Optional field. | N/A |
Type: geoTiff
GeoTIFF is a raster-based GIS format that stores geospatial metadata, making it ideal for geo-referenced imagery such as satellite images and aerial photography. It can be accessed via a URL or item ID and supports different projections (EPSG: 3035, 4326, 3857) with optional overlays like OpenStreetMap for better visualization.
{
"shebang": "dataloop", //For the type of Web Map Item, it should be dataloop only and mandatory
"metadata": {
"dltype": "gis" //For the type of Web Map Item, it should be gis only and mandatory
},
"layer": {
"name": "GeoTIFF Image", // User-defined name for the main GIS layer.
"type": "geoTiff", // Specifies the layer type. Options: "geoTiff" (raster-based GIS format), "xyz", "osm".
"ref": "67d14487f561d469323d8996" // Reference ID for the GIS item stored in Dataloop. ** It can be either `ref` or `url`.
},
"optionalLayers": [
{
"name": "OpenStreetMap", // Name of the optional overlay layer.
"type": "osm", // Type of the optional layer. Can be "osm", "xyz", or "cog".
"url": "" // URL source for the optional layer (empty means default OSM tiles will be used).
}
],
"epsg": "4326", // Representing the file's Coordinate System (EPSG). Currently we only support epsg 4326 (WGS84).
"bounds": [
[5.046927, 51.9243133], // Top-left coordinate of the bounding box (longitude, latitude).
[5.126927, 51.8243163] // Bottom-right coordinate of the bounding box (longitude, latitude). Defines the visible area where annotations can be created.
],
"aoi": [
[5.096927, 51.8843133], // First coordinate of the Area of Interest (AOI).
[5.076927, 51.8843133], // Second coordinate of the AOI polygon.
[5.076927, 51.8643163], // Third coordinate of the AOI polygon.
[5.096927, 51.8643163], // Fourth coordinate of the AOI polygon.
[5.096927, 51.8843133] // Closing coordinate (same as the first), forming a closed polygon. Defines the area where annotations are allowed.
]
}
Note: The url or ref must be provided.
Field Definitions
| Key Name | Definition | Parent Key |
|---|---|---|
| shebang | Identifier indicating the system or format used, in this case, DDOE. | Root |
| metadata | Contains metadata about the GIS file. | Root |
| dltype | Defines the dataset type as GIS, useful for categorization. | metadata |
| layer | Defines the primary GIS layer details. | Root |
| name | Name of the GIS layer (e.g., TIFF). | layer |
| type | Specifies that this layer is of type GeoTIFF. | layer |
| url | URL to fetch the GIS layer data. | layer |
| ref | Reference to the item ID associated with this layer. | layer |
| optionalLayers | List of additional optional layers. | Root |
| name | Name of the optional layer (e.g., OpenStreetMap). | optionalLayers |
| type | Type of the optional layer (e.g., osm for OpenStreetMap). | optionalLayers |
| url | URL for the optional layer (empty in this case). | optionalLayers |
| epsg | Specifies the coordinate system | Root |
| bounds | Coordinates defining the viewable/editable area of the map. | Root |
| aoi | Coordinates representing the Area of Interest for annotations. | Root |
Note: Using either url or ref is optional.
Coordinate system and projection
Users can modify the map coordinate system and projection within the app.
- Coordinate System: Defines locations using numerical values.
- Geographic Coordinate System (GCS): Uses latitude and longitude (e.g., WGS 84 / EPSG:4326).
- Projection: Converts the Earth's curved surface into a flat map, causing some distortions.
- Mercator – Preserves shape, distorts area.
- Albers Equal-Area – Preserves area, distorts shape.
- UTM – Minimizes distortion for small areas.
RHLF Item Output
It is built from two layers: a file layer and an annotation layer.
The file contains a list of prompts, and the annotations layer contains a list of responses per prompt.
File or Prompt Layer Format
The following format is a data structure example of a file that contains two prompts. The first prompt contains text and an image, and the second prompt contains text only.
{
"shebang": "dataloop",
"metadata": {
"dltype": "prompt"
},
"prompts": {
"prompt1": [
{
"mimetype": "application/text",
"value": "What animal is in this image?"
},
{
"mimetype": "image/jpeg",
"value": "https://gate.dataloop.ai/api/v1/items/6489600c8d5a1c350e55116a/stream"
}
],
"prompt2": [
{
"mimetype": "application/text",
"value": "What is the eye color of this cat?"
}
]
}
}