Face Recognition
This API will be deprecated in June 1st 2021. Please consider to use Sync V2
Send a POST request to https://api.cloud.nodeflux.io/v1beta1/image-analytic/stream by providing these arguments as application/json.

Headers

Key
Value
Content-type
application/json
Authorization
Your authorization key.
x-nodeflux-timestamp
x-nodeflux-timestamp from the Authorization API.

Request Body

{
"analytics": [
{
"type": "FACE_RECOGNITION",
"options": {
"@type": "type.googleapis.com/nodeflux.analytics.v1beta1.FaceRecognitionOptions",
"candidateCount": 2
}
}
],
"image": {
"encoding": "IMAGE_ENCODING_JPEG",
"content": "{INSERT_JPEG_IMAGE_AS_BASE64_STRING}"
}
}

Response Body

HTTP Mapping: 200 OK
{
"result": {
"face_recognitions": [
{
"candidates": [
{
"face_id":"30604573299179521",
"confidence": 1,
"auto_enrolled": false,
"similarity": 1,
"variation":"17952130604573299"
},
{
"face_id":"30604573299175432",
"confidence": 0.81,
"auto_enrolled": false,
"similarity": 0.81,
"variation":"17952130604573292"
}
]
}
]
}
}
!!! warning "Confidence Field"
Confidence field deprecated, use field `similarity` instead.
!!! warning "Variation Value"
`variation` value is `variation` associated with enrolled face, not `variation` associated with requested face to recognize.
!!! warning "Candidate Value"
Maximum number of `candidateCount` value is `5`.
!!! info "Protocol Reference"
Protocol reference available on [nodeflux.analytics.v1beta1.FaceRecognition](../../protocol/analytics#nodeflux.analytics.v1beta1.FaceRecognition)
Export as PDF
Copy link