AipFace (aip-java-sdk 4.11.3 API)

java.lang.Object
- com.baidu.aip.client.BaseClient
- - com.baidu.aip.face.AipFace

```
public class AipFace
extends BaseClient
```

字段概要
- 从类继承的字段 com.baidu.aip.client.BaseClient
  accessToken, aipKey, aipToken, appId, config, expireDate, isAuthorized, isBceKey, LOGGER, state

构造器概要

构造器
构造器和说明

AipFace(String appId, String apiKey, String secretKey)

构造器
构造器和说明
`AipFace(String appId, String apiKey, String secretKey)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`org.json.JSONObject`	`addUser(String image, String imageType, String groupId, String userId, HashMap<String,String> options)` 人脸注册接口
`org.json.JSONObject`	`deleteUser(String groupId, String userId, HashMap<String,String> options)` 删除用户接口
`org.json.JSONObject`	`detect(String image, String imageType, HashMap<String,String> options)` 人脸检测接口
`org.json.JSONObject`	`faceDelete(String userId, String groupId, String faceToken, HashMap<String,String> options)` 人脸删除接口
`org.json.JSONObject`	`faceGetlist(String userId, String groupId, HashMap<String,String> options)` 获取用户人脸列表接口
`org.json.JSONObject`	`faceverify(List<FaceVerifyRequest> input)` 在线活体检测接口
`org.json.JSONObject`	`getGroupList(HashMap<String,String> options)` 组列表查询接口
`org.json.JSONObject`	`getGroupUsers(String groupId, HashMap<String,String> options)` 获取用户列表接口
`org.json.JSONObject`	`getUser(String userId, String groupId, HashMap<String,String> options)` 用户信息查询接口
`org.json.JSONObject`	`groupAdd(String groupId, HashMap<String,String> options)` 创建用户组接口
`org.json.JSONObject`	`groupDelete(String groupId, HashMap<String,String> options)` 删除用户组接口
`org.json.JSONObject`	`idMatch(String idCardNum, String name, HashMap<String,Object> options)` 身份证与名字比对接口
`org.json.JSONObject`	`match(List<MatchRequest> input)` 人脸对比接口两张人脸图片相似度对比：比对两张图片中人脸的相似度，并返回相似度分值
`org.json.JSONObject`	`multiSearch(String image, String imageType, String groupIdList, HashMap<String,String> options)` 人脸搜索 M:N 识别接口
`org.json.JSONObject`	`personVerify(String image, String imageType, String idCardNumber, String name, HashMap<String,String> options)` 身份验证接口
`org.json.JSONObject`	`search(String image, String imageType, String groupIdList, HashMap<String,String> options)` 人脸搜索接口
`org.json.JSONObject`	`updateUser(String image, String imageType, String groupId, String userId, HashMap<String,String> options)` 人脸更新接口
`org.json.JSONObject`	`userCopy(String userId, HashMap<String,String> options)` 复制用户接口
`org.json.JSONObject`	`videoFaceliveness(String sessionId, byte[] video, HashMap<String,String> options)` 视频活体检测接口接口
`org.json.JSONObject`	`videoFaceliveness(String sessionId, String video, HashMap<String,String> options)` 视频活体检测接口接口
`org.json.JSONObject`	`videoSessioncode(HashMap<String,String> options)` 语音校验码接口接口

从类继承的方法 com.baidu.aip.client.BaseClient
getAccessToken, needAuth, postOperation, preOperation, requestServer, setConnectionTimeoutInMillis, setHttpProxy, setSocketProxy, setSocketTimeoutInMillis

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AipFace
```
public AipFace(String appId,
               String apiKey,
               String secretKey)
```
- 方法详细资料
  - detect
```
public org.json.JSONObject detect(String image,
                                  String imageType,
                                  HashMap<String,String> options)
