Skip to content

Commit ddd7e0f

Browse files
niklubnik
and
nik
authored
docs: Fix parent ID reference (#7239)
Co-authored-by: nik <[email protected]>
1 parent 6e0564d commit ddd7e0f

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/source/includes/task_format.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ Review the full list of JSON properties in the [API documentation](api.html).
114114
| annotations.completed_at | Timestamp for when the annotation is created or submitted. |
115115
| annotations.completed_by | User ID of the user that created the annotation. Matches the list order of users on the People page on the Label Studio UI. |
116116
| annotations.was_cancelled | Boolean. Details about whether or not the annotation was skipped, or cancelled. |
117-
| result.id | Identifier for the specific annotation result for this task.|
117+
| result.id | Identifier for the specific annotation result for this task. Use it to combine together regions from different control tags, e.g. `<Labels>` and `<Rectangle>` |
118+
| result.parentID | (Optional) Reference to the parent region result.id. Use it to create nested regions |
118119
| result.from_name | Name of the tag used to label the region. See [control tags](/tags). |
119120
| result.to_name | Name of the object tag that provided the region to be labeled. See [object tags](/tags). |
120121
| result.type | Type of tag used to annotate the task. |

0 commit comments

Comments
 (0)