Documentation Powered by ReDoc

Luna tasks (v.3.6.1)

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:

  • By documentation generation tools to visualize the API.
  • By code generation tools.

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".

version

get version

get version of service

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "Version": {
    }
}

tasks

get tasks

get tasks with filters

query Parameters
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 type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
task_status
integer (task_status)
Enum: 0 1 2 3 4 5
Example: task_status=1

task status

task status value
pending 0
in progress 1
cancelled 2
failed 3
collect results 4
done 5
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

get tasks count

get tasks count with filters

query Parameters
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 type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
task_status
integer (task_status)
Enum: 0 1 2 3 4 5
Example: task_status=1

task status

task status value
pending 0
in progress 1
cancelled 2
failed 3
collect results 4
done 5
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "count": 152
}

get task

get task by id

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
Example
1
1
2
3
4
5
6
7
8
9
{
  • "task_type": "1",
  • "content": {
    },
  • "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

cancel task by id

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
Example
bad_query_param
bad_query_param
task_can_not_canceled
{
  • "error_code": 12012,
  • "desc": "Bad/incomplete input data",
  • "detail": "Bad query parameters 'account_id'"
}

delete task

delete task by id

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "error_code": 12012,
  • "desc": "Bad/incomplete input data",
  • "detail": "Bad query parameters 'account_id'"
}

get task result

get task result by task id

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
application/json
application/zip
Example
gc_task_result
gc_task_result
clustering_task_result
linker_task_result
additional_extract_task_result
cross_match_task_result
roc_task_result
estimator_task_result
{
  • "result": [
    ],
  • "errors": [
    ]
}

get subtasks

get subtasks of task with filter(s)

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "subtasks": [
    ]
}

errors

get errors of task

get errors of task by task id

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

get error count of task

get task error count by task id with filters

path Parameters
task_id
required
integer (task_id) >= 1
Example: 123

task id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "count": 101
}

get errors

get errors with filters

query Parameters
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

task type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

get errors count

get errors count with filters

query Parameters
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 type value
unknown 0
linker 1
clusterization 2
report 3
garbage collect 4
additional extract 5
cross match 6
roc-curve calculation 7
export objects 8
estimate data 9
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "count": 101
}

get error

get error

path Parameters
error_id
required
integer (error_id)
Example: 10

error id

query Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
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"
}

task processing

create a new clustering task

Request to create a new clustering task

header Parameters
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.

Request Body schema: application/json
Any of
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.

Responses

Request samples

Content type
application/json
Example
event_clustering_task
event_clustering_task
face_clustering_task
{
  • "content": {
    },
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "clustering usefull faces"
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

exporter task

Collect objects of interest, returns zip archive with csv file and images (optional).

header Parameters
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.

Request Body schema: 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

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "task description",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

linker task

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

header Parameters
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.

Request Body schema: 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

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "linker task one",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

garbage collecting task

create new garbage collecting task

header Parameters
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.

Request Body schema: 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

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "gc task one",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

reporter task

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.

header Parameters
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.

Request Body schema: 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

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "report clasterization events from cam1",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

additional extract task

create new additional extract task, extraction of missing descriptors and base attributes is available.

header Parameters
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.

Request Body schema: 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.

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "additional extract usefull faces",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

cross matching task

Create cross matching task. Match references with candidates.

header Parameters
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.

Request Body schema: 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

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "matching famous people with customers",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

ROC-curve calculating task

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.

header Parameters
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.

Request Body schema: 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.

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "matching famous people with customers",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

estimator task

create new estimator task

header Parameters
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.

Request Body schema: 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

Responses

Request samples

Content type
application/json
{
  • "account_id": "346a5645-ec89-4806-820a-dbcb6e0dc381",
  • "description": "estimator task one",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": 123
}

documents

get openapi documentation

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

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "error_code": 12024,
  • "detail": "Bad/incomplete input data",
  • "desc": "Unsupported media type"
}

get development manual

Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "error_code": 1,
  • "detail": "internal server error",
  • "desc": "internal server error"
}

config

get service configuration

Get service configuration. Passwords and tokens will be hidden in the response.

header Parameters
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

Responses

Response samples

Content type
application/json
application/json
text/plain
{
  • "INFLUX_MONITORING": {
    }
}

health

get health

get health of service

query Parameters
include_luna_services
integer
Default: 0
Enum: 0 1

whether to perform healthchecks for dependent luna services.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0.123
}