```
    人脸检测接口
    
    参数:
    
    image - - 图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断
    
    imageType - - 图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: face_field 包括**age,beauty,expression,face_shape,gender,glasses,landmark,landmark72，landmark150，race,quality,eye_status,emotion,face_type信息**
    逗号分隔. 默认只返回face_token、人脸框、概率和旋转角度 max_face_num 最多处理人脸的数目，默认值为1，仅检测图片中面积最大的那个人脸；**最大值10**，检测图片中面积最大的几张人脸。 face_type 人脸的类型 **LIVE**表示生活照：通常为手机、相机拍摄的人像图片、或从网络获取的人像图片等**IDCARD**表示身份证芯片照：二代身份证内置芯片中的人像照片 **WATERMARK**表示带水印证件照：一般为带水印的小图，如公安网小图 **CERT**表示证件照片：如拍摄的身份证、工卡、护照、学生证等证件图片默认**LIVE** liveness_control 活体检测控制 **NONE**: 不进行控制 **LOW**:较低的活体要求(高通过率低攻击拒绝率) **NORMAL**: 一般的活体要求(平衡的攻击拒绝率, 通过率) **HIGH**: 较高的活体要求(高攻击拒绝率低通过率) **默认NONE**
    
    返回:
    
    JSONObject
  - search
```
public org.json.JSONObject search(String image,
                                  String imageType,
                                  String groupIdList,
                                  HashMap<String,String> options)
```
    人脸搜索接口
    
    参数:
    
    image - - 图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断
    
    imageType - - 图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个
    
    groupIdList - - 从指定的group中进行查找用逗号分隔，**上限20个**
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: max_face_num 最多处理人脸的数目
    **默认值为1(仅检测图片中面积最大的那个人脸)** **最大值10** match_threshold 匹配阈值（设置阈值后，score低于此阈值的用户信息将不会返回）最大100 最小0 默认80
    **此阈值设置得越高，检索速度将会越快，推荐使用默认阈值`80`** quality_control 图片质量控制 **NONE**: 不进行控制 **LOW**:较低的质量要求 **NORMAL**: 一般的质量要求 **HIGH**: 较高的质量要求 **默认 NONE** liveness_control 活体检测控制 **NONE**: 不进行控制 **LOW**:较低的活体要求(高通过率低攻击拒绝率) **NORMAL**: 一般的活体要求(平衡的攻击拒绝率, 通过率) **HIGH**: 较高的活体要求(高攻击拒绝率低通过率) **默认NONE** user_id 当需要对特定用户进行比对时，指定user_id进行比对。即人脸认证功能。 max_user_num 查找后返回的用户数量。返回相似度最高的几个用户，默认为1，最多返回50个。
    
    返回:
    
    JSONObject
  - multiSearch
```
public org.json.JSONObject multiSearch(String image,
                                       String imageType,
                                       String groupIdList,
                                       HashMap<String,String> options)
```
    人脸搜索 M:N 识别接口
    
    参数:
    
    image - - 图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断
    
    imageType - - 图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个
    
    groupIdList - - 从指定的group中进行查找用逗号分隔，**上限20个**
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: max_face_num 最多处理人脸的数目
    **默认值为1(仅检测图片中面积最大的那个人脸)** **最大值10** match_threshold 匹配阈值（设置阈值后，score低于此阈值的用户信息将不会返回）最大100 最小0 默认80
    **此阈值设置得越高，检索速度将会越快，推荐使用默认阈值`80`** quality_control 图片质量控制 **NONE**: 不进行控制 **LOW**:较低的质量要求 **NORMAL**: 一般的质量要求 **HIGH**: 较高的质量要求 **默认 NONE** liveness_control 活体检测控制 **NONE**: 不进行控制 **LOW**:较低的活体要求(高通过率低攻击拒绝率) **NORMAL**: 一般的活体要求(平衡的攻击拒绝率, 通过率) **HIGH**: 较高的活体要求(高攻击拒绝率低通过率) **默认NONE** max_user_num 查找后返回的用户数量。返回相似度最高的几个用户，默认为1，最多返回50个。
    
    返回:
    
    JSONObject
  - addUser
```
public org.json.JSONObject addUser(String image,
                                   String imageType,
                                   String groupId,
                                   String userId,
                                   HashMap<String,String> options)
