Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General request format:

POST httpPOST http://localhostIP-address:10000port/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/GetAnalitycJSON parameters:

Code Block
{
 "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"
 ]
}

where:

  • server_id is the identifier of the Face Recognition Server in Face Intellect (see Configuring the Face Recognition Server object);
  • minAge is the minimum age of persons whose data should be obtained;
  • maxAge is the maximum age of persons whose data should be obtained;
  • dateTimeFrom is the time in UTC format, starting from which the data should be obtained;
  • dateTimeTo is the time in UTC format, up to which the data should be obtained;
  • genders is the gender of persons whose data should be obtained: 0 - Unknown, 1 - Males, 2 - Females;
  • faceMode is the type of persons whose data should be obtained: 0 - all faces, 1 - only recognized faces, 2 - only unrecognized faces;

  • threshold is the threshold value of the faces similarity degree;

  • minPasses is the filter by the minimum number of passes;

  • maxPasses is the filter by the maximum number of passes;

  • cameraIds is the camera IDs in Face Intellect (see Creating and configuring the Camera object).

Response example:

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:

Expand


Code Block
{
 "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": "
13
John",
 "Surname": "
Johnson
Wick",
 "Patronymic": "",
 "Department": "
0
Department 1",
 "Comment": "",
 "
Sim
Timestamp": 
0.550095 }
"2021-06-25T10:39:55.974",
 "
LikePasses
ImageId": 
[
"98B73FA9-A1D5-EB11-AC0A-B42E999B6711",
 
{
"
Id
AutoCreated": 
"1E1483A5-41BB-E811-8D01-005056C00008"
false,
 "
Timestamp
LastRecognitionTimestamp": "
2018
2021-
09
06-
18T12
25T11:59:52
:08
.
987
185",
 "
Gender
RecognitionCount": 
1
375,
 "
Age
revisions": 
31.4372,
[
 
"Camera": "1" },
       {
         "
Id
source": "
F10CD78D
8A91CD97-
41BB
62D3-
E811
EB11-
8D01
AC0A-
005056C00008
B42E999B6711",
         "
Timestamp
revision": "
2018-09-18T12:51:33.907", "Gender": 1, "Age": 31.4372
97B73FA9-A1D5-EB11-AC0A-B42E999B6711"
        }
 "Sim": 0.850095
 },
 "
Camera
LikePasses": 
"1" },
[
 {
 "Id": "
60438F6B
1E1483A5-41BB-E811-8D01-005056C00008",
 "Timestamp": "2018-09-18T12:
50
52:
33
08.
901
987",
 "Gender": 1,
 "Age": 31.4372,
 "Camera": "1"
 },
 {
 "Id": "
924A4A46
F10CD78D-41BB-E811-8D01-005056C00008",
 "Timestamp": "2018-09-18T12:
49
51:33.
868
907",
 "Gender": 1,
 "Age": 31.4372,
 "
Camera
Temperature": 0,
 "
1
Emotion"
: 
}
5,
{
 "Glasses": 2,
 "
Id
FacialHair": 6,
 "
E9990024-41BB-E811-8D01-005056C00008"
HairColor": 1,
 "
Timestamp
HairType": 
"2018-09-18T12:48:33.839"
3,
 "
Gender
Headwear": 
1
13,
 "
Age
Liveness": 
31.4372
1,
 "
Camera
Evasion": 
"
1
"

 }
 ],
 "Total": 40,
 "Males": 40,
 "Females": 0
 }
 ],
 "ProcessedTotal": 1346,
 "ProcessedDuration": 83,
 "CompareCount": 18555,
 "
Responce
Response": {
 "Status": "SUCCESS"
 }
}

where:

...


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

...

CompareCount

...

Total number of the face comparisons

...

ResponseResponse
StatusCompleted request status: SUCCESS successful, if error see List of possible errors of the Face Recognition Server