Comment on page
Labeling profiles
Request
Path parameters
Parameter name | Parameter type | Description |
|---|---|---|
clientId | string | Client Id obtained from Deepen AI |
Response
Returns a json with field ‘profiles’ that represents an array of LabellingProfileResource objects.
URL
Request
Path parameters
Parameter name | Parameter type | Description |
|---|---|---|
clientId | string | Client Id obtained from Deepen AI |
Request body
Property name | Property type | Description |
|---|---|---|
profile_name | string | Name of the new profile |
instructions | string | |
features | Object | Type of labels, e,g : box, point, 3d_bbox, etc. |
auto_detect_objects_end_point | string | Endpoint of auto-detect object endpoint |
notification_url | string | |
pipeline_spec | Object | Pipeline stages |
preferences | Object | |
Example body
1
{
2
"profile_name": "testProfile",
3
"features": {
4
"box": {
5
"attributes": {},
6
"label_category_ids": []
7
},
8
"lane": {
9
"attributes": {},
10
"label_category_ids": []
11
},
12
"polygon": {
13
"attributes": {},
14
"label_category_ids": []
15
},
16
"point": {
17
"attributes": {},
18
"label_category_ids": []
19
},
20
"3d_bbox": {
21
"attributes": {},
22
"label_category_ids": [
23
"car"
24
],
25
"label_category_default_dimensions": {
26
"car": {
27
"width": 2.25,
28
"height": 2.25,
29
"length": 2.25
30
}
31
}
32
},
33
"3d_polyline": {
34
"attributes": {},
35
"label_category_ids": []
36
},
37
"3d_polygon": {
38
"attributes": {},
39
"label_category_ids": []
40
},
41
"3d_point": {
42
"attributes": {},
43
"label_category_ids": []
44
},
45
"3d_instance_point": {
46
"attributes": {},
47
"label_category_ids": []
48
}
49
},
50
"instructions": {
51
"text": ""
52
},
53
"notification_url": "",
54
"pipeline_spec": [
55
{
56
"stage_id": "Labelling",
57
"can_edit": true
58
},
59
{
60
"stage_id": "QA",
61
"can_edit": false
62
}
63
],
64
"preferences": {}
65
}
Response
Returns a field ‘profile_id’ which contains the id of the newly created profile.
Response
Returns an instance of LabellingProfileResource.
Request
Path parameters
Parameter name | Parameter type | Description |
|---|---|---|
profileId | string | Profile id of the profile to be created. |
Request body
Property name | Property type | Description |
|---|---|---|
profile_name | string | Name of the new profile |
instructions | string | |
features | Object | Type of labels, e,g : box, point, 3d_bbox, etc. |
auto_detect_objects_end_point | | |
notification_url | string | |
pipeline_spec | Object | Pipeline stages |
preferences | Object | |
Example body
1
{
2
"profile_name": "testProfile",
3
"features": {
4
"box": {
5
"attributes": {},
6
"label_category_ids": []
7
},
8
"lane": {
9
"attributes": {},
10
"label_category_ids": []
11
},
12
"polygon": {
13
"attributes": {},
14
"label_category_ids": []
15
},
16
"point": {
17
"attributes": {},
18
"label_category_ids": []
19
},
20
"3d_bbox": {
21
"attributes": {},
22
"label_category_ids": [
23
"car"
24
],
25
"label_category_default_dimensions": {
26
"car": {
27
"width": 2.25,
28
"height": 2.25,
29
"length": 2.25
30
}
31
}
32
},
33
"3d_polyline": {
34
"attributes": {},
35
"label_category_ids": []
36
},
37
"3d_polygon": {
38
"attributes": {},
39
"label_category_ids": []
40
},
41
"3d_point": {
42
"attributes": {},
43
"label_category_ids": []
44
},
45
"3d_instance_point": {
46
"attributes": {},
47
"label_category_ids": []
48
}
49
},
50
"instructions": {
51
"text": ""
52
},
53
"notification_url": "",
54
"pipeline_spec": [
55
{
56
"stage_id": "Labelling",
57
"can_edit": true
58
},
59
{
60
"stage_id": "QA",
61
"can_edit": false
62
}
63
],
64
"preferences": {}
65
}
Response
Returns empty response on successful completion.
Request
Path parameters
Parameter name | Parameter type | Description |
|---|---|---|
profileId | string | Profile id of the profile to be created. |
Example body
Response
Returns empty response on successful completion.
Last modified 6mo ago