Documentation for Face Intellect 8.0-8.1. Documentation for other versions of Intellect is available too.

Previous page Getting image by ID  Getting analytic data by time Next page

General request format:

POST http://IP-address:port/firserver/GetAnalityc

Request parameters:

ParameterRequiredParameter description
server_idYesIdentifier of the Face Recognition Server in Face-Intellect
minAgeNoMinimum age of persons
maxAge NoMaximum age of persons
dateTimeFrom YesTime in UTC+0 format, starting from which the data should be obtained
dateTimeTo YesTime in UTC+0 format, up to which the data should be obtained
genders NoGender of persons whose data should be obtained: 0 Unknown, 1 Males, 2 Females
faceModeNoType of persons whose data should be obtained: 0 all faces, 1 only recognized faces, 2 only unrecognized faces
thresholdNoThreshold value of the faces similarity degree
minPassesNoFilter by the minimum number of passes
maxPassesNoFilter by the maximum number of passes
cameraIds NoCamera IDs in Face-Intellect

Request example:

POST http://127.0.0.1:10000/firserver/GetAnalityc

{
 "server_id": "1",
 "minAge": 0,
 "maxAge": 1000,
 "dateTimeFrom": "2018-08-17T21:00:00.000",
 "dateTimeTo": "2018-09-18T20:59:59.000",
 "genders": [
 0,
 1,
 2
 ],
 "faceMode": 0,
 "threshold": 0.8,
 "minPasses": 1,
 "maxPasses": 10000,
 "cameraIds": [
 "1"
 ]
}

Request headlines:

Headline

Headline description

AllowReturns the HTTP method used in request
Content-LengthShows the size of characters in bytes, received in the request
Content-TypeReturns the type of received request
ServerSpecifies the server from which the request comes
Access-Control-Request-MethodReturns the HTTP method that can be used in the request
Access-Control-OriginIndicates if the code that sends the request from this source can access the server response
DateShows the time of the request

Response example:

{
 "PassAndLikesList": [
 {
 "MainPass": {
 "Id": "53952CAF-3BBB-E811-8D01-005056C00008",
 "Timestamp": "2018-09-18T12:09:32.848",
 "Camera": "1",
 "Gender": 1,
 "Age": 31.4502
 },
 "BestPerson": {
 "Id": "5CC71799-48BB-E811-8D01-005056C00008",
 "Name": "John",
 "Surname": "Wick",
 "Patronymic": "",
 "Department": "Department 1",
 "Comment": "",
 "Timestamp": "2021-06-25T10:39:55.974",
 "ImageId": "98B73FA9-A1D5-EB11-AC0A-B42E999B6711",
 "AutoCreated": false,
 "LastRecognitionTimestamp": "2021-06-25T11:59:52.185",
 "RecognitionCount": 375,
 "revisions": [
        {
         "source": "8A91CD97-62D3-EB11-AC0A-B42E999B6711",
         "revision": "97B73FA9-A1D5-EB11-AC0A-B42E999B6711"
        }
 "Sim": 0.850095
 },
 "LikePasses": [
 {
 "Id": "1E1483A5-41BB-E811-8D01-005056C00008",
 "Timestamp": "2018-09-18T12:52:08.987",
 "Gender": 1,
 "Age": 31.4372,
 "Camera": "1"
 },
 {
 "Id": "F10CD78D-41BB-E811-8D01-005056C00008",
 "Timestamp": "2018-09-18T12:51:33.907",
 "Gender": 1,
 "Age": 31.4372,
 "Temperature": 0,
 "Emotion": 5,
 "Glasses": 2,
 "FacialHair": 6,
 "HairColor": 1,
 "HairType": 3,
 "Headwear": 13,
 "Liveness": 1,
 "Evasion": 1
 }
 ],
 "Total": 40,
 "Males": 40,
 "Females": 0
 }
 ],
 "ProcessedTotal": 1346,
 "ProcessedDuration": 83,
 "CompareCount": 18555,
 "Response": {
 "Status": "SUCCESS"
 }
}

Response parameters:

ParameterParameter description
PassAndLikesListList of passes of unique faces
MainPassData on the first pass of a unique face (for more details, see Getting the recognition protocol)
BestPersonData about the face from the face database and the degree of similarity of the reference face with a unique face, if such a person exists (for more details, see Getting information about users)
TimestampTime of adding a face to the reference face database in UTC+0 format
ImageIdIdentifier of the reference face image from the faces database
AutoCreated

true if the unrecognized face was added automaticallyи. false if it was added manually

LastRecognitionTimestampTime of the last pass in UTC+0 format
RecognitionCountNumber of passes
LikePassesList with data of similar passes (similar to MainPass). Cannot be larger than 5 elements
TemperatureFacial temperature in degrees Celsius
Emotion

Emotion: 0 undefined, 1 rage, 2 fear, 3 happiness, 4 without emotion, 5 sadness, 6 astonishment

Glasses

Glasses: 0 undefined, 1 tinted glasses, 2 without glasses, 3 glasses

FacialHair

Facial hair: 0 undefined; 1 beard, 2 bristle, 3 imperial beard and mustache, 4 imperial beard, 5 mustache, 6  absent

HairColor

Hair color0 — undefined1 — brunet2 — blonde3 — chestnut hair4 — ginger5 — gray

HairTypeType of bald head: 0 undefined1 bald, 2 with receding hairline, 3 without bald head
HeadwearHeadwear: 0 undefined1 cap, 2 bandana, 3 beret, 4 beanie, 5 trapper hat, 6 fur hood, 7 glasses on head, 8 hat, 9 helmet, 10 hood, 11 kepi, 12 headscarf, 13 without headwear, 14 peaky cap
LivenessArtificial face: 0  undefined1 no, 2 yes
Evasion

Face concealment: 0 undefined, 1 face not covered, 2 mask is on, 3 tinted glasses, 4 face partially covered, 5 balaclava, 6 other mask, 7 mask is not on the right place

TotalTotal number of unique faces
MalesNumber of males
FemalesNumber of females
ProcessedTotal

Total number of processed faces

ProcessedDurationExecution time of the faces processing in milliseconds
CompareCountTotal number of the face comparisons
ResponseResponse
StatusCompleted request status: SUCCESS successful, if error see List of possible errors of the Face Recognition Server
  • No labels