Recipe JSON Format
- 29 May 2024
- Print
- DarkLight
- PDF
Recipe JSON Format
- Updated On 29 May 2024
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can import and export Labels & attributes in the recipe in JSON format. It allows:
- Saving a backup of your recipe
- Uploading to new datasets and projects
- Preparing it outside the Dataloop platform
- Automating its import.
Recipe JSON Format
{"id":"62dcd88a746376c0d3aa4828",
"creator":"user@dataloop.ai",
"title":"example-ontology",
"roots":
[
{"value":
{"tag":"Label-1",
"displayLabel":"Label-1",
"color":"#ff0000",
"attributes":[],
"displayData":{}},
"children":[
{"value":{"
tag":"sub1",
"displayLabel":"sub1",
"color":"#f0809a",
"attributes":[],
"displayData":{}},
"children":[]},
{"value":{"
tag":"sub2",
"displayLabel":"sub2",
"color":"#154676",
"attributes":[],
"displayData":{}},
"children":[]}]},
{"value":
{"tag":"Label-2",
"displayLabel":"Label-2",
"color":"#00ff4a",
"attributes":[],
"displayData":{}},
"children":[]},
{"value":
{"tag":"Label-3",
"displayLabel":"Label-3",
"color":"#9500ff",
"attributes":[],
"displayData":{}},
"children":[]},
{"value":
{"tag":"Label-4",
"displayLabel":"Label-4",
"color":"#ffdf00",
"attributes":[],
"displayData":{}},
"children":[]}
],
"metadata":
{"system":
{"projectIds":["f2278c37-b967-4326-af7c-b8245264e826"],
"system":false},
"attributes":[
{"key":"1",
"type":"options",
"scope":["*"],
"values":["Att1a","Att1b","Att1c"],
"scriptData":{
"scope":"@ontology.sections.1.scope",
"title":"Attribute-1",
"key":"1",
"optional":true,
"multi":true}},
{"key":"2",
"type":"options",
"scope":["*"],
"values":["Att2a","Att2b","Att2c"]
,"scriptData":{
"scope":"@ontology.sections.2.scope",
"title":"Attribute-2",
"key":"2",
"optional":true,
"multi":false}},
{"key":"3",
"type":"range",
"scope":["Label-1","Label-2"],
"range":{"min":0,"max":1,"step":0.1},
"scriptData":{
"scope":"@ontology.sections.3.scope",
"title":"Attribute-3","key":"3",
"optional":true,"multi":true}},
{"key":"4",
"type":"boolean",
"scope":["*"],
"scriptData":{
"scope":"@ontology.sections.4.scope",
"title":"Attribute-4",
"key":"4","optional":true,
"multi":true}},
{"key":"5",
"type":"freeText",
"scope":["Label-3","Label-4"],
"scriptData":{
"scope":"@ontology.sections.5.scope",
"title":"Attribute5-Text",
"key":"5",
"optional":true,
"multi":true}}
]
},
"attributes":null}
Recipe JSON Fields Description
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 of the item's information | N/A |
system | This key holds all of 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 |