Download OpenAPI specification:Download
VisionLabs Luna Tasks
OpenAPI specification is the only valid document providing up-to-date information about the service API.
The specification can be used:
All the documents and code generated using this specification can include inaccuracies and should be carefully checked.
OpenAPI specification can be received using the "/docs/spec" resource. The "Accept" header should be set to "application/x-yaml".
get version of service
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
{- "Version": {
- "api": 1,
- "major": 0,
- "minor": 0,
- "patch": 0
}
}get tasks with filters
| page | integer >= 1 Default: 1 a page number. | ||||||||||||||||||||||
| page_size | integer [ 1 .. 100 ] Default: 10 the number of items on page. | ||||||||||||||||||||||
| create_time__lt | string <date-time> Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time. | ||||||||||||||||||||||
| create_time__gte | string <date-time> Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time. | ||||||||||||||||||||||
| end_time__lt | string <date-time> Example: end_time__lt=2018-08-11T09:11:41.674Z upper bound for object end_time. | ||||||||||||||||||||||
| end_time__gte | string <date-time> Example: end_time__gte=2018-08-11T09:11:41.674Z lower included bound for object end_time. | ||||||||||||||||||||||
| task_ids | string <comma-separate task ids> (task_ids) Example: task_ids=1,2,3 comma-separate task ids | ||||||||||||||||||||||
| task_type | integer (task_type) Enum: 0 1 2 3 4 5 6 7 8 9 Example: task_type=1 task type
| ||||||||||||||||||||||
| task_status | integer (task_status) Enum: 0 1 2 3 4 5 Example: task_status=1 task status
| ||||||||||||||||||||||
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. | ||||||||||||||||||||||
| result_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: result_id=8f4f0070-c464-460b-bf78-fac225df72e9 id of task result, which stored in luna-image store. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "tasks": [
- {
- "task_type": 3,
- "content": {
- "create_list": 1,
- "list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "user_data": "100-00-12",
- "objects_type": "events",
- "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "user_data": "100-00-12",
- "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "face_id__gte": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__lt": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "list_id": "8950722f-3fd4-4223-b48f-03f95f0e8dfb"
}
}, - "task_id": 123,
- "create_time": "2021-07-28T01:23:21.537604+03:00",
- "end_time": "2018-08-11T10:11:41.674Z",
- "last_update_time": "2018-08-11T10:11:41.674Z",
- "task_status": 1,
- "result_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "count_task_parts_done": 10,
- "count_task_parts_all": 100,
- "description": "task description"
}
]
}get tasks count with filters
| create_time__lt | string <date-time> Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time. | ||||||||||||||||||||||
| create_time__gte | string <date-time> Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time. | ||||||||||||||||||||||
| end_time__lt | string <date-time> Example: end_time__lt=2018-08-11T09:11:41.674Z upper bound for object end_time. | ||||||||||||||||||||||
| end_time__gte | string <date-time> Example: end_time__gte=2018-08-11T09:11:41.674Z lower included bound for object end_time. | ||||||||||||||||||||||
| task_ids | string <comma-separate task ids> (task_ids) Example: task_ids=1,2,3 comma-separate task ids | ||||||||||||||||||||||
| task_type | integer (task_type) Enum: 0 1 2 3 4 5 6 7 8 9 Example: task_type=1 task type
| ||||||||||||||||||||||
| task_status | integer (task_status) Enum: 0 1 2 3 4 5 Example: task_status=1 task status
| ||||||||||||||||||||||
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "count": 152
}get task by id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
{- "task_type": "1",
- "content": {
- "create_list": 1,
- "list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "user_data": "100-00-12",
- "objects_type": "events",
- "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "user_data": "100-00-12",
- "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "face_id__gte": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__lt": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "list_id": "8950722f-3fd4-4223-b48f-03f95f0e8dfb"
}
}, - "task_id": 123,
- "create_time": "2021-07-28T01:23:21.537604+03:00",
- "end_time": "2018-08-11T10:11:41.674Z",
- "last_update_time": "2018-08-11T10:11:41.674Z",
- "task_status": 1,
- "result_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "count_task_parts_done": 10,
- "count_task_parts_all": 100,
- "description": "task description"
}cancel task by id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'"
}delete task by id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'"
}get task result by task id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "result": [
- "557d54ec-29ad-4f3c-93b4-c9092ef12515"
], - "errors": [
- {
- "error_id": 10,
- "task_id": 123,
- "subtask_id": 5,
- "error_code": 0,
- "description": "Faces not found",
- "detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
- "additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
- "error_time": "2021-07-28T01:23:21.537604+03:00"
}
]
}get subtasks of task with filter(s)
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "subtasks": [
- {
- "subtask_id": 5,
- "task_id": 123,
- "result_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "create_time": "2021-07-28T01:23:21.537604+03:00",
- "end_time": "2018-08-11T10:11:41.674Z",
- "subtask_status": 2,
- "content": "content"
}
]
}get errors of task by task id
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| page | integer >= 1 Default: 1 a page number. |
| page_size | integer [ 1 .. 100 ] Default: 10 the number of items on page. |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "errors": [
- {
- "error_id": 10,
- "task_id": 123,
- "subtask_id": 5,
- "error_code": 0,
- "description": "Faces not found",
- "detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
- "additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
- "error_time": "2021-07-28T01:23:21.537604+03:00"
}
]
}get task error count by task id with filters
| task_id required | integer (task_id) >= 1 Example: 123 task id |
| error_time__lt | string <date-time> Example: error_time__lt=2018-08-11T09:11:41.674Z upper bound for object error_time. |
| error_time__gte | string <date-time> Example: error_time__gte=2018-08-11T09:11:41.674Z lower included bound for object error_time. |
| error_code | integer (error_code) error code |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "count": 101
}get errors with filters
| page | integer >= 1 Default: 1 a page number. | ||||||||||||||||||||||
| page_size | integer [ 1 .. 100 ] Default: 10 the number of items on page. | ||||||||||||||||||||||
| task_ids | string <comma-separate task ids> (task_ids) Example: task_ids=1,2,3 comma-separate task ids | ||||||||||||||||||||||
| error_code | integer (error_code) error code | ||||||||||||||||||||||
| error_ids | string <comma-separate task ids> (errorIds) non-empty Example: error_ids=4,5,6 error ids | ||||||||||||||||||||||
| error_time__lt | string <date-time> Example: error_time__lt=2018-08-11T09:11:41.674Z upper bound for object error_time. | ||||||||||||||||||||||
| error_time__gte | string <date-time> Example: error_time__gte=2018-08-11T09:11:41.674Z lower included bound for object error_time. | ||||||||||||||||||||||
| task_type | integer (task_type) Enum: 0 1 2 3 4 5 6 7 8 9 Example: task_type=1 task type
| ||||||||||||||||||||||
| status_code | integer (status_code) [ 400 .. 599 ] Example: status_code=500 status code | ||||||||||||||||||||||
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "errors": [
- {
- "error_id": 10,
- "task_id": 123,
- "subtask_id": 5,
- "error_code": 0,
- "description": "Faces not found",
- "detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
- "additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
- "error_time": "2021-07-28T01:23:21.537604+03:00"
}
]
}get errors count with filters
| error_time__lt | string <date-time> Example: error_time__lt=2018-08-11T09:11:41.674Z upper bound for object error_time. | ||||||||||||||||||||||
| error_time__gte | string <date-time> Example: error_time__gte=2018-08-11T09:11:41.674Z lower included bound for object error_time. | ||||||||||||||||||||||
| task_type | integer (task_type) Enum: 0 1 2 3 4 5 6 7 8 9 Example: task_type=1 task type
| ||||||||||||||||||||||
| task_ids | string <comma-separate task ids> (task_ids) Example: task_ids=1,2,3 comma-separate task ids | ||||||||||||||||||||||
| error_ids | string <comma-separate task ids> (errorIds) non-empty Example: error_ids=4,5,6 error ids | ||||||||||||||||||||||
| error_code | integer (error_code) error code | ||||||||||||||||||||||
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "count": 101
}get error
| error_id required | integer (error_id) Example: 10 error id |
| account_id | string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=7daa0e35-36a2-474a-8f2b-87f78b59d080 account id. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
{- "error_id": 10,
- "task_id": 123,
- "subtask_id": 5,
- "error_code": 0,
- "description": "Faces not found",
- "detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
- "additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
- "error_time": "2021-07-28T01:23:21.537604+03:00"
}Request to create a new clustering task
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
required | object (clustering_task_content_events) Events clustering task content |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task. |
{- "content": {
- "objects_type": "events",
- "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "event_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "handler_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "top_similar_object_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "top_similar_external_ids": [
- "external_id_1",
- "external_id_2"
], - "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "sources": [
- "cam1",
- "cam2"
], - "cities": [
- "moscow",
- "New-York"
], - "areas": [
- "CAO",
- "central park"
], - "districts": [
- "mitino",
- "central park"
], - "streets": [
- "arbat",
- "schepkina"
], - "house_numbers": [
- "1",
- "1/2str3"
], - "track_ids": [
- "track_id_number_1",
- "track_id_number_2"
], - "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "end_time__gte": "2018-08-11T09:11:41.674Z",
- "end_time__lt": "2018-08-11T09:11:41.674Z",
- "event_id__gte": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
- "event_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
- "top_matching_candidates_label": "matching_label",
- "top_similar_object_similarity__gte": 0.5,
- "top_similar_object_similarity__lt": 0,
- "age__lt": 50,
- "age__gte": 50,
- "gender": 0,
- "emotions": [
- 1,
- 2,
- 3
], - "ethnic_groups": [
- 1,
- 2
], - "user_data": "100-00-12",
- "tags": [
- "tag1",
- "tag2"
], - "geo_position": {
- "origin_longitude": -180,
- "origin_latitude": -90,
- "longitude_delta": 0.1,
- "latitude_delta": 0.1
}, - "masks": [
- 2,
- 3
], - "liveness": [
- 1,
- 2
]
}, - "params": {
- "use_track_info": 0
}, - "threshold": 0.5,
- "descriptor": {
- "type": "face"
}, - "limit": 3
}, - "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "clustering usefull faces"
}{- "task_id": 123
}Collect objects of interest, returns zip archive with csv file and images (optional).
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string (task_description) <= 128 characters task description |
required | object (exporter_task_content) exporter task content |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "task description",
- "content": {
- "objects_type": "events",
- "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "end_time__gte": "2018-08-11T09:11:41.674Z",
- "end_time__lt": "2018-08-11T09:11:41.674Z",
- "sources": [
- "cam1",
- "cam2"
], - "event_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "event_id__gte": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
- "event_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
- "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "handler_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "top_matching_candidates_label": "matching_label",
- "top_similar_object_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "top_similar_external_ids": [
- "external_id_1",
- "external_id_2"
], - "top_similar_object_similarity__gte": 0.5,
- "top_similar_object_similarity__lt": 0,
- "age__lt": 50,
- "age__gte": 50,
- "gender": 0,
- "emotions": [
- 1,
- 2,
- 3
], - "ethnic_groups": [
- 1,
- 2
], - "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "user_data": "100-00-12",
- "tags": [
- "tag1",
- "tag2"
], - "cities": [
- "moscow",
- "New-York"
], - "areas": [
- "CAO",
- "central park"
], - "districts": [
- "mitino",
- "central park"
], - "streets": [
- "arbat",
- "schepkina"
], - "house_numbers": [
- "1",
- "1/2str3"
], - "geo_position": {
- "origin_longitude": -180,
- "origin_latitude": -90,
- "longitude_delta": 0.1,
- "latitude_delta": 0.1
}, - "masks": [
- 2,
- 3
], - "track_ids": [
- "track_id_number_1",
- "track_id_number_2"
], - "liveness": [
- 1,
- 2
]
}, - "columns": [
- "face_id",
- "user_data",
- "create_time"
], - "descriptor": {
- "type": "face"
}, - "csv_delimiter": "$",
- "save_images": 0
}
}{- "task_id": 123
}Create new linker task.
Task perfomance.
Firstly, it checks existence of specified list_id or create new list, if create_list parameter set to 1
It gets face ids from luna-faces or luna-events* with filters and pagination. Then forms one or several subtasks with 1000(or less) face ids for each, and save content for each subtask into luna-image-store.
For each subtask: it gets subtask content (list_id and face_ids from luna-image-store) and do request to luna-faces to link specified faces to specified list. Each subtask saves results to luna-image-store with its own result_id
After the last subtask is done, it collect results from all subtasks, merge and put them to luna-image store with new result_id (as task result)
* for luna-events:
get event with its descriptor from Luna Events
create face, attribute(s) and sample(s) in Luna Faces
link created face to the list
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task |
required | object (linker_task_content_both) linker task content |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "linker task one",
- "content": {
- "create_list": 1,
- "list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "user_data": "100-00-12",
- "objects_type": "events",
- "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "user_data": "100-00-12",
- "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "face_id__gte": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__lt": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "list_id": "8950722f-3fd4-4223-b48f-03f95f0e8dfb"
}
}
}{- "task_id": 123
}create new garbage collecting task
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string Default: "" provided user data for current task. |
required | any |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "gc task one",
- "content": {
- "target": "face_descriptors",
- "filters": {
- "descriptor_version": 0
}, - "store_results": true
}
}{- "task_id": 123
}Create report in csv format by a task. Now support only clasterization tasks for reporting. Report contains additional info about clusterization objects (faces or events). You can set which additional info set to the report. First and second columns in report always a number of cluster and an object id.
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task |
required | object (reporter_task_content) reporter task content |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "report clasterization events from cam1",
- "content": {
- "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "task_id": 146
}, - "columns": [
- "face_id",
- "user_data",
- "create_time"
], - "csv_delimiter": "$",
- "save_images": 0
}
}{- "task_id": 123
}create new additional extract task, extraction of missing descriptors and base attributes is available.
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task. |
required | any additional extractor task content. |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "additional extract usefull faces",
- "content": {
- "extraction_target": "basic_attributes",
- "options": {
- "missing": true,
- "descriptor_version": 0
}, - "filters": {
- "objects_type": "faces",
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__lt": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__gte": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
}
}{- "task_id": 123
}Create cross matching task. Match references with candidates.
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task |
required | object (cross_match_task_content) cross match task content |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "matching famous people with customers",
- "content": {
- "filters": {
- "reference_type": "faces",
- "candidate_type": "faces",
- "reference_filters": {
- "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "user_data": "100-00-12",
- "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "face_id__gte": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__lt": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "list_id": "8950722f-3fd4-4223-b48f-03f95f0e8dfb"
}, - "candidate_filters": {
- "face_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "external_ids": [
- "8950722f-3fd4-4223-b48f-03f95f0e8dfb",
- "346a5645-ec89-4806-820a-dbcb6e0dc381"
], - "user_data": "100-00-12",
- "create_time__gte": "2018-08-11T09:11:41.674Z",
- "create_time__lt": "2018-08-11T09:11:41.674Z",
- "face_id__gte": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "face_id__lt": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "list_id": "8950722f-3fd4-4223-b48f-03f95f0e8dfb"
}, - "descriptor": {
- "type": "face"
}, - "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}, - "threshold": 0.5,
- "limit": 3
}
}{- "task_id": 123
}create ROC task. ROC (or Receiver Operating Characteristic) is a performance measurement for classification problem at various thresholds settings. The ROC-curve is plotted with TPR (True Positive Rate) against the FPR (False Positive Rate). TPR is a true positive match pair count divided by a count of total expected positive match pairs, and FPR is a false positive match pair count divided by a count of total expected negative match pairs. Each point (FPR, TPR) of the ROC-cure corresponds to a certain similarity threshold. Using ROC the model performance is determined by looking at the area under the ROC-curve (or AUC) and the ROC-curve and the secondary main diagonal intersection point where type I and type II error rates are equal. The model performance also determined by getting into the top-N probability, i.e. probability of getting a positive match pair into the top-N for any match result group sorted by similarity.
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task. |
required | object (roc_task_content) roc task content. |
{- "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
- "description": "matching famous people with customers",
- "content": {
- "markup": [
- {
- "face_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "label": 12
}, - {
- "face_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "label": 12
}
], - "filters": {
- "account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}, - "threshold_hit_top": 0.95,
- "limit": 3,
- "key_FPRs": [
- 0.000001,
- 0.001
]
}
}{- "task_id": 123
}create new estimator task
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Content-Type | string Value: "application/json" content type is application/json. |
| account_id required | string <uuid> (task_account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... account id of the task |
| description | string provided user data for current task. |
required | object (estimator_task_content) estimator task content |
{- "description": "estimator task with zip archive",
- "content": {
- "handler": {
- "handler_id": "c42ad7cb-9078-4be4-8457-4d3c744477df"
}, - "source": {
- "source_type": "zip",
- "authorization": {
- "password": 123456
}, - "image_type": 1
}, - "filters": {
- "account_id": "c42ad7cb-9078-4be4-8457-4d3c744477df"
}
}
}{- "task_id": 123
}Get service OpenApi documentation. If Accept request header is of type application/x-yaml,
returns documentation in yaml format or returns html documentation, if Accept-Type is text/html
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Accept required | string (accept_docs_handler) Enum: "application/x-yaml" "text/html" acceptable type of receiving data |
{- "error_code": 12024,
- "detail": "Bad/incomplete input data",
- "desc": "Unsupported media type"
}Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
{- "error_code": 1,
- "detail": "internal server error",
- "desc": "internal server error"
}Get service configuration. Passwords and tokens will be hidden in the response.
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
| Accept | string Enum: "application/json" "text/plain" acceptable type of receiving data |
{- "INFLUX_MONITORING": {
- "SEND_DATA_FOR_MONITORING": 0,
- "VERSION": 2,
- "ORGANIZATION": "ORGANIZATION_NAME",
- "TOKEN": "********",
- "BUCKET": "luna_monitoring",
- "HOST": "127.0.0.1",
- "PORT": 8086,
- "USE_SSL": 0,
- "FLUSHING_PERIOD": 1
}
}get health of service
| include_luna_services | integer Default: 0 Enum: 0 1 whether to perform healthchecks for dependent luna services. |
| Luna-Request-Id | string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response. |
{- "execution_time": 0.123
}