```
    人脸注册接口
    
    参数:
    
    image - - 图片信息(总数据大小应小于10M)，图片上传方式根据image_type来判断。注：组内每个uid下的人脸图片数目上限为20张
    
    imageType - - 图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: user_info 用户资料，长度限制256B quality_control 图片质量控制 **NONE**: 不进行控制 **LOW**:较低的质量要求 **NORMAL**: 一般的质量要求 **HIGH**: 较高的质量要求 **默认 NONE** liveness_control 活体检测控制 **NONE**: 不进行控制 **LOW**:较低的活体要求(高通过率低攻击拒绝率) **NORMAL**: 一般的活体要求(平衡的攻击拒绝率, 通过率) **HIGH**: 较高的活体要求(高攻击拒绝率低通过率) **默认NONE** action_type 操作方式 APPEND: 当user_id在库中已经存在时，对此user_id重复注册时，新注册的图片默认会追加到该user_id下,REPLACE : 当对此user_id重复注册时,则会用新图替换库中该user_id下所有图片,默认使用APPEND
    
    返回:
    
    JSONObject
  - updateUser
```
public org.json.JSONObject updateUser(String image,
                                      String imageType,
                                      String groupId,
                                      String userId,
                                      HashMap<String,String> options)
```
    人脸更新接口
    
    参数:
    
    image - - 图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断
    
    imageType - - 图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个
    
    groupId - - 更新指定groupid下uid对应的信息
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: user_info 用户资料，长度限制256B quality_control 图片质量控制 **NONE**: 不进行控制 **LOW**:较低的质量要求 **NORMAL**: 一般的质量要求 **HIGH**: 较高的质量要求 **默认 NONE** liveness_control 活体检测控制 **NONE**: 不进行控制 **LOW**:较低的活体要求(高通过率低攻击拒绝率) **NORMAL**: 一般的活体要求(平衡的攻击拒绝率, 通过率) **HIGH**: 较高的活体要求(高攻击拒绝率低通过率) **默认NONE** action_type 操作方式 APPEND: 当user_id在库中已经存在时，对此user_id重复注册时，新注册的图片默认会追加到该user_id下,REPLACE : 当对此user_id重复注册时,则会用新图替换库中该user_id下所有图片,默认使用APPEND
    
    返回:
    
    JSONObject
  - faceDelete
```
public org.json.JSONObject faceDelete(String userId,
                                      String groupId,
                                      String faceToken,
                                      HashMap<String,String> options)
```
    人脸删除接口
    
    参数:
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    faceToken - - 需要删除的人脸图片token，（由数字、字母、下划线组成）长度限制64B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - getUser
```
public org.json.JSONObject getUser(String userId,
                                   String groupId,
                                   HashMap<String,String> options)
```
    用户信息查询接口
    
    参数:
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - faceGetlist
```
public org.json.JSONObject faceGetlist(String userId,
                                       String groupId,
                                       HashMap<String,String> options)
```
    获取用户人脸列表接口
    
    参数:
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - getGroupUsers
```
public org.json.JSONObject getGroupUsers(String groupId,
                                         HashMap<String,String> options)
```
    获取用户列表接口
    
    参数:
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: start 默认值0，起始序号 length 返回数量，默认值100，最大值1000
    
    返回:
    
    JSONObject
  - userCopy
```
public org.json.JSONObject userCopy(String userId,
                                    HashMap<String,String> options)
```
    复制用户接口
    
    参数:
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: src_group_id 从指定组里复制信息 dst_group_id 需要添加用户的组id
    
    返回:
    
    JSONObject
  - deleteUser
```
public org.json.JSONObject deleteUser(String groupId,
                                      String userId,
                                      HashMap<String,String> options)
```
    删除用户接口
    
    参数:
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    userId - - 用户id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - groupAdd
```
public org.json.JSONObject groupAdd(String groupId,
                                    HashMap<String,String> options)
```
    创建用户组接口
    
    参数:
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - groupDelete
```
public org.json.JSONObject groupDelete(String groupId,
                                       HashMap<String,String> options)
```
    删除用户组接口
    
    参数:
    
    groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - getGroupList
```
public org.json.JSONObject getGroupList(HashMap<String,String> options)
```
    组列表查询接口
    
    参数:
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: start 默认值0，起始序号 length 返回数量，默认值100，最大值1000
    
    返回:
    
    JSONObject
  - personVerify
```
public org.json.JSONObject personVerify(String image,
                                        String imageType,
                                        String idCardNumber,
                                        String name,
                                        HashMap<String,String> options)
