IaiClient (tencentcloud-sdk-java 3.1.648 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.iai.v20180301.IaiClient

public class IaiClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`IaiClient(Credential credential, String region)`
`IaiClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyzeDenseLandmarksResponse`	`AnalyzeDenseLandmarks(AnalyzeDenseLandmarksRequest req)` 对请求图片进行五官定位（也称人脸关键点定位），获得人脸的精准信息，返回多达888点关键信息，对五官和脸部轮廓进行精确定位。
`AnalyzeFaceResponse`	`AnalyzeFace(AnalyzeFaceRequest req)` 对请求图片进行五官定位（也称人脸关键点定位），计算构成人脸轮廓的 90 个点，包括眉毛（左右各 8 点）、眼睛（左右各 8 点）、鼻子（13 点）、嘴巴（22 点）、脸型轮廓（21 点）、眼珠[或瞳孔]（2点）。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`CompareFaceResponse`	`CompareFace(CompareFaceRequest req)` 对两张图片中的人脸进行相似度比对，返回人脸相似度分数。若您需要判断 “此人是否是某人”，即验证某张图片中的人是否是已知身份的某人，如常见的人脸登录场景，建议使用[人脸验证](https://cloud.tencent.com/document/product/867/32806)或[人员验证](https://cloud.tencent.com/document/product/867/38879)接口。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`CopyPersonResponse`	`CopyPerson(CopyPersonRequest req)` 将已存在于某人员库的人员复制到其他人员库，该人员的描述信息不会被复制。单个人员最多只能同时存在100个人员库中。 > - 注：若该人员创建时算法模型版本为2.0，复制到非2.0算法模型版本的Group中时，复制操作将会失败。
`CreateFaceResponse`	`CreateFace(CreateFaceRequest req)` 将一组人脸图片添加到一个人员中。一个人员最多允许包含 5 张图片。若该人员存在多个人员库中，所有人员库中该人员图片均会增加。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`CreateGroupResponse`	`CreateGroup(CreateGroupRequest req)` 用于创建一个空的人员库，如果人员库已存在返回错误。可根据需要创建自定义描述字段，用于辅助描述该人员库下的人员信息。 1个APPID下最多创建10万个人员库（Group）、最多包含5000万张人脸（Face）。不同算法模型版本（FaceModelVersion）的人员库（Group）最多可包含人脸（Face）数不同。算法模型版本为2.0的人员库最多包含100万张人脸，算法模型版本为3.0的人员库最多可包含300万张人脸。
`CreatePersonResponse`	`CreatePerson(CreatePersonRequest req)` 创建人员，添加人脸、姓名、性别及其他相关信息。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`DeleteFaceResponse`	`DeleteFace(DeleteFaceRequest req)` 删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。
`DeleteGroupResponse`	`DeleteGroup(DeleteGroupRequest req)` 删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除，属于其他人员库的自定义描述字段信息不受影响。
`DeletePersonResponse`	`DeletePerson(DeletePersonRequest req)` 删除该人员信息，此操作会导致所有人员库均删除此人员。同时，该人员的所有人脸信息将被删除。
`DeletePersonFromGroupResponse`	`DeletePersonFromGroup(DeletePersonFromGroupRequest req)` 从某人员库中删除人员，此操作仅影响该人员库。若该人员仅存在于指定的人员库中，该人员将被删除，其所有的人脸信息也将被删除。
`DetectFaceResponse`	`DetectFace(DetectFaceRequest req)` 检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括： 1）人员库[创建人员](https://cloud.tencent.com/document/product/867/32793)/[增加人脸](https://cloud.tencent.com/document/product/867/32795)：保证人员人脸信息的质量，便于后续的业务处理。 2） [人脸搜索](https://cloud.tencent.com/document/product/867/32798)：保证输入的图片质量，快速准确匹配到对应的人员。 3） [人脸验证](https://cloud.tencent.com/document/product/867/32806)：保证人脸信息的质量，避免明明是本人却认证不通过的情况。 4） [人脸融合](https://cloud.tencent.com/product/facefusion)：保证上传的人脸质量，人脸融合的效果更好。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`DetectFaceAttributesResponse`	`DetectFaceAttributes(DetectFaceAttributesRequest req)` 检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括： 1）人员库[创建人员](https://cloud.tencent.com/document/product/867/32793)/[增加人脸](https://cloud.tencent.com/document/product/867/32795)：保证人员人脸信息的质量，便于后续的业务处理。 2） [人脸搜索](https://cloud.tencent.com/document/product/867/32798)：保证输入的图片质量，快速准确匹配到对应的人员。 3） [人脸验证](https://cloud.tencent.com/document/product/867/32806)：保证人脸信息的质量，避免明明是本人却认证不通过的情况。 4） [人脸融合](https://cloud.tencent.com/product/facefusion)：保证上传的人脸质量，人脸融合的效果更好。 > - 本接口是[人脸检测与分析](https://cloud.tencent.com/document/product/867/32800)的升级，具体在于： 1.本接口可以指定需要计算返回的人脸属性，避免无效计算，降低耗时； 2.本接口支持更多属性细项数，也会持续增加更多功能。请您使用本接口完成相应的人脸检测与属性分析需求。 - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`DetectLiveFaceResponse`	`DetectLiveFace(DetectLiveFaceRequest req)` 用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。 > - 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。 > - 使用过程中建议正对摄像头，不要距离太远，使面部可以完整地显示在识别的框内，识别过程中不要移动设备或遮挡面部。不要选择光线过强或过弱的环境进行面部识别，识别时不要添加任何滤镜。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 ## 调用次数计费（资源包） \|资源包规格\|100万次\|1000万次\|5000万次\|1亿次\| \|-\|-\|-\|-\|-\| \|人脸静态活体检测\|1800元\|17400元\|75000元\|110000元\| ## 调用次数计费（后付费） \|月接口调用总量\|0<调用量≤300万\|300万<调用量≤1500万\|调用量>1500万\| \|-\|-\|-\|-\| \|人脸静态活体检测\|0.0019元/次\|0.0017元/次\|0.0013元/次\|
`GetGroupInfoResponse`	`GetGroupInfo(GetGroupInfoRequest req)` 获取人员库信息。
`GetGroupListResponse`	`GetGroupList(GetGroupListRequest req)` 获取人员库列表。
`GetPersonBaseInfoResponse`	`GetPersonBaseInfo(GetPersonBaseInfoRequest req)` 获取指定人员的信息，包括姓名、性别、人脸等。
`GetPersonGroupInfoResponse`	`GetPersonGroupInfo(GetPersonGroupInfoRequest req)` 获取指定人员的信息，包括加入的人员库、描述内容等。
`GetPersonListResponse`	`GetPersonList(GetPersonListRequest req)` 获取指定人员库中的人员列表。
`GetPersonListNumResponse`	`GetPersonListNum(GetPersonListNumRequest req)` 获取指定人员库中人员数量。
`GetUpgradeGroupFaceModelVersionJobListResponse`	`GetUpgradeGroupFaceModelVersionJobList(GetUpgradeGroupFaceModelVersionJobListRequest req)` 获取人员库升级任务列表
`GetUpgradeGroupFaceModelVersionResultResponse`	`GetUpgradeGroupFaceModelVersionResult(GetUpgradeGroupFaceModelVersionResultRequest req)` 人员库升级结果查询
`ModifyGroupResponse`	`ModifyGroup(ModifyGroupRequest req)` 修改人员库名称、备注、自定义描述字段名称。
`ModifyPersonBaseInfoResponse`	`ModifyPersonBaseInfo(ModifyPersonBaseInfoRequest req)` 修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。
`ModifyPersonGroupInfoResponse`	`ModifyPersonGroupInfo(ModifyPersonGroupInfoRequest req)` 修改指定人员库人员描述内容。
`RevertGroupFaceModelVersionResponse`	`RevertGroupFaceModelVersion(RevertGroupFaceModelVersionRequest req)` 本接口用于回滚人员库的人脸识别算法模型版本。单个人员库有且仅有一次回滚机会。回滚操作会在10s内生效，回滚操作中，您对人员库的操作可能会失效。
`SearchFacesResponse`	`SearchFaces(SearchFacesRequest req)` 用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，识别结果按照相似度从大到小排序。支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。与[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而人员搜索及人员搜索按库返回接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`SearchFacesReturnsByGroupResponse`	`SearchFacesReturnsByGroup(SearchFacesReturnsByGroupRequest req)` 用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照人员库的维度以人员相似度从大到小顺序排列。支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。与[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`SearchPersonsResponse`	`SearchPersons(SearchPersonsRequest req)` 用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照相似度从大到小排列。支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/32798)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/38882)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 - 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
`SearchPersonsReturnsByGroupResponse`	`SearchPersonsReturnsByGroup(SearchPersonsReturnsByGroupRequest req)` 用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照人员库的维度以人员相似度从大到小顺序排列。支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/32798)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/38882)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 - 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
`UpgradeGroupFaceModelVersionResponse`	`UpgradeGroupFaceModelVersion(UpgradeGroupFaceModelVersionRequest req)` 升级人员库。升级过程中，人员库仍然为原算法版本，人员库相关操作仍然支持。升级完成后，人员库为新算法版本。单个人员库有且仅支持一次回滚操作。注：此处QPS限制为10。
`VerifyFaceResponse`	`VerifyFace(VerifyFaceRequest req)` 给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)。与[人脸比对](https://cloud.tencent.com/document/product/867/32802)接口不同的是，人脸验证用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而[人脸比对](https://cloud.tencent.com/document/product/867/32802)用于判断两张人脸的相似度。与[人员验证](https://cloud.tencent.com/document/product/867/38879)接口不同的是，人脸验证将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员验证](https://cloud.tencent.com/document/product/867/38879)会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person下有4张 Face，人员验证接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`VerifyPersonResponse`	`VerifyPerson(VerifyPersonRequest req)` 给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。和人脸比对相关接口不同的是，人脸验证相关接口用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而人脸比对相关接口用于判断两张人脸的相似度。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 - 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IaiClient
```
public IaiClient(Credential credential,
                 String region)
```
  - IaiClient
```
public IaiClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - AnalyzeDenseLandmarks
```
public AnalyzeDenseLandmarksResponse AnalyzeDenseLandmarks(AnalyzeDenseLandmarksRequest req)
                                                    throws TencentCloudSDKException
```
    对请求图片进行五官定位（也称人脸关键点定位），获得人脸的精准信息，返回多达888点关键信息，对五官和脸部轮廓进行精确定位。
    
    Parameters:
    
    req - AnalyzeDenseLandmarksRequest
    
    Returns:
    
    AnalyzeDenseLandmarksResponse
    
    Throws:
    
    TencentCloudSDKException
  - AnalyzeFace
```
public AnalyzeFaceResponse AnalyzeFace(AnalyzeFaceRequest req)
                                throws TencentCloudSDKException
```
    对请求图片进行五官定位（也称人脸关键点定位），计算构成人脸轮廓的 90 个点，包括眉毛（左右各 8 点）、眼睛（左右各 8 点）、鼻子（13 点）、嘴巴（22 点）、脸型轮廓（21 点）、眼珠[或瞳孔]（2点）。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - AnalyzeFaceRequest
    
    Returns:
    
    AnalyzeFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CompareFace
```
public CompareFaceResponse CompareFace(CompareFaceRequest req)
                                throws TencentCloudSDKException
```
    对两张图片中的人脸进行相似度比对，返回人脸相似度分数。若您需要判断 “此人是否是某人”，即验证某张图片中的人是否是已知身份的某人，如常见的人脸登录场景，建议使用[人脸验证](https://cloud.tencent.com/document/product/867/32806)或[人员验证](https://cloud.tencent.com/document/product/867/38879)接口。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - CompareFaceRequest
    
    Returns:
    
    CompareFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CopyPerson
```
public CopyPersonResponse CopyPerson(CopyPersonRequest req)
                              throws TencentCloudSDKException
```
    将已存在于某人员库的人员复制到其他人员库，该人员的描述信息不会被复制。单个人员最多只能同时存在100个人员库中。 > - 注：若该人员创建时算法模型版本为2.0，复制到非2.0算法模型版本的Group中时，复制操作将会失败。
    
    Parameters:
    
    req - CopyPersonRequest
    
    Returns:
    
    CopyPersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFace
```
public CreateFaceResponse CreateFace(CreateFaceRequest req)
                              throws TencentCloudSDKException
```
    将一组人脸图片添加到一个人员中。一个人员最多允许包含 5 张图片。若该人员存在多个人员库中，所有人员库中该人员图片均会增加。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - CreateFaceRequest
    
    Returns:
    
    CreateFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateGroup
```
public CreateGroupResponse CreateGroup(CreateGroupRequest req)
                                throws TencentCloudSDKException
```
    用于创建一个空的人员库，如果人员库已存在返回错误。可根据需要创建自定义描述字段，用于辅助描述该人员库下的人员信息。 1个APPID下最多创建10万个人员库（Group）、最多包含5000万张人脸（Face）。不同算法模型版本（FaceModelVersion）的人员库（Group）最多可包含人脸（Face）数不同。算法模型版本为2.0的人员库最多包含100万张人脸，算法模型版本为3.0的人员库最多可包含300万张人脸。
    
    Parameters:
    
    req - CreateGroupRequest
    
    Returns:
    
    CreateGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePerson
```
public CreatePersonResponse CreatePerson(CreatePersonRequest req)
                                  throws TencentCloudSDKException
```
    创建人员，添加人脸、姓名、性别及其他相关信息。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - CreatePersonRequest
    
    Returns:
    
    CreatePersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteFace
```
public DeleteFaceResponse DeleteFace(DeleteFaceRequest req)
                              throws TencentCloudSDKException
```
    删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。
    
    Parameters:
    
    req - DeleteFaceRequest
    
    Returns:
    
    DeleteFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteGroup
```
public DeleteGroupResponse DeleteGroup(DeleteGroupRequest req)
                                throws TencentCloudSDKException
```
    删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除，属于其他人员库的自定义描述字段信息不受影响。
    
    Parameters:
    
    req - DeleteGroupRequest
    
    Returns:
    
    DeleteGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeletePerson
```
public DeletePersonResponse DeletePerson(DeletePersonRequest req)
                                  throws TencentCloudSDKException
```
    删除该人员信息，此操作会导致所有人员库均删除此人员。同时，该人员的所有人脸信息将被删除。
    
    Parameters:
    
    req - DeletePersonRequest
    
    Returns:
    
    DeletePersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeletePersonFromGroup
```
public DeletePersonFromGroupResponse DeletePersonFromGroup(DeletePersonFromGroupRequest req)
                                                    throws TencentCloudSDKException
```
    从某人员库中删除人员，此操作仅影响该人员库。若该人员仅存在于指定的人员库中，该人员将被删除，其所有的人脸信息也将被删除。
    
    Parameters:
    
    req - DeletePersonFromGroupRequest
    
    Returns:
    
    DeletePersonFromGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetectFace
```
public DetectFaceResponse DetectFace(DetectFaceRequest req)
                              throws TencentCloudSDKException
```
    检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括： 1）人员库[创建人员](https://cloud.tencent.com/document/product/867/32793)/[增加人脸](https://cloud.tencent.com/document/product/867/32795)：保证人员人脸信息的质量，便于后续的业务处理。 2） [人脸搜索](https://cloud.tencent.com/document/product/867/32798)：保证输入的图片质量，快速准确匹配到对应的人员。 3） [人脸验证](https://cloud.tencent.com/document/product/867/32806)：保证人脸信息的质量，避免明明是本人却认证不通过的情况。 4） [人脸融合](https://cloud.tencent.com/product/facefusion)：保证上传的人脸质量，人脸融合的效果更好。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - DetectFaceRequest
    
    Returns:
    
    DetectFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetectFaceAttributes
```
public DetectFaceAttributesResponse DetectFaceAttributes(DetectFaceAttributesRequest req)
                                                  throws TencentCloudSDKException
```
    检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括： 1）人员库[创建人员](https://cloud.tencent.com/document/product/867/32793)/[增加人脸](https://cloud.tencent.com/document/product/867/32795)：保证人员人脸信息的质量，便于后续的业务处理。 2） [人脸搜索](https://cloud.tencent.com/document/product/867/32798)：保证输入的图片质量，快速准确匹配到对应的人员。 3） [人脸验证](https://cloud.tencent.com/document/product/867/32806)：保证人脸信息的质量，避免明明是本人却认证不通过的情况。 4） [人脸融合](https://cloud.tencent.com/product/facefusion)：保证上传的人脸质量，人脸融合的效果更好。 > - 本接口是[人脸检测与分析](https://cloud.tencent.com/document/product/867/32800)的升级，具体在于： 1.本接口可以指定需要计算返回的人脸属性，避免无效计算，降低耗时； 2.本接口支持更多属性细项数，也会持续增加更多功能。请您使用本接口完成相应的人脸检测与属性分析需求。 - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - DetectFaceAttributesRequest
    
    Returns:
    
    DetectFaceAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetectLiveFace
```
public DetectLiveFaceResponse DetectLiveFace(DetectLiveFaceRequest req)
                                      throws TencentCloudSDKException
```
    用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。 > - 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。 > - 使用过程中建议正对摄像头，不要距离太远，使面部可以完整地显示在识别的框内，识别过程中不要移动设备或遮挡面部。不要选择光线过强或过弱的环境进行面部识别，识别时不要添加任何滤镜。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 ## 调用次数计费（资源包） |资源包规格|100万次|1000万次|5000万次|1亿次| |-|-|-|-|-| |人脸静态活体检测|1800元|17400元|75000元|110000元| ## 调用次数计费（后付费） |月接口调用总量|0<调用量≤300万|300万<调用量≤1500万|调用量>1500万| |-|-|-|-| |人脸静态活体检测|0.0019元/次|0.0017元/次|0.0013元/次|
    
    Parameters:
    
    req - DetectLiveFaceRequest
    
    Returns:
    
    DetectLiveFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetGroupInfo
```
public GetGroupInfoResponse GetGroupInfo(GetGroupInfoRequest req)
                                  throws TencentCloudSDKException
```
    获取人员库信息。
    
    Parameters:
    
    req - GetGroupInfoRequest
    
    Returns:
    
    GetGroupInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetGroupList
```
public GetGroupListResponse GetGroupList(GetGroupListRequest req)
                                  throws TencentCloudSDKException
```
    获取人员库列表。
    
    Parameters:
    
    req - GetGroupListRequest
    
    Returns:
    
    GetGroupListResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetPersonBaseInfo
```
public GetPersonBaseInfoResponse GetPersonBaseInfo(GetPersonBaseInfoRequest req)
                                            throws TencentCloudSDKException
```
    获取指定人员的信息，包括姓名、性别、人脸等。
    
    Parameters:
    
    req - GetPersonBaseInfoRequest
    
    Returns:
    
    GetPersonBaseInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetPersonGroupInfo
```
public GetPersonGroupInfoResponse GetPersonGroupInfo(GetPersonGroupInfoRequest req)
                                              throws TencentCloudSDKException
```
    获取指定人员的信息，包括加入的人员库、描述内容等。
    
    Parameters:
    
    req - GetPersonGroupInfoRequest
    
    Returns:
    
    GetPersonGroupInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetPersonList
```
public GetPersonListResponse GetPersonList(GetPersonListRequest req)
                                    throws TencentCloudSDKException
```
    获取指定人员库中的人员列表。
    
    Parameters:
    
    req - GetPersonListRequest
    
    Returns:
    
    GetPersonListResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetPersonListNum
```
public GetPersonListNumResponse GetPersonListNum(GetPersonListNumRequest req)
                                          throws TencentCloudSDKException
```
    获取指定人员库中人员数量。
    
    Parameters:
    
    req - GetPersonListNumRequest
    
    Returns:
    
    GetPersonListNumResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetUpgradeGroupFaceModelVersionJobList
```
public GetUpgradeGroupFaceModelVersionJobListResponse GetUpgradeGroupFaceModelVersionJobList(GetUpgradeGroupFaceModelVersionJobListRequest req)
                                                                                      throws TencentCloudSDKException
```
    获取人员库升级任务列表
    
    Parameters:
    
    req - GetUpgradeGroupFaceModelVersionJobListRequest
    
    Returns:
    
    GetUpgradeGroupFaceModelVersionJobListResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetUpgradeGroupFaceModelVersionResult
```
public GetUpgradeGroupFaceModelVersionResultResponse GetUpgradeGroupFaceModelVersionResult(GetUpgradeGroupFaceModelVersionResultRequest req)
                                                                                    throws TencentCloudSDKException
```
    人员库升级结果查询
    
    Parameters:
    
    req - GetUpgradeGroupFaceModelVersionResultRequest
    
    Returns:
    
    GetUpgradeGroupFaceModelVersionResultResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyGroup
```
public ModifyGroupResponse ModifyGroup(ModifyGroupRequest req)
                                throws TencentCloudSDKException
```
    修改人员库名称、备注、自定义描述字段名称。
    
    Parameters:
    
    req - ModifyGroupRequest
    
    Returns:
    
    ModifyGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPersonBaseInfo
```
public ModifyPersonBaseInfoResponse ModifyPersonBaseInfo(ModifyPersonBaseInfoRequest req)
                                                  throws TencentCloudSDKException
```
    修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。
    
    Parameters:
    
    req - ModifyPersonBaseInfoRequest
    
    Returns:
    
    ModifyPersonBaseInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPersonGroupInfo
```
public ModifyPersonGroupInfoResponse ModifyPersonGroupInfo(ModifyPersonGroupInfoRequest req)
                                                    throws TencentCloudSDKException
```
    修改指定人员库人员描述内容。
    
    Parameters:
    
    req - ModifyPersonGroupInfoRequest
    
    Returns:
    
    ModifyPersonGroupInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - RevertGroupFaceModelVersion
```
public RevertGroupFaceModelVersionResponse RevertGroupFaceModelVersion(RevertGroupFaceModelVersionRequest req)
                                                                throws TencentCloudSDKException
```
    本接口用于回滚人员库的人脸识别算法模型版本。单个人员库有且仅有一次回滚机会。回滚操作会在10s内生效，回滚操作中，您对人员库的操作可能会失效。
    
    Parameters:
    
    req - RevertGroupFaceModelVersionRequest
    
    Returns:
    
    RevertGroupFaceModelVersionResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchFaces
```
public SearchFacesResponse SearchFaces(SearchFacesRequest req)
                                throws TencentCloudSDKException
```
    用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，识别结果按照相似度从大到小排序。支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。与[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而人员搜索及人员搜索按库返回接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - SearchFacesRequest
    
    Returns:
    
    SearchFacesResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchFacesReturnsByGroup
```
public SearchFacesReturnsByGroupResponse SearchFacesReturnsByGroup(SearchFacesReturnsByGroupRequest req)
                                                            throws TencentCloudSDKException
```
    用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照**人员库的维度**以人员相似度从大到小顺序排列。支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。与[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - SearchFacesReturnsByGroupRequest
    
    Returns:
    
    SearchFacesReturnsByGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchPersons
```
public SearchPersonsResponse SearchPersons(SearchPersonsRequest req)
                                    throws TencentCloudSDKException
```
    用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照相似度从大到小排列。支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/32798)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/38882)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 - 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
    
    Parameters:
    
    req - SearchPersonsRequest
    
    Returns:
    
    SearchPersonsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchPersonsReturnsByGroup
```
public SearchPersonsReturnsByGroupResponse SearchPersonsReturnsByGroup(SearchPersonsReturnsByGroupRequest req)
                                                                throws TencentCloudSDKException
```
    用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照**人员库的维度**以人员相似度从大到小顺序排列。支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/32798)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/38882)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 - 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
    
    Parameters:
    
    req - SearchPersonsReturnsByGroupRequest
    
    Returns:
    
    SearchPersonsReturnsByGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpgradeGroupFaceModelVersion
```
public UpgradeGroupFaceModelVersionResponse UpgradeGroupFaceModelVersion(UpgradeGroupFaceModelVersionRequest req)
                                                                  throws TencentCloudSDKException
```
    升级人员库。升级过程中，人员库仍然为原算法版本，人员库相关操作仍然支持。升级完成后，人员库为新算法版本。单个人员库有且仅支持一次回滚操作。注：此处QPS限制为10。
    
    Parameters:
    
    req - UpgradeGroupFaceModelVersionRequest
    
    Returns:
    
    UpgradeGroupFaceModelVersionResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifyFace
```
public VerifyFaceResponse VerifyFace(VerifyFaceRequest req)
                              throws TencentCloudSDKException
```
    给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)。与[人脸比对](https://cloud.tencent.com/document/product/867/32802)接口不同的是，人脸验证用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而[人脸比对](https://cloud.tencent.com/document/product/867/32802)用于判断两张人脸的相似度。与[人员验证](https://cloud.tencent.com/document/product/867/38879)接口不同的是，人脸验证将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员验证](https://cloud.tencent.com/document/product/867/38879)会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person下有4张 Face，人员验证接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - VerifyFaceRequest
    
    Returns:
    
    VerifyFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifyPerson
```
public VerifyPersonResponse VerifyPerson(VerifyPersonRequest req)
                                  throws TencentCloudSDKException
```
    给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。和人脸比对相关接口不同的是，人脸验证相关接口用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而人脸比对相关接口用于判断两张人脸的相似度。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。 - 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
    
    Parameters:
    
    req - VerifyPersonRequest
    
    Returns:
    
    VerifyPersonResponse
    
    Throws:
    
    TencentCloudSDKException

Class IaiClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

IaiClient

IaiClient

Method Detail

AnalyzeDenseLandmarks

AnalyzeFace

CompareFace

CopyPerson

CreateFace

CreateGroup

CreatePerson

DeleteFace

DeleteGroup

DeletePerson

DeletePersonFromGroup

DetectFace

DetectFaceAttributes

DetectLiveFace

GetGroupInfo

GetGroupList

GetPersonBaseInfo

GetPersonGroupInfo

GetPersonList

GetPersonListNum

GetUpgradeGroupFaceModelVersionJobList

GetUpgradeGroupFaceModelVersionResult

ModifyGroup

ModifyPersonBaseInfo

ModifyPersonGroupInfo

RevertGroupFaceModelVersion

SearchFaces

SearchFacesReturnsByGroup

SearchPersons

SearchPersonsReturnsByGroup

UpgradeGroupFaceModelVersion

VerifyFace

VerifyPerson