NLP JSON Format

Updated On 03 Jun 2024

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

This page describes NLP (Natural Language Processing) JSON, a data format for describing NLP data in JavaScript Object Notation (JSON). This JSON code includes the entity's data related to our software and its metadata.

Read here about the NLP Annotation Studio.

Format Details

{
	"annotations": [
		{
			"id": "656d8aaacba59433707782ba",
			"datasetId": "62ea41e27cfb8a4efb2fa7bd",
			"itemId": "62ea451334ef443fcad91dc9",
			"url": "https://gate.dataloop.ai/api/v1/annotations/656d8aaacba59433707782ba",
			"item": "https://gate.dataloop.ai/api/v1/items/62ea451334ef443fcad91dc9",
			"dataset": "https://gate.dataloop.ai/api/v1/datasets/62ea41e27cfb8a4efb2fa7bd",
			"type": "text_mark",
			"label": "Subject",
			"attributes": [],
			"metadata": {
				"user": {},
				"system": {
					"status": null,
					"startTime": 0,
					"endTime": 0,
					"frame": 0,
					"endFrame": 1,
					"snapshots_": [],
					"promptId": null,
					"parentId": null,
					"clientId": "b69cb7e8-febe-4454-b6c4-d4b3fb674f66",
					"automated": false,
					"objectId": "19",
					"attributes": {},
					"system": false,
					"itemLinks": [],
					"openAnnotationVersion": "1.71.0-prod.22",
					"recipeId": "62ea41e33b6b9ea21b067327"
				}
			},
			"creator": "lior@dataloop.ai",
			"createdAt": "2023-12-04T08:15:38.936Z",
			"updatedBy": "lior@dataloop.ai",
			"updatedAt": "2023-12-04T08:15:38.936Z",
			"hash": "13f2be696e2887140e30315ed388d3150dc903b3",
			"source": "ui",
			"coordinates": {
				"type": "block",
				"label": "Subject",
				"start": 5,
				"end": 20
			}
		},
		{
			"id": "656d8aaacba59448a67782bb",
			"datasetId": "62ea41e27cfb8a4efb2fa7bd",
			"itemId": "62ea451334ef443fcad91dc9",
			"url": "https://gate.dataloop.ai/api/v1/annotations/656d8aaacba59448a67782bb",
			"item": "https://gate.dataloop.ai/api/v1/items/62ea451334ef443fcad91dc9",
			"dataset": "https://gate.dataloop.ai/api/v1/datasets/62ea41e27cfb8a4efb2fa7bd",
			"type": "text_mark",
			"label": "Subject",
			"attributes": [],
			"metadata": {
				"user": {},
				"system": {
					"status": null,
					"startTime": 0,
					"endTime": 0,
					"frame": 0,
					"endFrame": 1,
					"snapshots_": [],
					"promptId": null,
					"parentId": null,
					"clientId": "a52a42dd-10ee-4071-a71f-86e6c0e31d87",
					"automated": false,
					"objectId": "20",
					"attributes": {},
					"system": false,
					"itemLinks": [],
					"openAnnotationVersion": "1.71.0-prod.22",
					"recipeId": "62ea41e33b6b9ea21b067327"
				}
			},
			"creator": "lior@dataloop.ai",
			"createdAt": "2023-12-04T08:15:38.938Z",
			"updatedBy": "lior@dataloop.ai",
			"updatedAt": "2023-12-04T08:15:38.938Z",
			"hash": "d21b07885eb9d6e8ef43eb90be6d29702835eca9",
			"source": "ui",
			"coordinates": {
				"type": "block",
				"label": "Subject",
				"start": 0,
				"end": 4
			}
		}
	],
	"_id": "62ea451334ef443fcad91dc9",
	"filename": "/Albert Einstein.txt",
	"metadata": {
		"system": {
			"originalname": "Albert Einstein.txt",
			"size": 491,
			"encoding": "7bit",
			"taskStatusLog": [],
			"mimetype": "text/plain",
			"refs": [],
			"isBinary": false
		}
	}
}

Dictionary Table

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
user	Metadata added by user via SDK	metadata
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
promptId	an identifier for a specific prompt	system
parentId	Id of parent annotation	system
clientId	Annotation created in UI (clientId when not saved)	system
automated	False = 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
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	Object of includes 3D cube data	annotations
type	This indicates the type of coordinates being used. In this case, it's a "block," which suggests a contiguous range of elements.	coordinates
label	This provides a label or identifier for the specified coordinates.	coordinates
start	This value defines the starting position of the block of interest. In this case, the block starts at position 0.	coordinates
end	This value defines the ending position of the block of interest. In this case, the block ends at position 4.	coordinates
id	The item ID	annotations
filename	Name of the file	annotations
metadata	Information about the annotation	annotations
system	Annotation system information	metadata
size	File size	system
encoding	Click here to learn about encoding.	system
taskStatusLog	Logs from the task.	system
mimetype	The mime type of the file	system
refs	The references of the task	system
isBinary	Is the item a binary file	system

What's Next

RLHF JSON Format

Table Of Contents

Format Details
Dictionary Table