IaiClient (tencentcloud-sdk-java 3.0.93 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)` 构造client
`IaiClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)接口。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`CopyPersonResponse`	`CopyPerson(CopyPersonRequest req)` 将已存在于某人员库的人员复制到其他人员库，该人员的描述信息不会被复制。单个人员最多只能同时存在100个人员库中。
`CreateFaceResponse`	`CreateFace(CreateFaceRequest req)` 将一组人脸图片添加到一个人员中。一个人员最多允许包含 5 张图片。若该人员存在多个人员库中，所有人员库中该人员图片均会增加。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`CreateGroupResponse`	`CreateGroup(CreateGroupRequest req)` 用于创建一个空的人员库，如果人员库已存在返回错误。可根据需要创建自定义描述字段，用于辅助描述该人员库下的人员信息。1个APPID下最多创建2万个人员库（Group）、最多包含1000万张人脸（Face），单个人员库（Group）最多包含100万张人脸（Face）。
`CreatePersonResponse`	`CreatePerson(CreatePersonRequest req)` 创建人员，添加人脸、姓名、性别及其他相关信息。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`DeleteFaceResponse`	`DeleteFace(DeleteFaceRequest req)` 删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。
`DeleteGroupResponse`	`DeleteGroup(DeleteGroupRequest req)` 删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除。注：删除人员库的操作为异步执行，删除单张人脸时间约为10ms，即一小时内可以删除36万张。删除期间，无法向该人员库添加人员。
`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。
`DetectLiveFaceResponse`	`DetectLiveFace(DetectLiveFaceRequest req)` 用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。 > - 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`GetGroupListResponse`	`GetGroupList(GetGroupListRequest req)` 获取人员库列表。
`GetPersonBaseInfoResponse`	`GetPersonBaseInfo(GetPersonBaseInfoRequest req)` 获取指定人员的信息，包括姓名、性别、人脸等。
`GetPersonGroupInfoResponse`	`GetPersonGroupInfo(GetPersonGroupInfoRequest req)` 获取指定人员的信息，包括加入的人员库、描述内容等。
`GetPersonListResponse`	`GetPersonList(GetPersonListRequest req)` 获取指定人员库中的人员列表。
`GetPersonListNumResponse`	`GetPersonListNum(GetPersonListNumRequest req)` 获取指定人员库中人员数量。
`ModifyGroupResponse`	`ModifyGroup(ModifyGroupRequest req)` 修改人员库名称、备注、自定义描述字段名称。
`ModifyPersonBaseInfoResponse`	`ModifyPersonBaseInfo(ModifyPersonBaseInfoRequest req)` 修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。
`ModifyPersonGroupInfoResponse`	`ModifyPersonGroupInfo(ModifyPersonGroupInfoRequest req)` 修改指定人员库人员描述内容。
`SearchFacesResponse`	`SearchFaces(SearchFacesRequest req)` 用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，识别结果按照相似度从大到小排序。单次搜索的人员库人脸总数量不得超过 100 万张。此接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
`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/32806)用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而[人脸比对](https://cloud.tencent.com/document/product/867/32802)用于判断两张人脸的相似度。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, 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)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - IaiClient
```
public IaiClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - 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)接口。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - CompareFaceRequest
    
    Returns:
    
    CompareFaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CopyPerson
```
public CopyPersonResponse CopyPerson(CopyPersonRequest req)
                              throws TencentCloudSDKException
```
    将已存在于某人员库的人员复制到其他人员库，该人员的描述信息不会被复制。单个人员最多只能同时存在100个人员库中。
    
    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下最多创建2万个人员库（Group）、最多包含1000万张人脸（Face），单个人员库（Group）最多包含100万张人脸（Face）。
    
    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
```
    删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除。注：删除人员库的操作为异步执行，删除单张人脸时间约为10ms，即一小时内可以删除36万张。删除期间，无法向该人员库添加人员。
    
    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
  - DetectLiveFace
```
public DetectLiveFaceResponse DetectLiveFace(DetectLiveFaceRequest req)
                                      throws TencentCloudSDKException
```
    用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。 > - 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - DetectLiveFaceRequest
    
    Returns:
    
    DetectLiveFaceResponse
    
    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
  - 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
  - SearchFaces
```
public SearchFacesResponse SearchFaces(SearchFacesRequest req)
                                throws TencentCloudSDKException
```
    用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，识别结果按照相似度从大到小排序。单次搜索的人员库人脸总数量不得超过 100 万张。此接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - SearchFacesRequest
    
    Returns:
    
    SearchFacesResponse
    
    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/32806)用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而[人脸比对](https://cloud.tencent.com/document/product/867/32802)用于判断两张人脸的相似度。 > - 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
    
    Parameters:
    
    req - VerifyFaceRequest
    
    Returns:
    
    VerifyFaceResponse
    
    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

AnalyzeFace

CompareFace

CopyPerson

CreateFace

CreateGroup

CreatePerson

DeleteFace

DeleteGroup

DeletePerson

DeletePersonFromGroup

DetectFace

DetectLiveFace

GetGroupList

GetPersonBaseInfo

GetPersonGroupInfo

GetPersonList

GetPersonListNum

ModifyGroup

ModifyPersonBaseInfo

ModifyPersonGroupInfo

SearchFaces

VerifyFace