```
    身份验证接口
    
    参数:
    
    image - - 图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断
    
    imageType - - 图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个
    
    idCardNumber - - 身份证号（真实身份证号号码）
    
    name - - utf8，姓名（真实姓名，和身份证号匹配）
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: quality_control 图片质量控制 **NONE**: 不进行控制 **LOW**:较低的质量要求 **NORMAL**: 一般的质量要求 **HIGH**: 较高的质量要求 **默认 NONE** liveness_control 活体检测控制 **NONE**: 不进行控制 **LOW**:较低的活体要求(高通过率低攻击拒绝率) **NORMAL**: 一般的活体要求(平衡的攻击拒绝率, 通过率) **HIGH**: 较高的活体要求(高攻击拒绝率低通过率) **默认NONE**
    
    返回:
    
    JSONObject
  - videoSessioncode
```
public org.json.JSONObject videoSessioncode(HashMap<String,String> options)
```
    语音校验码接口接口
    
    参数:
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: appid 百度云创建应用时的唯一标识ID
    
    返回:
    
    JSONObject
  - videoFaceliveness
```
public org.json.JSONObject videoFaceliveness(String sessionId,
                                             byte[] video,
                                             HashMap<String,String> options)
```
    视频活体检测接口接口
    
    参数:
    
    sessionId - - 语音校验码会话id，使用此接口的前提是已经调用了语音校验码接口
    
    video - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - videoFaceliveness
```
public org.json.JSONObject videoFaceliveness(String sessionId,
                                             String video,
                                             HashMap<String,String> options)
```
    视频活体检测接口接口
    
    参数:
    
    sessionId - - 语音校验码会话id，使用此接口的前提是已经调用了语音校验码接口
    
    video - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - match
```
public org.json.JSONObject match(List<MatchRequest> input)
```
    人脸对比接口两张人脸图片相似度对比：比对两张图片中人脸的相似度，并返回相似度分值
    
    参数:
    
    input - - 请求参数array image: 必须，图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断 imageType: 必须，图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个 faceType: 可选，人脸的类型 LIVE表示生活照：通常为手机、相机拍摄的人像图片、或从网络获取的人像图片等 IDCARD表示身份证芯片照：二代身份证内置芯片中的人像照片 WATERMARK表示带水印证件照：一般为带水印的小图，如公安网小图 CERT表示证件照片：如拍摄的身份证、工卡、护照、学生证等证件图片默认LIVE qualityControl: 可选，质量控制 NONE: 不进行控制 LOW:较低的质量要求 NORMAL: 一般的质量要求 HIGH: 较高的质量要求默认NONE livenessControl: 可选，活体控制 NONE: 不进行控制 LOW:较低的活体要求(高通过率低攻击拒绝率) NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率) HIGH: 较高的活体要求(高攻击拒绝率低通过率) 默认NONE
    
    返回:
    
    JSONObject
  - faceverify
```
public org.json.JSONObject faceverify(List<FaceVerifyRequest> input)
```
    在线活体检测接口
    
    参数:
    
    input - - 请求参数array image: 必须，图片信息(**总数据大小应小于10M**)，图片上传方式根据image_type来判断 imageType: 必须图片类型 **BASE64**:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；**URL**:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)**；FACE_TOKEN**: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个 face_field：可选包括age,beauty,expression,faceshape,gender,glasses,landmark,race,quality,facetype,parsing信息，逗号分隔，默认只返回face_token、活体数、人脸框、概率和旋转角度。
    
    返回:
    
    JSONObject
  - idMatch
```
public org.json.JSONObject idMatch(String idCardNum,
                                   String name,
                                   HashMap<String,Object> options)
```
    身份证与名字比对接口

类 AipFace

字段概要

从类继承的字段 com.baidu.aip.client.BaseClient

构造器概要

方法概要

从类继承的方法 com.baidu.aip.client.BaseClient

从类继承的方法 java.lang.Object

构造器详细资料

AipFace

方法详细资料

detect

search

multiSearch

addUser

updateUser

faceDelete

getUser

faceGetlist

getGroupUsers

userCopy

deleteUser

groupAdd

groupDelete

getGroupList

personVerify

videoSessioncode

videoFaceliveness

videoFaceliveness

match

faceverify

idMatch