Luna-Python-Matcher (v.1.1.20)

Download OpenAPI specification:Download

VisionLabs Luna Python Matcher.

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 service version

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

200
500

Content type

application/json

{"Version": {"api": 1,
"major": 0,
"minor": 0,
"patch": 0
}
}

matcher

face matching

Matcher API allows to submit tasks to a service that searches for faces similar to a given reference(s) by matching them. A face attribute descriptor should be extracted for reference(s) and candidate(s).

The sources for references are events, attributes, faces or binary descriptor. The sources for candidates are faces, events or attributes.

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=8950722f-3fd4-4223-b48f-03f95f0e8dfb

account id

header Parameters

Content-Type	string Enum: "application/json" "application/msgpack" Format of a request body data
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.

Request Body schema: application/json

required	Array of face_reference (object) or external_face_reference (object) or attribute_reference (object) or event_reference (object) or external_event_reference (object) or track_event_reference (object) or xpk_reference (object) or sdk_descriptor_reference (object) or raw_descriptor_reference (object) [ 1 .. 30 ] items reference list for matching
required	Array of candidate_face (object) or candidate_event (object) or candidate_attribute (object) [ 1 .. 30 ] items candidates for matching

Responses

Request samples

Payload

Content type

application/json

{"references": [{"type": "face",
"id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
],
"candidates": [{"filters": {"origin": "faces",
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"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": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"face_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"order": "similarity",
"limit": 3,
"targets": ["face_id",
"account_id",
"event_id",
"user_data",
"create_time",
"external_id",
"avatar",
"lists",
"similarity"
],
"threshold": 0
}
]
}

Response samples

200
400
403
500
504

Content type

application/json

[{"reference": {"id": "ea555d8a-9db1-4129-8221-6b125b3b7d5a",
"type": "descriptor",
"face_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"matches": [{"filters": {"origin": "faces",
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"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": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"face_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"result": [{"similarity": 0.5,
"face": {"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"user_data": "fox1991",
"create_time": "2018-08-11T09:11:41.674Z",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d",
"6d037c33-31ec-4d73-b3b3-ec80b09446c2"
],
"avatar": "https://st.kp.yandex.net/images/actor_iphone/iphone360_460188.jpg",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256"
}
}
]
}
]
}
]

human body matching

Matcher API allows to submit tasks to a service that searches for human bodies similar to a given reference(s) by matching them. A body attribute descriptor should be extracted for reference(s) and candidate(s).

The sources for references are events or binary descriptor. The sources for candidates is events.

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=8950722f-3fd4-4223-b48f-03f95f0e8dfb

account id

header Parameters

Content-Type	string Enum: "application/json" "application/msgpack" Format of a request body data
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.

Request Body schema: application/json

required	Array of event_reference (object) or external_event_reference (object) or track_event_reference (object) or sdk_descriptor_reference (object) or raw_descriptor_reference (object) [ 1 .. 30 ] items reference list for matching
required	Array of objects (candidate_event) [ 1 .. 30 ] items candidates for matching

Responses

Request samples

Payload

Content type

application/json

