com.baidu.aip.face

类 AipFace

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)

方法概要

限定符和类型	方法和说明
org.json.JSONObject	addGroupUser(String srcGroupId, String groupId, String uid, HashMap<String,String> options) 组间复制用户接口
org.json.JSONObject	addUser(String uid, String userInfo, String groupId, byte[] image, HashMap<String,String> options) 人脸注册接口
org.json.JSONObject	addUser(String uid, String userInfo, String groupId, String image, HashMap<String,String> options) 人脸注册接口
org.json.JSONObject	deleteGroupUser(String groupId, String uid, HashMap<String,String> options) 组内删除用户接口
org.json.JSONObject	deleteUser(String uid, HashMap<String,String> options) 人脸删除接口
org.json.JSONObject	detect(byte[] image, HashMap<String,String> options) 人脸检测接口
org.json.JSONObject	detect(String image, HashMap<String,String> options) 人脸检测接口
org.json.JSONObject	getGroupList(HashMap<String,String> options) 组列表查询接口
org.json.JSONObject	getGroupUsers(String groupId, HashMap<String,String> options) 组内用户列表查询接口
org.json.JSONObject	getUser(String uid, HashMap<String,String> options) 用户信息查询接口
org.json.JSONObject	identifyUser(String groupId, byte[] image, HashMap<String,String> options) 人脸识别接口
org.json.JSONObject	identifyUser(String groupId, String image, HashMap<String,String> options) 人脸识别接口
org.json.JSONObject	livenessVerify(byte[] imgData, HashMap<String,Object> options)
org.json.JSONObject	livenessVerify(String imgPath, HashMap<String,Object> options)
org.json.JSONObject	match(byte[][] images, HashMap<String,String> options) 人脸比对接口
org.json.JSONObject	match(List<String> images, HashMap<String,String> options) 人脸比对接口
org.json.JSONObject	multiIdentify(String groupId, byte[] image, HashMap<String,String> options) M:N 识别接口
org.json.JSONObject	multiIdentify(String groupId, String image, HashMap<String,String> options) M:N 识别接口
org.json.JSONObject	updateUser(String uid, String userInfo, String groupId, byte[] image, HashMap<String,String> options) 人脸更新接口
org.json.JSONObject	updateUser(String uid, String userInfo, String groupId, String image, HashMap<String,String> options) 人脸更新接口
org.json.JSONObject	verifyUser(String uid, String groupId, byte[] image, HashMap<String,String> options) 人脸认证接口
org.json.JSONObject	verifyUser(String uid, String groupId, String image, 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(byte[] image,
                                  HashMap<String,String> options)

人脸检测接口

参数:

image - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: max_face_num 最多处理人脸数目，默认值1 face_fields 包括age,beauty,expression,faceshape,gender,glasses,landmark,race,qualities信息，逗号分隔，默认只返回人脸框、概率和旋转角度

返回:

JSONObject

detect

public org.json.JSONObject detect(String image,
                                  HashMap<String,String> options)

人脸检测接口

参数:

image - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: max_face_num 最多处理人脸数目，默认值1 face_fields 包括age,beauty,expression,faceshape,gender,glasses,landmark,race,qualities信息，逗号分隔，默认只返回人脸框、概率和旋转角度

返回:

JSONObject

match

public org.json.JSONObject match(byte[][] images,
                                 HashMap<String,String> options)

人脸比对接口

参数:

images - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: ext_fields 返回质量信息，取值固定:目前支持qualities(质量检测)。(对所有图片都会做改处理) image_liveness 返回的活体信息，“faceliveness,faceliveness” 表示对比对的两张图片都做活体检测；“,faceliveness” 表示对第一张图片不做活体检测、第二张图做活体检测；“faceliveness,” 表示对第一张图片做活体检测、第二张图不做活体检测；
**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3** types 请求对比的两张图片的类型，示例：“7,13”
**12**表示带水印证件照：一般为带水印的小图，如公安网小图
**7**表示生活照：通常为手机、相机拍摄的人像图片、或从网络获取的人像图片等
**13**表示证件照片：如拍摄的身份证、工卡、护照、学生证等证件图片，**注**：需要确保人脸部分不可太小，通常为100px\*100px

返回:

JSONObject

match

public org.json.JSONObject match(List<String> images,
                                 HashMap<String,String> options)

人脸比对接口

参数:

images - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: ext_fields 返回质量信息，取值固定:目前支持qualities(质量检测)。(对所有图片都会做改处理) image_liveness 返回的活体信息，“faceliveness,faceliveness” 表示对比对的两张图片都做活体检测；“,faceliveness” 表示对第一张图片不做活体检测、第二张图做活体检测；“faceliveness,” 表示对第一张图片做活体检测、第二张图不做活体检测；
**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3** types 请求对比的两张图片的类型，示例：“7,13”
**12**表示带水印证件照：一般为带水印的小图，如公安网小图
**7**表示生活照：通常为手机、相机拍摄的人像图片、或从网络获取的人像图片等
**13**表示证件照片：如拍摄的身份证、工卡、护照、学生证等证件图片，**注**：需要确保人脸部分不可太小，通常为100px\*100px

返回:

JSONObject

identifyUser

public org.json.JSONObject identifyUser(String groupId,
                                        byte[] image,
                                        HashMap<String,String> options)

人脸识别接口

参数:

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: ext_fields 特殊返回信息，多个用逗号分隔，取值固定: 目前支持faceliveness(活体检测)。**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3** user_top_num 返回用户top数，默认为1，最多返回5个

返回:

JSONObject

identifyUser

public org.json.JSONObject identifyUser(String groupId,
                                        String image,
                                        HashMap<String,String> options)

人脸识别接口

参数:

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: ext_fields 特殊返回信息，多个用逗号分隔，取值固定: 目前支持faceliveness(活体检测)。**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3** user_top_num 返回用户top数，默认为1，最多返回5个

返回:

JSONObject

verifyUser

public org.json.JSONObject verifyUser(String uid,
                                      String groupId,
                                      byte[] image,
                                      HashMap<String,String> options)

人脸认证接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: top_num 返回用户top数，默认为1 ext_fields 特殊返回信息，多个用逗号分隔，取值固定: 目前支持faceliveness(活体检测)。**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3**

返回:

JSONObject

verifyUser

public org.json.JSONObject verifyUser(String uid,
                                      String groupId,
                                      String image,
                                      HashMap<String,String> options)

人脸认证接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: top_num 返回用户top数，默认为1 ext_fields 特殊返回信息，多个用逗号分隔，取值固定: 目前支持faceliveness(活体检测)。**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3**

返回:

JSONObject

multiIdentify

public org.json.JSONObject multiIdentify(String groupId,
                                         byte[] image,
                                         HashMap<String,String> options)

M:N 识别接口

参数:

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: ext_fields 特殊返回信息，多个用逗号分隔，取值固定: 目前支持faceliveness(活体检测)。**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3** detect_top_num 检测多少个人脸进行比对，默认值1（最对返回10个） user_top_num 返回识别结果top人数”，当同一个人有多张图片时，只返回比对最高的1个分数（即，scores参数只有一个值），默认为1（最多返回20个）

返回:

JSONObject

multiIdentify

public org.json.JSONObject multiIdentify(String groupId,
                                         String image,
                                         HashMap<String,String> options)

M:N 识别接口

参数:

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: ext_fields 特殊返回信息，多个用逗号分隔，取值固定: 目前支持faceliveness(活体检测)。**注：需要用于判断活体的图片，图片中的人脸像素面积需要不小于100px\*100px，人脸长宽与图片长宽比例，不小于1/3** detect_top_num 检测多少个人脸进行比对，默认值1（最对返回10个） user_top_num 返回识别结果top人数”，当同一个人有多张图片时，只返回比对最高的1个分数（即，scores参数只有一个值），默认为1（最多返回20个）

返回:

JSONObject

addUser

public org.json.JSONObject addUser(String uid,
                                   String userInfo,
                                   String groupId,
                                   byte[] image,
                                   HashMap<String,String> options)

人脸注册接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

userInfo - - 用户资料，长度限制256B

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: action_type 参数包含append、replace。**如果为“replace”，则每次注册时进行替换replace（新增或更新）操作，默认为append操作**。例如：uid在库中已经存在时，对此uid重复注册时，新注册的图片默认会**追加**到该uid下，如果手动选择`action_type:replace`，则会用新图替换库中该uid下所有图片。

返回:

JSONObject

addUser

public org.json.JSONObject addUser(String uid,
                                   String userInfo,
                                   String groupId,
                                   String image,
                                   HashMap<String,String> options)

人脸注册接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

userInfo - - 用户资料，长度限制256B

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

image - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: action_type 参数包含append、replace。**如果为“replace”，则每次注册时进行替换replace（新增或更新）操作，默认为append操作**。例如：uid在库中已经存在时，对此uid重复注册时，新注册的图片默认会**追加**到该uid下，如果手动选择`action_type:replace`，则会用新图替换库中该uid下所有图片。

返回:

JSONObject

updateUser

public org.json.JSONObject updateUser(String uid,
                                      String userInfo,
                                      String groupId,
                                      byte[] image,
                                      HashMap<String,String> options)

人脸更新接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

userInfo - - 用户资料，长度限制256B

groupId - - 更新指定groupid下uid对应的信息

image - - 二进制图像数据

options - - 可选参数对象，key: value都为string类型 options - options列表: action_type 目前仅支持replace，uid不存在时，不报错，会自动变为注册操作；未选择该参数时，如果uid不存在会提示错误

返回:

JSONObject

updateUser

public org.json.JSONObject updateUser(String uid,
                                      String userInfo,
                                      String groupId,
                                      String image,
                                      HashMap<String,String> options)

人脸更新接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

userInfo - - 用户资料，长度限制256B

groupId - - 更新指定groupid下uid对应的信息

image - - 本地图片路径

options - - 可选参数对象，key: value都为string类型 options - options列表: action_type 目前仅支持replace，uid不存在时，不报错，会自动变为注册操作；未选择该参数时，如果uid不存在会提示错误

返回:

JSONObject

deleteUser

public org.json.JSONObject deleteUser(String uid,
                                      HashMap<String,String> options)

人脸删除接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

options - - 可选参数对象，key: value都为string类型 options - options列表: group_id 删除指定groupid下uid对应的信息

返回:

JSONObject

getUser

public org.json.JSONObject getUser(String uid,
                                   HashMap<String,String> options)

用户信息查询接口

参数:

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

options - - 可选参数对象，key: value都为string类型 options - options列表: group_id 选择指定group_id则只查找group列表下的uid内容，如果不指定则查找所有group下对应uid的信息

返回:

JSONObject

getGroupList

public org.json.JSONObject getGroupList(HashMap<String,String> options)

组列表查询接口

参数:

options - - 可选参数对象，key: value都为string类型 options - options列表: start 默认值0，起始序号 end 返回数量，默认值100，最大值1000

返回:

JSONObject

getGroupUsers

public org.json.JSONObject getGroupUsers(String groupId,
                                         HashMap<String,String> options)

组内用户列表查询接口

参数:

groupId - - 用户组id（由数字、字母、下划线组成），长度限制128B

options - - 可选参数对象，key: value都为string类型 options - options列表: start 默认值0，起始序号 end 返回数量，默认值100，最大值1000

返回:

JSONObject

addGroupUser

public org.json.JSONObject addGroupUser(String srcGroupId,
                                        String groupId,
                                        String uid,
                                        HashMap<String,String> options)

组间复制用户接口

参数:

srcGroupId - - 从指定group里复制信息

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

options - - 可选参数对象，key: value都为string类型 options - options列表:

返回:

JSONObject

deleteGroupUser

public org.json.JSONObject deleteGroupUser(String groupId,
                                           String uid,
                                           HashMap<String,String> options)

组内删除用户接口

参数:

groupId - - 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group\_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。**注：group无需单独创建，注册用户时则会自动创建group。**
**产品建议**：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率

uid - - 用户id（由数字、字母、下划线组成），长度限制128B

options - - 可选参数对象，key: value都为string类型 options - options列表:

返回:

JSONObject

livenessVerify

public org.json.JSONObject livenessVerify(String imgPath,
                                          HashMap<String,Object> options)

livenessVerify

public org.json.JSONObject livenessVerify(byte[] imgData,
                                          HashMap<String,Object> options)