tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
人脸识别
    文档
    Download PDF

    GetPersonGroupInfo

    最后更新时间：2023-02-27 15:22:48
    下载PDF

    1. API Description

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

    This API is used to get the information of a specified person, including group, description, etc.

    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: GetPersonGroupInfo.
    Version Yes String Common Params. The value used for this API: 2020-03-03.
    Region No String Common Params. This parameter is not required for this API.
    PersonId Yes String Person ID, which is the PersonId in the CreatePerson API.
    Offset No Integer Starting number. Default value: 0.
    Limit No Integer Number of returned results. Default value: 10. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    PersonGroupInfos Array of PersonGroupInfo List of groups containing this person and their description fields
    GroupNum Integer Total number of groups
    Note: this field may return null, indicating that no valid values can be obtained.
    FaceModelVersion String Algorithm model version used by the Face Recognition service.
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the group information of person

    Input Example

    https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo
&PersonId=2001
&Offset=0
&Limit=10
&<Common request parameters>

    Output Example

    {
    "Response": {
        "GroupNum": "1",
        "PersonGroupInfos": [
            {
                "GroupId": "ZhuYuanDormitoryNo1",
                "PersonExDescriptions": [
                    "School of Computer Science",
                    "Software Engineering",
                    "Class of 2015",
                    "3150108080"
                ]
            }
        ],
        "FaceModelVersion": "3.0",
        "RequestId": "671f0a1d-2b35-47c4-b9d1-b18053f71a04"
    }
}

    Example2 Getting the group information of person - 2

    Input Example

    https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo
&PersonId=1001
&Offset=0
&Limit=10
&<Common request parameters>

    Output Example

    {
    "Response": {
        "GroupNum": "1",
        "PersonGroupInfos": [
            {
                "GroupId": "TencentShenZhenEmployee",
                "PersonExDescriptions": [
                    "Cloud & Smart Industries Group",
                    "Big Data and AI Products Center",
                    "Face Recognition Products Group"
                ]
            }
        ],
        "FaceModelVersion": "3.0",
        "RequestId": "b7a505ad-4a85-42da-97b3-886c7999fb76"
    }
}

    Example3 Sample error

    This example shows the error that will occur if a person ID does not exist.

    Input Example

    https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo
&PersonId=1002
&Offset=0
&Limit=10
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "98330f25-eb2e-432a-a30c-3830774210c1"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    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
    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.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.ImageSizeExceed The size of the Base64-encoded image cannot exceed 5 MB.
    FailedOperation.RequestLimitExceeded The request frequency exceeds the limit.
    FailedOperation.RequestTimeout The backend service timed out.
    FailedOperation.SearchFacesExceed The number of faces searched for exceeds the limit.
    FailedOperation.ServerError The algorithm service is exceptional. Please retry.
    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.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.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.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.
    联系我们

    联系我们，为您的业务提供专属服务。

    联系我们
    技术支持

    如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

    提交工单
    7x24 电话支持
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款