{"references": [{"type": "event",
"id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
],
"candidates": [{"filters": {"origin": "events",
"event_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__gte": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"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",
"handler_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_matching_candidates_label": "good guys",
"top_similar_object_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"top_similar_external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_similar_object_similarity__gte": 0.5,
"top_similar_object_similarity__lt": 0.5,
"age__gte": 50,
"age__lt": 50,
"gender": 0,
"emotions": [1,
2,
4
],
"masks": "2,3",
"ethnic_groups": [1
],
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"user_data": "100-00-12",
"sources": ["cam1",
"cam2"
],
"tags": ["tag1",
"tag2"
],
"cities": ["moscow",
"New-York"
],
"areas": ["area1",
"area2"
],
"districts": ["mitino",
"central park"
],
"streets": ["arbat, schepkina"
],
"house_numbers": ["1",
"1/2str3"
],
"geo_position": {"origin_longitude": 0,
"origin_latitude": 0,
"longitude_delta": 0.01,
"latitude_delta": 0.01
},
"track_ids": ["useful_track_id_number_1"
],
"liveness": [0
],
"apparent_gender": [1
],
"apparent_age__gte": 50,
"apparent_age__lt": 50,
"headwear_states": [1
],
"sleeve_lengths": ["short"
],
"upper_clothing_colors": ["black",
"white"
],
"backpack_states": [1
]
},
"order": "similarity",
"limit": 3,
"targets": ["event_id",
"account_id",
"create_time",
"end_time",
"external_id",
"handler_id",
"source",
"top_match",
"match_result",
"face_detections",
"body_detections",
"face_id",
"attach_result",
"gender",
"age",
"emotion",
"ethnic_group",
"tags",
"user_data",
"location",
"similarity",
"mask",
"track_id",
"liveness",
"body_basic_attributes",
"upper_body",
"accessories"
],
"threshold": 0
}
]
}

Response samples

200
400
403
500
504

Content type

application/json

[{"reference": {"id": "ea555d8a-9db1-4129-8221-6b125b3b7d5a",
"type": "descriptor",
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"matches": [{"filters": {"origin": "events",
"event_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__gte": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"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",
"handler_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_matching_candidates_label": "good guys",
"top_similar_object_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"top_similar_external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_similar_object_similarity__gte": 0.5,
"top_similar_object_similarity__lt": 0.5,
"age__gte": 50,
"age__lt": 50,
"gender": 0,
"emotions": [1,
2,
4
],
"masks": "2,3",
"ethnic_groups": [1
],
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"user_data": "100-00-12",
"sources": ["cam1",
"cam2"
],
"tags": ["tag1",
"tag2"
],
"cities": ["moscow",
"New-York"
],
"areas": ["area1",
"area2"
],
"districts": ["mitino",
"central park"
],
"streets": ["arbat, schepkina"
],
"house_numbers": ["1",
"1/2str3"
],
"geo_position": {"origin_longitude": 0,
"origin_latitude": 0,
"longitude_delta": 0.01,
"latitude_delta": 0.01
},
"track_ids": ["useful_track_id_number_1"
],
"liveness": [0
],
"apparent_gender": [1
],
"apparent_age__gte": 50,
"apparent_age__lt": 50,
"headwear_states": [1
],
"sleeve_lengths": ["short"
],
"upper_clothing_colors": ["black",
"white"
],
"backpack_states": [1
]
},
"result": [{"similarity": 0.5,
"event": {"create_time": "2018-08-11T09:11:41.674Z",
"end_time": "2018-08-11T09:11:41.674Z",
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"handler_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"source": "3rd Avenue",
"top_match": {"label": "good guys",
"similarity": 0.5,
"face_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"external_id": "2xQ2gprbMUePw1s9gw9fvA=="
},
"match_result": [{"label": "good guys",
"candidates": [{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"user_data": "fox1991",
"create_time": "2018-08-11T09:11:41.674Z"
}
]
}
],
"face_detections": [{"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"detection": {"rect": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
},
"detect_time": "2018-08-11T09:11:41.674Z",
"image_origin": "/6/images/b668c4a5-2191-476e-a261-3b4f9ce2e25e"
}
],
"body_detections": [{"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"detection": {"rect": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
},
"detect_time": "2018-08-11T09:11:41.674Z",
"image_origin": "/6/images/b668c4a5-2191-476e-a261-3b4f9ce2e25e"
}
],
"face_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"attach_result": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"gender": 0,
"age": 50,
"emotion": 1,
"mask": 1,
"track_id": "useful_track_id_number_1",
"ethnic_group": 1,
"tags": ["tag1",
"tag2"
],
"user_data": "100-00-12",
"location": {"city": "Moscow",
"area": "CAO",
"district": "Arbat",
"street": "Arbat",
"house_number": "3",
"geo_position": {"longitude": 36.616,
"latitude": 55.752
}
},
"liveness": 0,
"body_basic_attributes": {"apparent_age": 0,
"apparent_gender": 0
},
"upper_body_attributes": {"headwear": {"state": 0
},
"sleeve": {"length": "short"
},
"upper_clothing": {"colors": [null
]
}
},
"body_accessories": {"backpack": {"state": 0
}
}
}
}
]
}
]
}
]

raw matching

Matcher raw API allows to do similarity calculations for input descriptors.

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=8950722f-3fd4-4223-b48f-03f95f0e8dfb

account id

header Parameters

Content-Type	string Enum: "application/json" "application/msgpack" Format of a request body data
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.

Request Body schema:
application/json
application/json
application/msgpack

required	Array of xpk_file_entity (object) or sdk_descriptor_entity (object) or raw_descriptor_entity (object) non-empty reference list for matching
required	Array of xpk_file_entity (object) or sdk_descriptor_entity (object) or raw_descriptor_entity (object) non-empty candidates for matching

Responses

Request samples

Payload

Content type

{"references": [{"id": "string",
"type": "xpk_file",
"data": "string"
}
],
"candidates": [{"id": "string",
"type": "xpk_file",
"data": "string"
}
]
}

Response samples

201
400
403
500

Content type

application/json

{"matches": [{"reference_id": "ea555d8a-9db1-4129-8221-6b125b3b7d5a",
"matches": [{"candidate_id": "ea555d8a-9db1-4129-8221-6b125b3b7d5a",
"similarity": 0.5
}
]
}
]
}

crossmatcher

cross matching faces

Cross Matcher API allows to submit tasks to a service that searches for faces/events by given filters and match all of them one with the other. Limit for references and canidates for each matching is 100000 objects.

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=8950722f-3fd4-4223-b48f-03f95f0e8dfb account id
sorting	integer Default: 1 Enum: 0 1 whether to sort match results lexicografically

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.

Request Body schema: application/json

required	cross_match_face_filters (object) or cross_match_event_filters (object) or cross_match_attribute_filters (object) references for matching filters
required	cross_match_face_filters (object) or cross_match_event_filters (object) or cross_match_attribute_filters (object) candidates for matching filters
limit	integer (cross_match_limit) [ 1 .. 20000 ] Default: 20000 count of cross match results for each reference.
threshold	number (threshold) [ 0 .. 1 ] Default: 0 matching similarity threshold

