body params
Examples
shell
curl https://${domain}/rosetta-open/taxonomy \
-X POST \
-H 'Content-Type: application/json' \
-H 'X-STARDUST-KEY: <X-STARDUST-KEY>' \
-H 'X-TS: <X-TS>' \
-H 'X-SIGN: <X-SIGN>' \
-d '{"taxonomyVersionName":"7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b"," taxonomyDetails":[{"label":"car","slotSpecification":{"imageSourceMapping":["box2d-[1570d]"],"type":"box3d"},"instanceOption":{"minQuantity":1,"maxQuantity":5},"key":"box3d-[70692]","type":"slotChildren","children":[{"label":"color","inputSpecification":{"type":"select","items":[{"label":"red","value":"Red"},{"label":"white","value":"White"},{"label":"black","value":"Black"}],"default":"Red"},"key":"select-[94e49]","type":"input"},{"label":"tyre ","slotSpecification":{"minWidth":200,"minHeight":500,"type":"box2d"},"instanceOption":{"minQuantity":1,"maxQuantity":5},"key":"box2d-[1570d]","type":"slot"}]}]}'json
responses
json
NOTE
The "operator" exists as a configuration item for the Rosetta platform annotation tool and supports the use of combined JSON data as input parameters. The overall design is based on the "type" as the basic classification and supports both single-layer and multi-layer nested annotation table configurations, as well as input box configurations.
Key Feature Explanation
- Operator Type
- "slot"：The slot is used for geometric annotation.
- "input"：The input is used for parameter configuration.When input has no parent, it describes the task itself. When input is in the Children of SlotChildren, it describes the upper slot.
- "slotChildren"：slotChildren is a special type of slot that can contain slot , input and even another slotChildren inside it.
- The nesting structure of Input is implemented through items.children.
Mapping of Annotation types
| Rosetta Annotation types | Helix Annotation Types |
|---|---|
| box2d | HLX-2D-BoundingBox |
| square | HLX-2D-BoundingBox.Square |
| ellipse | HLX-2D-BoundingBox.Oval |
| triangle | HLX-2D-BoundingBox.3point-polygon |
| line | HLX-2D-Polyline |
| polygon | HLX-2D-Polygon |
| point | HLX-2D-KeyPoint |
| box3d | HLX-3D-BoundingBox |
| polygon3d | HLX-3D-BoundingBox.Oval HLX-3D-BoundingBox.3point-polygon HLX-3D-BoundingBox.Square 4D Map Labeling |
| line3d | HLX-3D-Polyline 4D Map Labeling |
| semantic-segmentation3d | HLX-3D-Polygon.SemSeg HLX-3D-Polygon.InstanceSeg |
| select | HLX-2D-EventTagging |
| text | HLX-Text-TextDescription |
| group | 4D Map Labeling |
| posture-3d | |
| boolean | |
| rectangle3d | |
| anchor | |
| splines | |
| cuboid | |
| csg-segmentation3d |
Slot (Single-layer Annotation Item)
| Attribute | Required | Type | Description | Check |
|---|---|---|---|---|
| key | true | string | Unique identifier ,in the format of $ | The key for Taxonomy can't repeated. |
| type | true | string(Enum) | Is fixed as "slot" | |
| label | true | string | Operator name | |
| exportLabel | false | string | Export Label name | |
| slotSpecification.type | true | string(Enum) | rosetta annotation type | |
| slotSpecification.customColor | false | string | Instance color for the annotation(Color notation in hexadecimal) | |
| metadata.hint | false | string | Hint information for the annotation | |
| metadata.tutorial | false | string | Operation tutorial content | |
| instanceOption.minQuantity/maxQuantity | false | number | (AQC) Min/Max quantity for the annotation | minQuantity/maxQuantity must greater than 1 |
| slotSpecification.minWidth/minHeight | false | number | (AQC)Min size for relevant geometric 2D shapes(eg:2Dbox,2D Square,2D Oval,2D Polygon,2D 3points Polygon) | minWidth/minHeight must greater than 1 |
| slotSpecification.minVertices/maxVertices | false | number | (AQC)The 3Dbox contains the minimum/maximum number of points. The default state 'minimum' is 0 and 'maximum' is positive infinity | minVertices/maxVertices must greater than 0 |
| slotSpecification. topLeftMark/topRightMark/bottomLeftMark/bottomRightMark | false | string | vertex labels for box2D | |
| slotSpecification.restrictInsideCanvasBoundary | false | boolean | Drawing instances is limited to the image area only.If set to true, drawing instances is limited to the image area only. | |
| slotSpecification.presetSizes.name | false | string | The name of preset size for box3d. name refers to the group name for each set of preset dimensions (length, width, and height). | |
| slotSpecification.presetSizes.geometry.width/height/depth | false | number | Depend on the configuration "slotSpecification.presetSize.name". Preset the length, width, and height of the 3D bounding box. | geometry width/height/depth must greater than 1 |
| slotSpecification.maxPadding | false | number | (AQC) Border distance from point cloud for box3d | maxPadding must greater than 0 |
| slotSpecification.imageSourceMapping | false | string[] | It is used to automatically generate 2D instances on 2D images that follow a spatial mapping relationship with the corresponding 3D instance. (except semantic segmentation）.The value is child slot key(Unique identifier) .This attribute is only for 3D operators like 3Dbox, 3D polygon , 3D polyline etc . | Whether the key of the child source mapping exists |
| slotSpecification.arrowMark | false | boolean | Whether to display the direction of the 2Dbox. | |
| slotSpecification.sizeCheckSwitch | false | boolean | Size verification switch | |
| slotSpecification.mappingScope | false | string | Mapping range. enumeration is: inside、outside、both.This attribute is only for 3D operators like 3Dbox, 3D polygon , 3D polyline etc . | |
| slotSpecification.consistentSize | false | boolean | consistent Size switch.It can only be used in 3Dbox. | |
| slotSpecification.looseConsistentSize | flase | boolean | Dimensional consistency and strength verification.It can only be used in 3Dbox. | |
| slotSpecification. frontTopLeftMark/frontTopRightMark/frontBottomRightMark/frontBottomLeftMark /backTopLeftMark/backTopRightMark/backBottomRightMark/backBottomLeftMark | flase | string | The 8 vertex markers of cuboid.It can only be used in cuboid. | |
| slotSpecification.stepPrecision | flase | number | posture-3d accuracy. It is recommended value is 0.01 and it can only be used in posture-3d. |
Input (Input Configuration Item)
| Attribute | Required | Type | Description |
|---|---|---|---|
| key | true | string | Unique identifier, in the format of $ |
| type | true | string(Enum) | Fixed as "input" |
| label | true | string | Operator name |
| exportLabel | false | string | Export Label name |
| inputSpecification.type | true | string(Enum) | select:Single choice question multiple-select：Multiple choice question nested-select：Nested multiple choice multiple-nested-select:Nested multiple choice number:Input digit boolean:Input true/false text:Input any text multiple-text:Label mode |
| inputSpecification.default | false | string | Default value.If it is multiple choice, it must be one or more values in the option list. |
| inputSpecification.allowArbitraryInput | false | boolean | Whether multiple-choice questions support custom input options |
| inputSpecification.renderConfig.selectionWidgetType | false | string | Component types, enumerated is: Dropdown, Segment |
| inputSpecification.items | false | InputItem[] | Items is an option list. The item.children field is only applicable when the input’s inputSpecification.type is set to either "nested-select" or "multiple-nested-select".And it is used to define multi-level sub-options within an item. |
| inputSpecification.continuousFrameSync | false | boolean | When continuous frame attribute synchronization is enabled, after the first frame attribute is completed, the subsequent frame attributes will be automatically filled with the same value |
| inputSpecification.latex | false | boolean | Whether to enable latex format preview |
| inputSpecification.regex | false | string | Text verification regular expression |
| metadata.hint | false | string | Hint information for the input |
| inputOption.required | false | boolean | Whether the input is required |
InputItem
| Attribute | Required | Type | Description |
|---|---|---|---|
| label | true | string | Option display name |
| value | true | string | Option value - The value of the single-selection type is a string.- The value of the multiple-selection type is an array.- The value of the nested type needs to include the full path (e.g., Fruits/Apple). |
| children | false | InputItem[] | Sub-options (required only for nested types) |
SlotChildren
| Attribute | Required | Type | Description |
|---|---|---|---|
| key | true | string | Unique identifier, in the format of $ |
| type | true | string(Enum) | Fixed as "slotChildren" |
| label | true | string | Operator name |
| exportLabel | false | string | Export Label name |
| slotSpecification | true | Slot.slotSpecification | This is exactly the same as the slotSpecification |
| slotSpecification.type | true | string(Enum) | All Slot.type are available |
| children | true | taxonomy[] | Set of nested taxonomy items |
| metadata.hint | false | string | Hint information at the SlotChildren level |
| instanceOption.minQuantity/maxQuantity | false | number | (AQC) Min/Max quantity for the instance of slot |
Visualization Example of the Nesting Structure
SlotChildren (Root)
├─ Slot (key: box2d-[73c98])
│ └─ slotSpecification (type: box2d)
├─ Input (key: select-[7a8cb])
│ └─ inputSpecification (type: nested-select)
│ └─ items
│ ├─ label: First-level option
│ └─ children
│ └─ label: Second-level option
└─ SlotChildren (key: group-[12345])
├─ Slot (key: point3d-[67890])
└─ Input (key: boolean-[abcd])Usage Scenario Examples
2D annotation
json
[
{
"label": "triangle",
"exportLabel": "This is the export name ",
"slotSpecification": {
"customColor": "#3000F2",
"minWidth": 10,
"minHeight": 10,
"restrictInsideCanvasBoundary": true,
"type": "triangle"
},
"metadata": {
"hint": "tips"
},
"instanceOption": {
"minQuantity": 5,
"maxQuantity": 10
},
"key": "triangle-[0d673]",
"type": "slot"
},
{
"label": "square",
"exportLabel": "This is the export name ",
"slotSpecification": {
"customColor": "#A3CC00",
"minWidth": 10,
"minHeight": 10,
"restrictInsideCanvasBoundary": true,
"type": "square"
},
"metadata": {
"hint": "tips"
},
"instanceOption": {
"minQuantity": 5,
"maxQuantity": 10
},
"key": "square-[3e674]",
"type": "slot"
},
{
"label": "ellipse",
"exportLabel": "This is the export name ",
"slotSpecification": {
"customColor": "#A3CC00",
"minWidth": 10,
"minHeight": 10,
"restrictInsideCanvasBoundary": true,
"type": "ellipse"
},
"metadata": {
"hint": "tips"
},
"instanceOption": {
"minQuantity": 5,
"maxQuantity": 10
},
"key": "ellipse-[s36d5]",
"type": "slot"
},
{
"key": "box2d-[10aa5]", // Unique identifier for this slotChildren item, indicating a 2Dbox
"label": "Vehicle", // Display name for this annotation group
"type": "slotChildren", // Indicates it's a multi-layer nested annotation group
"slotSpecification": {
"customColor": "#3000F2", // Custom color for the 2Dbox
"type": "box2d", // Type of the annotation is a 2Dbox
"restrictInsideCanvasBoundary": true, // Restricts the annotation to be inside the canvas boundary
"topLeftMark": "1", // Mark for the top-left vertex of the 2Dbox
"topRightMark": "2", // Mark for the top-right vertex of the 2Dbox
"bottomRightMark": "3", // Mark for the bottom-right vertex of the 2Dbox
"bottomLeftMark": "4" // Mark for the bottom-left vertex of the 2Dbox
},
"children": [
// First input item within the slotChildren group, related to vehicle events
{
"key": "select-[798e0]", // Unique identifier for this input item
"label": "Event of vehicle", // Display name for this input
"type": "input", // Indicates it's an input item
"metadata": {
"hint": "Event of car" // Hint message to provide context about the input
},
"inputSpecification": {
"type": "nested-select", // Input type is nested selection
"items": [
{
"label": "Turning", // Label for the option
"value": "1", // Value associated with the option
"children": [
{
"label": "Left turning",
"value": "1-1"
},
{
"label": "Right turning",
"value": "1-2"
},
{
"label": "U-turn",
"value": "1-3"
}
] // Nested children options for "Turning"
},
{
"label": "Going straight",
"value": "2"
},
{
"label": "Applying the brakes",
"value": "3"
},
{
"label": "Overtaking",
"value": "4",
"children": [
{
"label": "Overtaking on the left",
"value": "4-1"
},
{
"label": "Overtaking on the right",
"value": "4-2"
}
] // Nested children options for "Overtaking"
}
]
}
},
// Second input item within the slotChildren group, related to vehicle types
{
"key": "select-[70603]", // Unique identifier for this input item
"label": "Type of vehicle", // Display name for this input
"type": "input", // Indicates it's an input item
"inputSpecification": {
"type": "nested-select", // Input type is nested selection
"items": [
{
"label": "Passenger Car", // Label for the option
"value": "1", // Value associated with the option
"children": [
{
"label": "Sedan",
"value": "1-1"
},
{
"label": "SUV",
"value": "1-2"
},
{
"label": "MPV",
"value": "1-3"
}
] // Nested children options for "Passenger Car"
},
{
"label": "Commercial Vehicle", // Label for the option
"value": "2", // Value associated with the option
"children": [
{
"label": "Truck",
"value": "2-1"
},
{
"label": "Bus",
"value": "2-2"
},
{
"label": "Construction Vehicle",
"value": "2-3"
}
] // Nested children options for "Commercial Vehicle"
},
{
"label": "Special Vehicle", // Label for the option
"value": "3", // Value associated with the option
"children": [
{
"label": "AV Test Vehicle",
"value": "3-1"
}
] // Nested children options for "Special Vehicle"
}
]
}
}
]
}
]3D annotation
json
[
// Represents a nested annotation group (slotChildren) for a 3Dbox related to a vehicle
{
"key": "box3d-[6fa96]", // Unique identifier for this slotChildren item, indicating a 3Dbox
"label": "Vehicle", // Display name for this annotation group
"type": "slotChildren", // Indicates it's a multi-layer nested annotation group
"slotSpecification": {
"customColor": "#00CC52", // Custom color for the 3Dbox
"type": "box3d" // Type of the annotation is a 3Dbox
},
"instanceOption": {}, // No specific instance-related options set
"children": [
// First input item within the slotChildren group, related to vehicle types
{
"key": "select-[6e913]", // Unique identifier for this input item
"label": "Type of vehicle", // Display name for this input
"type": "input", // Indicates it's an input item
"metadata": {}, // No metadata information for this input item
"inputSpecification": {
"type": "nested-select", // Input type is nested selection
"items": [
{
"label": "Passenger Car", // Label for the option
"value": "1", // Value associated with the option
"children": [
{
"label": "Sedan",
"value": "1-1"
},
{
"label": "SUV",
"value": "1-2"
},
{
"label": "MPV",
"value": "1-3"
}
] // Nested children options for "Passenger Car"
},
{
"label": "Commercial Vehicle", // Label for the option
"value": "2", // Value associated with the option
"children": [
{
"label": "Truck",
"value": "2-1"
},
{
"label": "Bus",
"value": "2-2"
},
{
"label": "Construction Vehicle",
"value": "2-3"
}
] // Nested children options for "Commercial Vehicle"
},
{
"label": "Special Vehicle", // Label for the option
"value": "3", // Value associated with the option
"children": [
{
"label": "AV Test Vehicle",
"value": "3-1"
}
] // Nested children options for "Special Vehicle"
}
]
}
},
// Second input item within the slotChildren group, related to car events
{
"key": "select-[cd8ec]", // Unique identifier for this input item
"label": "Event of car", // Display name for this input
"type": "input", // Indicates it's an input item
"metadata": {
"hint": "Event of car" // Hint message to provide context about the input
},
"inputSpecification": {
"type": "nested-select", // Input type is nested selection
"items": [
{
"label": "Turning", // Label for the option
"value": "1", // Value associated with the option
"children": [
{
"label": "Left turning",
"value": "1-1"
},
{
"label": "Right turning",
"value": "1-2"
},
{
"label": "U-turn",
"value": "1-3"
}
] // Nested children options for "Turning"
},
{
"label": "Going straight",
"value": "2"
},
{
"label": "Applying the brakes",
"value": "3"
},
{
"label": "Overtaking",
"value": "4",
"children": [
{
"label": "Overtaking on the left",
"value": "4-1"
},
{
"label": "Overtaking on the right",
"value": "4-2"
}
] // Nested children options for "Overtaking"
}
]
}
}
]
}
]2D+3D fusion annotation
json
[
// Represents a nested annotation group (slotChildren) for a 3Dbox related to a vehicle
{
"key": "box3d-[6fa96]", // Unique identifier for this slotChildren item, indicating a 3Dbox
"label": "Vehicle in 3D", // Display name for this annotation group, specifying it's a 3D vehicle
"type": "slotChildren", // Indicates that this is a multi-layer nested annotation group
"slotSpecification": {
"customColor": "#3000F2", // Custom color for the 3Dbox
"type": "box3d", // The type of annotation is a 3Dbox
"imageSourceMapping": ["box2d-[fd7c0]"] // Mapping to the source 2Dbox (using its key), indicating a relationship between 2D and 3D
},
"children": [
// First item within the children, a 2Dbox slot related to the vehicle
{
"key": "box2d-[fd7c0]", // Unique identifier for this 2Dbox slot item
"label": "Vehicle in 2D", // Display name for this 2D annotation, specifying it's a 2D vehicle
"type": "slot", // Indicates that this is a single-layer annotation slot
"slotSpecification": {
"customColor": "#3000F2", // Custom color for the 2Dbox
"type": "box2d", // The type of annotation is a 2Dbox
"restrictInsideCanvasBoundary": true, // Restricts the annotation to be inside the canvas boundary
"topLeftMark": "1", // Mark for the top-left vertex of the 2Dbox
"topRightMark": "2", // Mark for the top-right vertex of the 2Dbox
"bottomRightMark": "3", // Mark for the bottom-right vertex of the 2Dbox
"bottomLeftMark": "4" // Mark for the bottom-left vertex of the 2Dbox
}
},
// Second item within the children, an input item related to car events
{
"key": "select-[cd8ec]", // Unique identifier for this input item
"label": "Event of car", // Display name for this input, indicating it's about car events
"type": "input", // Indicates that this is an input item
"inputSpecification": {
"type": "nested-select", // Input type is nested selection
"items": [
{
"label": "Turning", // Label for the option
"value": "1", // Value associated with the option
"children": [
{
"label": "Left turning",
"value": "1-1"
},
{
"label": "Right turning",
"value": "1-2"
},
{
"label": "U-turn",
"value": "1-3"
}
] // Nested children options for "Turning"
},
{
"label": "Going straight",
"value": "2"
},
{
"label": "Applying the brakes",
"value": "3"
},
{
"label": "Overtaking",
"value": "4",
"children": [
{
"label": "Overtaking on the left",
"value": "4-1"
},
{
"label": "Overtaking on the right",
"value": "4-2"
}
] // Nested children options for "Overtaking"
}
]
}
},
// Third item within the children, an input item related to vehicle types
{
"key": "select-[48520]", // Unique identifier for this input item
"label": "Type of vehicle", // Display name for this input, indicating it's about vehicle types
"type": "input", // Indicates that this is an input item
"inputSpecification": {
"type": "nested-select", // Input type is nested selection
"items": [
{
"label": "Passenger Car", // Label for the option
"value": "1", // Value associated with the option
"children": [
{
"label": "Sedan",
"value": "1-1"
},
{
"label": "SUV",
"value": "1-2"
},
{
"label": "MPV",
"value": "1-3"
}
] // Nested children options for "Passenger Car"
},
{
"label": "Commercial Vehicle", // Label for the option
"value": "2", // Value associated with the option
"children": [
{
"label": "Truck",
"value": "2-1"
},
{
"label": "Bus",
"value": "2-2"
},
{
"label": "Construction Vehicle",
"value": "2-3"
}
] // Nested children options for "Commercial Vehicle"
},
{
"label": "Special Vehicle", // Label for the option
"value": "3", // Value associated with the option
"children": [
{
"label": "AV Test Vehicle",
"value": "3-1"
}
] // Nested children options for "Special Vehicle"
}
]
}
}
]
}
]4D map annotation
json
[
// Represents a nested annotation group (slotChildren) for 3D lane lines
{
"key": "line3d-[d2b3a]", // Unique identifier for this slotChildren item, indicating a 3D line
"label": "Lane lines", // Display name for this annotation group
"type": "slotChildren", // Indicates it's a multi-layer nested annotation group
"slotSpecification": {
"customColor": "#0061F2", // Custom color for the 3D line
"type": "line3d" // Type of the annotation is a 3D line
},
"children": [
// Input item within the slotChildren group, related to the type of lane line
{
"key": "select-[c8545]", // Unique identifier for this input item
"label": "Type of lane line", // Display name for this input
"type": "input", // Indicates it's an input item
"inputSpecification": {
"type": "select", // Input type is single-select
"items": [
{
"label": "Solid White Line", // Label for the option
"value": "1" // Value associated with the option
},
{
"label": "Dashed White Line",
"value": "2"
},
{
"label": "Solid Yellow Line",
"value": "3"
},
{
"label": "Dashed Yellow Line",
"value": "4"
},
{
"label": "Double Solid White Lines",
"value": "5"
},
{
"label": "Double Solid Yellow Lines",
"value": "6"
},
{
"label": "Double Yellow Line (One Solid, One Dashed)",
"value": "7"
}
]
}
}
]
},
// Represents a single-layer annotation slot for the center line of a lane (3D line)
{
"key": "line3d-[80638]", // Unique identifier for this slot item
"label": "Center line of lane", // Display name for this annotation
"type": "slot", // Indicates it's a single-layer annotation slot
"slotSpecification": {
"customColor": "#00CC52", // Custom color for the 3D line
"type": "line3d" // Type of the annotation is a 3D line
}
},
// Represents a single-layer annotation slot for the stop line (3D line)
{
"key": "line3d-[f8e3c]", // Unique identifier for this slot item
"label": "Stop line", // Display name for this annotation
"type": "slot", // Indicates it's a single-layer annotation slot
"slotSpecification": {
"customColor": "#C200F2", // Custom color for the 3D line
"type": "line3d" // Type of the annotation is a 3D line
}
},
// Represents a single-layer annotation slot for a lane group with a stop line
{
"key": "group-[9b60d]", // Unique identifier for this slot item
"label": "Lane Group with Stop Line", // Display name for this annotation
"type": "slot", // Indicates it's a single-layer annotation slot
"metadata": {}, // No metadata information
"slotSpecification": {
"type": "group" // Specifies the type of the annotation as a group
}
},
// Represents a single-layer annotation slot for a traffic light (3Dbox)
{
"key": "box3d-[1abf2]", // Unique identifier for this slot item
"label": "Traffic light", // Display name for this annotation
"type": "slot", // Indicates it's a single-layer annotation slot
"slotSpecification": {
"customColor": "#0061F2", // Custom color for the 3Dbox
"type": "box3d" // Type of the annotation is a 3Dbox
},
"instanceOption": {} // No specific instance-related options set
},
// Represents a nested annotation group (slotChildren) for a 3D traffic sign (polygon)
{
"key": "polygon3d-[52655]", // Unique identifier for this slotChildren item, indicating a 3D polygon
"label": "Traffic sign", // Display name for this annotation group
"type": "slotChildren", // Indicates it's a multi-layer nested annotation group
"slotSpecification": {
"customColor": "#C200F2", // Custom color for the 3D polygon
"type": "polygon3d" // Type of the annotation is a 3D polygon
},
"children": [
// Input item within the slotChildren group, related to the type of traffic sign
{
"key": "select-[5d292]", // Unique identifier for this input item
"label": "Type of traffic sign", // Display name for this input
"type": "input", // Indicates it's an input item
"inputSpecification": {
"type": "select", // Input type is single-select
"items": [
{
"label": "Warning Signs", // Label for the option
"value": "1" // Value associated with the option
},
{
"label": "Prohibitory Signs",
"value": "2"
},
{
"label": "Mandatory Signs",
"value": "3"
},
{
"label": "Guide Signs",
"value": "4"
},
{
"label": "Work Zone Signs",
"value": "5"
}
]
}
}
]
}
]