人员搜索

最近更新时间:2019-12-05 17:49:23

1. 接口描述

接口请求域名: iai.tencentcloudapi.com 。

用于对一张待识别的人脸图片,在一个或多个人员库中识别出最相似的 TopN 人员,按照相似度从大到小排列。

本接口会将该人员(Person)下的所有人脸(Face)进行融合特征处理,即若某个 Person 下有4张 Face ,本接口会将4张 Face 的特征进行融合处理,生成对应这个 Person 的特征,使人员搜索(确定待识别的人脸图片是某人)更加准确。

人员搜索接口和人脸搜索接口的区别是:人脸搜索会比对该 Person 下所有 Face ,而人员搜索比对的是该 Person 的 Person 特征。

  • 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
  • 仅支持算法模型版本(FaceModelVersion)为3.0的人员库。

默认接口请求频率限制:50次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SearchPersons
Version String 公共参数,本接口取值:2018-03-01
Region String 公共参数,本接口不需要传递此参数。
GroupIds.N Array of String 希望搜索的人员库列表,上限100个。
Image String 图片 base64 数据,base64 编码后大小不可超过5M。
若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
Url、Image必须提供一个,如果都提供,只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
MaxFaceNum Integer 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
MinFaceSize Integer 人脸长和宽的最小尺寸,单位为像素。默认为80。低于40将影响搜索精度。建议设置为80。
MaxPersonNum Integer 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
值越大,需要处理的时间越长。建议不要超过10。
QualityControl Integer 图片质量控制。
0: 不进行控制;
1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
默认 0。
若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
FaceMatchThreshold Float 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。默认为0。取值范围[0.0,100.0) 。
NeedPersonInfo Integer 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0

3. 输出参数

参数名称 类型 描述
Results Array of Result 识别结果。
PersonNum Integer 搜索的人员库中包含的人员数。若输入图片中所有人脸均不符合质量要求,则返回0。
FaceModelVersion String 人脸识别所用的算法模型版本。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 人员搜索接口

输入示例

https://iai.tencentcloudapi.com/?Action=SearchPersons
&Url=http://test.image.myqcloud.com/testA.jpg
&MaxFaceNum=1
&MinFaceSize=40
&MaxPersonNum=3
&GroupIds.0=TencentShenZhenEmployee
&Version=2018-03-01
&<公共请求参数>

输出示例

{
  "Response": {
    "Results": [
      {
        "RetCode": 0,
        "Candidates": [
          {
            "PersonId": "person1",
            "FaceId": "",
            "Score": 100,
            "PersonName": null,
            "Gender": null,
            "PersonGroupInfos": null
          },
          {
            "PersonId": "person2",
            "FaceId": "",
            "Score": 60,
            "PersonName": null,
            "Gender": null,
            "PersonGroupInfos": null
          },
          {
            "PersonId": "person3",
            "FaceId": "",
            "Score": 50,
            "PersonName": null,
            "Gender": null,
            "PersonGroupInfos": null
          }
        ],
        "FaceRect": {
          "X": 139,
          "Y": 59,
          "Width": 124,
          "Height": 162
        }
      },
      {
        "RetCode": 0,
        "Candidates": [
          {
            "PersonId": "person2",
            "FaceId": "",
            "Score": 100,
            "PersonName": null,
            "Gender": null,
            "PersonGroupInfos": null
          },
          {
            "PersonId": "person1",
            "FaceId": "",
            "Score": 60,
            "PersonName": null,
            "Gender": null,
            "PersonGroupInfos": null
          },
          {
            "PersonId": "person3",
            "FaceId": "",
            "Score": 20,
            "PersonName": null,
            "Gender": null,
            "PersonGroupInfos": null
          }
        ],
        "FaceRect": {
          "X": 328,
          "Y": 70,
          "Width": 119,
          "Height": 162
        }
      }
    ],
    "PersonNum": 5,
    "FaceModelVersion": "3.0",
    "RequestId": "c4608852-ff60-4a01-8dc3-367f6046baaf"
  }
}

示例2 错误示例

图片URL错误

输入示例

https://iai.tencentcloudapi.com/?Action=SearchPersons
&Url=http://test.image.myqcloud.com/testA
&GroupIds.0=TencentShenZhenEmployee
&Version=2018-03-01
&<公共请求参数>

输出示例

{
  "Response": {
    "Error": {
      "Code": "FailedOperation.ImageDownloadError",
      "Message": "图片下载错误。"
    },
    "RequestId": "527ecffe-4c6a-47c9-8217-4dd2e3f018da"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.AcrossVersionsError 该操作不支持跨算法模型版本。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageDownloadError 图片下载错误。
FailedOperation.ImageFacedetectFailed 人脸检测失败。
FailedOperation.ImageSizeExceed base64编码后的图片数据大小不超过5M。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.SearchFacesExceed 检索人脸个数超过限制。
FailedOperation.ServerError 算法服务异常,请重试。
InternalError 内部错误。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.FaceMatchThresholdIllegal FaceMatchThreshold参数不合法。
InvalidParameterValue.GroupIdNotExist 人员库ID不存在。
InvalidParameterValue.GroupIdsExceed 传入的人员库列表超过限制。
InvalidParameterValue.ImageEmpty 图片为空。
InvalidParameterValue.ImageEmptyError 图片为空。
InvalidParameterValue.NoFaceInGroups 指定分组中没有人脸。
InvalidParameterValue.NoFaceInPhoto 图片中没有人脸。
InvalidParameterValue.QualityControlIllegal QualityControl参数不合法。
InvalidParameterValue.SearchPersonsExceed 搜索的人员数目超过限制。
InvalidParameterValue.UnsupportedGroupFaceModelVersion 该操作不支持算法模型版本2.0及以下版本。
InvalidParameterValue.UrlIllegal URL格式不合法。
MissingParameter.ErrorParameterEmpty 必选参数为空。
ResourceUnavailable.ChargeStatusException 帐号已欠费。
ResourceUnavailable.Freeze 帐号已被冻结。
ResourceUnavailable.GetAuchInfoError 获取认证信息失败。
ResourceUnavailable.InArrears 帐号已欠费。
ResourceUnavailable.LowBalance 余额不足。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.NotReady 服务未开通。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 帐号已停服。
ResourceUnavailable.UnknownStatus 计费状态未知。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
UnsupportedOperation.UnknowMethod 未知方法名。