tencent cloud

1. API Description

Domain name for API request: iai.tencentcloudapi.com.

This API is used to recognize top K persons in one or more groups who are similar to the person in a given image, display the results by group, and rank the similarity within each group in a descending order.

Up to 10 faces in the image can be recognized at a time, and cross-group search is supported.

The maximum number of faces in groups that can be searched for at a time is subject to the group's algorithm model version (FaceModelVersion), which is 1 million for v2.0 or 3 million for v3.0.

This API fuses the features of all face images of a person; for example, if a person has 4 face images, it will fuse the features of the 4 face images and generate the summarized facial features of the person to make the person search (i.e., judging whether the face image to be recognized is of a specified person) more accurate. By contrast, the SearchFaces and SearchFacesReturnsByGroup APIs recognize each face image of a person as an independent one for search.

• Please use the signature algorithm v3 to calculate the signature in the common parameters, that is, set the SignatureMethod parameter to TC3-HMAC-SHA256.
• This feature is available only to groups whose algorithm model version (FaceModelVersion) is 3.0.

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.

3. Output Parameters

4. Example

Example1 Searching for person with results returned by group

Input Example

https://iai.tencentcloudapi.com/?Action=SearchPersonsReturnsByGroup
&Url=http://test.image.myqcloud.com/testA.jpg
&MaxFaceNum=1
&MinFaceSize=40
&MaxPersonNumPerGroup=5
&GroupIds.0=TencentShenZhenEmployee
&<Common request parameters>

Output Example

{
    "Response": {
        "ResultsReturnsByGroup": [
            {
                "RetCode": 0,
                "FaceRect": {
                    "X": 375,
                    "Y": 37,
                    "Width": 63,
                    "Height": 82
                },
                "GroupCandidates": [
                    {
                        "GroupId": "TencentShenZhenEmployee",
                        "Candidates": [
                            {
                                "PersonId": "testtest3",
                                "FaceId": "",
                                "Score": 100,
                                "PersonName": null,
                                "Gender": null,
                                "PersonGroupInfos": null
                            }
                        ]
                    }
                ]
            }
        ],
        "PersonNum": 1,
        "FaceModelVersion": "3.0",
        "RequestId": "c8a06ec5-ecb4-4dd7-a8c8-ce5e675495c2"
    }
}

Example2 Sample error

Input Example

https://iai.tencentcloudapi.com/?Action=SearchPersonsReturnsByGroup
&Url=http://test.image.myqcloud.com/testB.jpg
&MaxFaceNum=1
&MinFaceSize=40
&MaxPersonNumPerGroup=5
&GroupIds.0=TencentShenZhenEmployee
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "527ecffe-4c6a-47c9-8217-4dd2e3f018da"
    }
}

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 NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.