Labeling profiles
Labeling profiles
Get all labeling profiles of a client
URL GET https://tools.deepen.ai/api/v2/clients/{clientId}/labelling_profiles
Request
Path parameters
clientId
string
Client Id obtained from Deepen AI
Response Returns a json with field ‘profiles’ that represents an array of LabellingProfileResource objects.
Create a new labelling profile for a client
URL
POST https://tools.deepen.ai/api/v2/clients/{clientId}/labelling_profiles
Request
Path parameters
clientId
string
Client Id obtained from Deepen AI
Request body
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
{
"profile_name": "testProfile",
"features": {
"box": {
"attributes": {},
"label_category_ids": []
},
"lane": {
"attributes": {},
"label_category_ids": []
},
"polygon": {
"attributes": {},
"label_category_ids": []
},
"point": {
"attributes": {},
"label_category_ids": []
},
"3d_bbox": {
"attributes": {},
"label_category_ids": [
"car"
],
"label_category_default_dimensions": {
"car": {
"width": 2.25,
"height": 2.25,
"length": 2.25
}
}
},
"3d_polyline": {
"attributes": {},
"label_category_ids": []
},
"3d_polygon": {
"attributes": {},
"label_category_ids": []
},
"3d_point": {
"attributes": {},
"label_category_ids": []
},
"3d_instance_point": {
"attributes": {},
"label_category_ids": []
}
},
"instructions": {
"text": ""
},
"notification_url": "",
"pipeline_spec": [
{
"stage_id": "Labelling",
"can_edit": true
},
{
"stage_id": "QA",
"can_edit": false
}
],
"preferences": {}
}Response
Returns a field ‘profile_id’ which contains the id of the newly created profile.
Get labeling profile using profile id
URL GET https://tools.deepen.ai/api/v2/labelling_profiles/{profileId}
Response Returns an instance of LabellingProfileResource.
Create a new labeling profile using profile id
URL POST https://tools.deepen.ai/api/v2/labelling_profiles/{profileId}
Request
Path parameters
profileId
string
Profile id of the profile to be created.
Request body
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
{
"profile_name": "testProfile",
"features": {
"box": {
"attributes": {},
"label_category_ids": []
},
"lane": {
"attributes": {},
"label_category_ids": []
},
"polygon": {
"attributes": {},
"label_category_ids": []
},
"point": {
"attributes": {},
"label_category_ids": []
},
"3d_bbox": {
"attributes": {},
"label_category_ids": [
"car"
],
"label_category_default_dimensions": {
"car": {
"width": 2.25,
"height": 2.25,
"length": 2.25
}
}
},
"3d_polyline": {
"attributes": {},
"label_category_ids": []
},
"3d_polygon": {
"attributes": {},
"label_category_ids": []
},
"3d_point": {
"attributes": {},
"label_category_ids": []
},
"3d_instance_point": {
"attributes": {},
"label_category_ids": []
}
},
"instructions": {
"text": ""
},
"notification_url": "",
"pipeline_spec": [
{
"stage_id": "Labelling",
"can_edit": true
},
{
"stage_id": "QA",
"can_edit": false
}
],
"preferences": {}
}Response Returns empty response on successful completion.
Delete a labelling profile using profile id
URL DELETE https://tools.deepen.ai/api/v2/labelling_profiles/{profileId}
Request
Path parameters
profileId
string
Profile id of the profile to be created.
Example body
Response Returns empty response on successful completion.
Last updated