- 产品简介
- 购买指南
- 操作指南
- API 文档
- FACEID Recognition 政策
- 产品简介
- 购买指南
- 操作指南
- API 文档
- FACEID Recognition 政策
1. API Description
Domain name for API request: iai.intl.tencentcloudapi.com.
Compare the faces in the two pictures for similarity and return the face similarity score. If you need to determine "whether this person is someone", that is, to verify whether the person in a picture is someone with a known identity, such as a common face login scenario, it is recommended to use [VerifyFace] (https://www.tencentcloud.com/document/product/1059/36972) or [VerifyPerson] (https://www.tencentcloud.com/document/product/1059/36971) inferface.
Please use the V3 version for the signature method in the public parameters, that is, configure the SignatureMethod parameter to TC3-HMAC-SHA256
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DetectFaceSimilarity. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-03. |
| Region | No | String | Common Params. This parameter is not required. |
| ImageA | No | String | A image base64 data. - The size after base64 encoding cannot exceed 5M. - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels. - If the picture contains multiple faces, only the face with the highest confidence is selected. - Supports PNG, JPG, JPEG, BMP, but does not support GIF images. |
| ImageB | No | String | B image base64 data. - The size after base64 encoding cannot exceed 5M. - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels. - If the picture contains multiple faces, only the face with the highest confidence is selected. - Supports PNG, JPG, JPEG, BMP, but does not support GIF images. |
| UrlA | No | String | A URL for the image. - The size of the corresponding image after base64 encoding cannot exceed 5M. - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels. - A The URL and Image of the picture must be provided. If both are provided, only the Url will be used. - Images stored in Tencent Cloud's Url can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud. - The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent. - If the picture contains multiple faces, only the face with the largest face area is selected. - Supports PNG, JPG, JPEG, BMP, but does not support GIF images. |
| UrlB | No | String | B The URL of the image. - The size of the corresponding image after base64 encoding cannot exceed 5M. - The long side pixels of jpg format cannot exceed 4000, and the long side pixels of pictures in other formats cannot exceed 2000. The short side of images in all formats must be no less than 64 pixels. - B The URL and Image of the picture must be provided. If both are provided, only the Url will be used. - Images stored in Tencent Cloud's Url can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud. - The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent. - If the picture contains multiple faces, only the face with the largest face area is selected. - Supports PNG, JPG, JPEG, BMP, but does not support GIF images. |
| QualityControl | No | Integer | Image quality control. - Value range: 0: No control; 1: Lower quality requirements, the image is very blurry, and the eyes, nose, and mouth cover at least one or more of them; 2: General quality requirements, the image is bright, Dark, blurry or generally blurred, eyebrows covered, cheeks covered, chin covered, at least three of them; 3: High quality requirements, the image may be brighter, darker, generally blurry, eyebrows blocked, cheeks blocked, chin blocked, one or two of them; 4: Very high quality requirements, all dimensions are the best or the most , there is a slight problem in one dimension; default is 0. - If the image quality does not meet the requirements, the returned result will prompt that the image quality test does not meet the requirements. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Score | Float | The value range is [0.00, 100.00]. It is recommended that when the similarity is greater than or equal to 70, the person can be judged to be the same person, and the threshold can be adjusted according to the specific scenario (the false pass rate for a threshold of 70 is one in 1,000, and the false pass rate for a threshold of 80 is one in 10,000). |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Successful example of face similarity detection interface
Input Example
POST / HTTP/1.1
Host: iai.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CompareFace
<public parameter>
{
"UrlA": "http://test.image.myqcloud.com/testA.jpg",
"UrlB": "http://test.image.myqcloud.com/testB.jpg"
}
Output Example
{
"Response": {
"Score": 0.999,
"RequestId": "a8eb4545-a154-4f86-9510-57a8be9cae0c"
}
}
Example2 Example of abnormality in face similarity detection interface
Input Example
POST / HTTP/1.1
Host: iai.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CompareFace
<public parameter>
{
"UrlA": "http://test.image.myqcloud.com/testA.jpg",
"UrlB": "http://test.image.myqcloud.com/testB.jpg"
}
Output Example
{
"Response": {
"Error": {
"Code": "FailedOperation.FaceQualityNotQualified",
"Message": "xxxxx"
},
"RequestId": "788270e8-91b7-4c59-bd00-1af257b1e482"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.InvalidAuthorization | Authentication failed. |
| FailedOperation.CompareFail | |
| FailedOperation.ConflictOperation | The operations conflict. Do not operate on the same person simultaneously. |
| FailedOperation.DuplicatedGroupDescription | The custom description field must be unique in the group. |
| FailedOperation.FaceQualityNotQualified | The face image quality does not meet the requirement. |
| FailedOperation.FaceSizeTooSmall | The face frame size is smaller than the MinFaceSize value, and the face is filtered out. |
| FailedOperation.GroupInDeletedState | The current group is being deleted. Please wait. |
| FailedOperation.GroupPersonMapExist | The ID of the corresponding person is already in the group. |
| FailedOperation.GroupPersonMapNotExist | The ID of the corresponding person is not in the group. |
| FailedOperation.ImageDecodeFailed | Image decoding failed. |
| FailedOperation.ImageDownloadError | An error occurred while downloading the image. |
| FailedOperation.ImageFacedetectFailed | Face detection failed. |
| FailedOperation.ImageResolutionExceed | The image resolution is too high. |
| FailedOperation.ImageResolutionTooSmall | The image short edge resolution is smaller than 64. |
| FailedOperation.ImageSizeExceed | The size of the Base64-encoded image cannot exceed 5 MB. |
| FailedOperation.LifePhotoDetectFaces | |
| FailedOperation.LifePhotoDetectFake | |
| FailedOperation.LifePhotoDetectNoFaces | |
| FailedOperation.LifePhotoSizeError | |
| FailedOperation.RequestTimeout | The backend service timed out. |
| FailedOperation.RpcFail | The RPC call failed. |
| FailedOperation.SearchFacesExceed | The number of faces searched for exceeds the limit. |
| FailedOperation.ServerError | The algorithm service is exceptional. Please retry. |
| FailedOperation.UnKnowError | An internal error occurred. |
| InternalError | Internal error. |
| InvalidParameter.InvalidParameter | Invalid parameter. |
| InvalidParameterValue.AccountFaceNumExceed | The number of faces in the account exceeds the limit. |
| InvalidParameterValue.DeleteFaceNumExceed | The number of faces to be deleted exceeds the limit. Every person must have at least one face image. |
| InvalidParameterValue.FaceModelVersionIllegal | The algorithm model version is invalid. |
| InvalidParameterValue.GroupExDescriptionsExceed | The array length of the group's custom description fields exceeds the limit. Up to 5 fields can be created. |
| InvalidParameterValue.GroupExDescriptionsNameIdentical | The name of the group's custom description field must be unique. |
| InvalidParameterValue.GroupExDescriptionsNameIllegal | The name of the group's custom description field contains invalid characters. It can contain only letters, -, _, and digits. |
| InvalidParameterValue.GroupExDescriptionsNameTooLong | The name of the group's custom description field exceeds the length limit. |
| InvalidParameterValue.GroupFaceNumExceed | The number of faces in the group exceeds the limit. |
| InvalidParameterValue.GroupIdAlreadyExist | The group ID already exists. It must be unique. |
| InvalidParameterValue.GroupIdIllegal | The group ID contains invalid characters. It can contain only letters, digits, and special symbols (-%@#&_). |
| InvalidParameterValue.GroupIdNotExist | The group ID does not exist. |
| InvalidParameterValue.GroupIdTooLong | The group ID exceeds the length limit. |
| InvalidParameterValue.GroupIdsExceed | The list of groups passed in exceeds the limit. |
| InvalidParameterValue.GroupNameAlreadyExist | The group name already exists. It must be unique. |
| InvalidParameterValue.GroupNameIllegal | The group name contains invalid characters. It can contain only letters, -, _, and digits. |
| InvalidParameterValue.GroupNameTooLong | The group name exceeds the length limit. |
| InvalidParameterValue.GroupNumExceed | The number of groups exceeds the limit. If you need more, please contact us. |
| InvalidParameterValue.GroupNumPerPersonExceed | The number of groups exceeds the limit. One person can be added to up to 100 groups. |
| InvalidParameterValue.GroupTagIllegal | The group remarks field contains invalid characters. It can contain only letters, -, _, and digits. |
| InvalidParameterValue.GroupTagTooLong | The group remarks field exceeds the length limit. |
| InvalidParameterValue.ImageEmpty | Empty image. |
| InvalidParameterValue.LimitExceed | The number of returned results exceeds the limit. |
| InvalidParameterValue.NoFaceInGroups | There are no faces in the specified group. |
| InvalidParameterValue.NoFaceInPhoto | There are no faces in the image. |
| InvalidParameterValue.OffsetExceed | The starting number is too large. Please check the length of the array to be requested. |
| InvalidParameterValue.PersonExDescriptionInfosExceed | The array length of the person's custom description fields exceeds the limit. Up to 5 fields are allowed. |
| InvalidParameterValue.PersonExDescriptionsNameIdentical | The name of the person's custom description field must be unique. |
| InvalidParameterValue.PersonExDescriptionsNameIllegal | The name of the person's custom description field contains invalid characters. It can contain only letters, -, _, and digits. |
| InvalidParameterValue.PersonExDescriptionsNameTooLong | The name of the person's custom description field exceeds the length limit. |
| InvalidParameterValue.PersonExistInGroup | The ID of the corresponding person is already in the group. |
| InvalidParameterValue.PersonFaceNumExceed | The number of face images for the person exceeds the limit. One person can have up to 5 face images. |
| InvalidParameterValue.PersonGenderIllegal | An error occurred while setting person gender. 0: empty; 1: male; 2: female. |
| InvalidParameterValue.PersonIdAlreadyExist | The person ID already exists. It must be unique. |
| InvalidParameterValue.PersonIdIllegal | The person ID contains invalid characters. It can contain only letters, digits, and -%@#&_. |
| InvalidParameterValue.PersonIdNotExist | The person ID does not exist. |
| InvalidParameterValue.PersonIdTooLong | The person ID field exceeds the length limit. |
| InvalidParameterValue.PersonNameIllegal | The person name contains invalid characters. It can contain only letters, -, _, and digits. |
| InvalidParameterValue.PersonNameTooLong | The person name exceeds the length limit. |
| InvalidParameterValue.QualityControlIllegal | Invalid QualityControl parameter. |
| InvalidParameterValue.SearchPersonsExceed | The number of persons searched for exceeds the limit. |
| InvalidParameterValue.UploadFaceNumExceed | Up to four faces can be uploaded at a time. |
| InvalidParameterValue.UrlIllegal | Invalid URL format. |
| LimitExceeded.ErrorFaceNumExceed | The number of faces exceeds the limit. |
| MissingParameter.ErrorParameterEmpty | A required parameter is empty. |
| ResourceUnavailable.Delivering | The resource is being shipped. |
| ResourceUnavailable.Freeze | The account is frozen. |
| ResourceUnavailable.InArrears | The account is in arrears. |
| ResourceUnavailable.LowBalance | Insufficient balance. |
| ResourceUnavailable.NotExist | The billing status is unknown. Please check whether the service has been activated in the console. |
| ResourceUnavailable.Recover | The resource has been repossessed. |
| ResourceUnavailable.StopUsing | The service has been suspended for the account. |
| ResourceUnavailable.UnknownStatus | The billing status is unknown. |
| ResourcesSoldOut.ChargeStatusException | The billing status is exceptional. |
| UnsupportedOperation.UnknowMethod | Unknown method name. |
是
否
本页内容是否解决了您的问题？