Responses

Request samples

Payload

Content type

application/json

{"references": {"origin": "faces",
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"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": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"face_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"candidates": {"origin": "faces",
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"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": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"face_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"limit": 20000,
"threshold": 0
}

Response samples

400
403
500
504

Content type

application/json

Example

{"error_code": 12017,
"desc": "Bad/incomplete input data",
"detail": "Bad content type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
}

cross matching bodies

Cross Matcher API allows to submit tasks to a service that searches for faces/events by given filters and match all of them one with the other. Limit for references and canidates for each matching is 100000 objects.

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=8950722f-3fd4-4223-b48f-03f95f0e8dfb account id
sorting	integer Default: 1 Enum: 0 1 whether to sort match results lexicografically

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.

Request Body schema: application/json

required	object references for matching filters
required	object candidates for matching filters
limit	integer (cross_match_limit) [ 1 .. 20000 ] Default: 20000 count of cross match results for each reference.
threshold	number (threshold) [ 0 .. 1 ] Default: 0 matching similarity threshold

Responses

Request samples

Payload

Content type

application/json

{"references": {"origin": "events",
"event_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__gte": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"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",
"handler_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_matching_candidates_label": "good guys",
"top_similar_object_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"top_similar_external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_similar_object_similarity__gte": 0.5,
"top_similar_object_similarity__lt": 0.5,
"age__gte": 50,
"age__lt": 50,
"gender": 0,
"emotions": [1,
2,
4
],
"masks": "2,3",
"ethnic_groups": [1
],
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"user_data": "100-00-12",
"sources": ["cam1",
"cam2"
],
"tags": ["tag1",
"tag2"
],
"cities": ["moscow",
"New-York"
],
"areas": ["area1",
"area2"
],
"districts": ["mitino",
"central park"
],
"streets": ["arbat, schepkina"
],
"house_numbers": ["1",
"1/2str3"
],
"geo_position": {"origin_longitude": 0,
"origin_latitude": 0,
"longitude_delta": 0.01,
"latitude_delta": 0.01
},
"track_ids": ["useful_track_id_number_1"
],
"liveness": [0
],
"apparent_gender": [1
],
"apparent_age__gte": 50,
"apparent_age__lt": 50,
"headwear_states": [1
],
"sleeve_lengths": ["short"
],
"upper_clothing_colors": ["black",
"white"
],
"backpack_states": [1
]
},
"candidates": {"origin": "events",
"event_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__gte": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"event_id__lt": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"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",
"handler_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_matching_candidates_label": "good guys",
"top_similar_object_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"top_similar_external_ids": ["2xQ2gprbMUePw1s9gw9fvA=="
],
"top_similar_object_similarity__gte": 0.5,
"top_similar_object_similarity__lt": 0.5,
"age__gte": 50,
"age__lt": 50,
"gender": 0,
"emotions": [1,
2,
4
],
"masks": "2,3",
"ethnic_groups": [1
],
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"user_data": "100-00-12",
"sources": ["cam1",
"cam2"
],
"tags": ["tag1",
"tag2"
],
"cities": ["moscow",
"New-York"
],
"areas": ["area1",
"area2"
],
"districts": ["mitino",
"central park"
],
"streets": ["arbat, schepkina"
],
"house_numbers": ["1",
"1/2str3"
],
"geo_position": {"origin_longitude": 0,
"origin_latitude": 0,
"longitude_delta": 0.01,
"latitude_delta": 0.01
},
"track_ids": ["useful_track_id_number_1"
],
"liveness": [0
],
"apparent_gender": [1
],
"apparent_age__gte": 50,
"apparent_age__lt": 50,
"headwear_states": [1
],
"sleeve_lengths": ["short"
],
"upper_clothing_colors": ["black",
"white"
],
"backpack_states": [1
]
},
"limit": 20000,
"threshold": 0
}

Response samples

400
403
500
504

Content type

application/json

Example

{"error_code": 12017,
"desc": "Bad/incomplete input data",
"detail": "Bad content type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
}

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

415
500

Content type

application/json

{"error_code": 12024,
"detail": "Bad/incomplete input data",
"desc": "Unsupported media type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
}

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

500

Content type

application/json

{"error_code": 1,
"detail": "Internal server error",
"desc": "Internal server error",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
}

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

200
415
500

Content type

{"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
}
}

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

200
500
502

Content type

application/json

{"execution_time": 0.123
}

Luna-Python-Matcher (v.1.1.20)

version

get version

header Parameters

Responses

Response samples

matcher

face matching

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

human body matching

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

raw matching

query Parameters

header Parameters

Request Body schema: application/jsonapplication/jsonapplication/msgpack

Responses

Request samples

Response samples

crossmatcher

cross matching faces

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

cross matching bodies

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

documents

get openapi documentation

header Parameters

Responses

Response samples

get development manual

header Parameters

Responses

Response samples

config

get service configuration

header Parameters

Responses

Response samples

health

get health

query Parameters

header Parameters

Responses

Response samples

Request Body schema:
application/json
application/json
application/msgpack