\AipFace

Aip Base 基类

Summary

Methods

Properties

Constants

__construct()
getVersion()
setConnectionTimeoutInMillis()
setSocketTimeoutInMillis()
setProxies()
report()
detect()
match()
identifyUser()
verifyUser()
multiIdentify()
addUser()
updateUser()
deleteUser()
getUser()
getGroupList()
getGroupUsers()
addGroupUser()
deleteGroupUser()
personVerify()
faceverify()

No public properties found

No constants found

proccessRequest()
request()
multi_request()
validate()
proccessResult()
isPermission()

$accessTokenUrl
$reportUrl
$appId
$apiKey
$secretKey
$scope

N/A

getAuthFilePath()
writeAuthObj()
readAuthObj()
auth()
getAuthHeaders()

$detectUrl
$matchUrl
$identifyUrl
$verifyUrl
$multiIdentifyUrl
$userAddUrl
$userUpdateUrl
$userDeleteUrl
$userGetUrl
$groupGetlistUrl
$groupGetusersUrl
$groupAdduserUrl
$groupDeleteuserUrl
$personVerifyUrl
$faceverifyUrl

N/A

File: app/Libs/baidu_sdk/AipFace.php
Package: Default
Class hierarchy: \AipBase

\AipFace

Tags

None found

Properties

$accessTokenUrl

$accessTokenUrl : string

获取access token url

Type

string

$reportUrl

$reportUrl : string

反馈接口

Type

string

$appId

$appId : string

appId

Type

string

$apiKey

$apiKey : string

apiKey

Type

string

$secretKey

$secretKey : string

secretKey

Type

string

$scope

$scope : array

权限

Type

array

$detectUrl

$detectUrl : string

人脸检测 detect api url

Type

string

$matchUrl

$matchUrl : string

人脸比对 match api url

Type

string

$identifyUrl

$identifyUrl : string

人脸识别 identify api url

Type

string

$verifyUrl

$verifyUrl : string

人脸认证 verify api url

Type

string

$multiIdentifyUrl

$multiIdentifyUrl : string

M:N 识别 multi_identify api url

Type

string

$userAddUrl

$userAddUrl : string

人脸注册 user_add api url

Type

string

$userUpdateUrl

$userUpdateUrl : string

人脸更新 user_update api url

Type

string

$userDeleteUrl

$userDeleteUrl : string

人脸删除 user_delete api url

Type

string

$userGetUrl

$userGetUrl : string

用户信息查询 user_get api url

Type

string

$groupGetlistUrl

$groupGetlistUrl : string

组列表查询 group_getlist api url

Type

string

$groupGetusersUrl

$groupGetusersUrl : string

组内用户列表查询 group_getusers api url

Type

string

$groupAdduserUrl

$groupAdduserUrl : string

组间复制用户 group_adduser api url

Type

string

$groupDeleteuserUrl

$groupDeleteuserUrl : string

组内删除用户 group_deleteuser api url

Type

string

$personVerifyUrl

$personVerifyUrl : string

身份验证 person_verify api url

Type

string

$faceverifyUrl

$faceverifyUrl : string

在线活体检测 faceverify api url

Type

string

Methods

__construct()

__construct(string  $appId, string  $apiKey, string  $secretKey)

Parameters

string	$appId
string	$apiKey
string	$secretKey

getVersion()

getVersion() : string

查看版本

Returns

string

setConnectionTimeoutInMillis()

setConnectionTimeoutInMillis(integer  $ms)

连接超时

Parameters

integer

$ms

毫秒

setSocketTimeoutInMillis()

setSocketTimeoutInMillis(integer  $ms)

响应超时

Parameters

integer

$ms

毫秒

setProxies()

setProxies(  $proxies) : string

代理

Parameters

$proxies

Returns

string

report()

report(  $feedback) : array

反馈

Parameters

$feedback

Returns

array

detect()

detect(string  $image, array  $options = array()) : array

人脸检测接口

Parameters

string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: max_face_num 最多处理人脸数目，默认值1 face_fields 包括age,beauty,expression,faceshape,gender,glasses,landmark,race,qualities信息，逗号分隔，默认只返回人脸框、概率和旋转角度

match()

match(string  $images, array  $options = array()) : array

人脸比对接口

Parameters

string	$images	base64编码后的多张图片数据，半角逗号分隔，单次请求总共最大20M
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description

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

identifyUser()

identifyUser(string  $groupId, string  $image, array  $options = array()) : array

人脸识别接口

Parameters

string	$groupId	用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。注：group无需单独创建，注册用户时则会自动创建group。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率
string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

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

verifyUser()

verifyUser(string  $uid, string  $groupId, string  $image, array  $options = array()) : array

人脸认证接口

Parameters

string	$uid	用户id（由数字、字母、下划线组成），长度限制128B
string	$groupId	用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。注：group无需单独创建，注册用户时则会自动创建group。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率
string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

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

multiIdentify()

multiIdentify(string  $groupId, string  $image, array  $options = array()) : array

M:N 识别接口

Parameters

string	$groupId	用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。注：group无需单独创建，注册用户时则会自动创建group。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率
string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description

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

addUser()

addUser(string  $uid, string  $userInfo, string  $groupId, string  $image, array  $options = array()) : array

人脸注册接口

Parameters

string	$uid	用户id（由数字、字母、下划线组成），长度限制128B
string	$userInfo	用户资料，长度限制256B
string	$groupId	用户组id，标识一组用户（由数字、字母、下划线组成），长度限制128B。如果需要将一个uid注册到多个group下，group_id需要用多个逗号分隔，每个group_id长度限制为48个英文字符。注：group无需单独创建，注册用户时则会自动创建group。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率
string	$image	图像base64编码，每次仅支持单张图片，图片编码后大小不超过10M。为保证后续识别的效果较佳，建议注册的人脸，为用户正面人脸。
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

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

updateUser()

updateUser(string  $uid, string  $userInfo, string  $groupId, string  $image, array  $options = array()) : array

人脸更新接口

Parameters

string	$uid	用户id（由数字、字母、下划线组成），长度限制128B
string	$userInfo	用户资料，长度限制256B
string	$groupId	更新指定groupid下uid对应的信息
string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: action_type 目前仅支持replace，uid不存在时，不报错，会自动变为注册操作；未选择该参数时，如果uid不存在会提示错误

deleteUser()

deleteUser(string  $uid, array  $options = array()) : array

人脸删除接口

Parameters

string	$uid	用户id（由数字、字母、下划线组成），长度限制128B
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: group_id 删除指定groupid下uid对应的信息

getUser()

getUser(string  $uid, array  $options = array()) : array

用户信息查询接口

Parameters

string	$uid	用户id（由数字、字母、下划线组成），长度限制128B
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: group_id 选择指定group_id则只查找group列表下的uid内容，如果不指定则查找所有group下对应uid的信息

getGroupList()

getGroupList(array  $options = array()) : array

组列表查询接口

Parameters

array

$options

可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: start 默认值0，起始序号 num 返回数量，默认值100，最大值1000

getGroupUsers()

getGroupUsers(string  $groupId, array  $options = array()) : array

组内用户列表查询接口

Parameters

string	$groupId	用户组id（由数字、字母、下划线组成），长度限制128B
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: start 默认值0，起始序号 num 返回数量，默认值100，最大值1000

addGroupUser()

addGroupUser(string  $srcGroupId, string  $groupId, string  $uid, array  $options = array()) : array

组间复制用户接口

Parameters

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

Returns

array

Inherited from: \AipFace

Tags

description	options列表:

deleteGroupUser()

deleteGroupUser(string  $groupId, string  $uid, array  $options = array()) : array

组内删除用户接口

Parameters

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

Returns

array

Inherited from: \AipFace

Tags

description	options列表:

personVerify()

personVerify(string  $image, string  $idCardNumber, string  $name, array  $options = array()) : array

身份验证接口

Parameters

string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
string	$idCardNumber	身份证号（真实身份证号号码）。我们的服务端会做格式校验，并通过错误码返回，但是为了您的产品反馈体验更及时，建议在产品前端做一下号码格式校验与反馈
string	$name	utf8，姓名（真实姓名，和身份证号匹配）
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description

options列表: quality 判断图片中的人脸质量是否符合条件。use表示需要做质量控制，质量不符合条件的照片会被直接拒绝 quality_conf 人脸质量检测中每一项指标的具体阈值设定，json串形式，当指定quality:use时生效 faceliveness 判断活体值是否达标。use表示需要做活体检测，低于活体阈值的照片会直接拒绝 faceliveness_conf 人脸活体检测的阈值设定，json串形式，当指定faceliveness:use时生效。默认使用的阈值如下：{faceliveness：0.834963} ext_fields 可选项为faceliveness，qualities。选择具体的项，则返回参数中将会显示相应的扩展字段。如faceliveness表示返回结果中包含活体相关内容，qualities表示返回结果中包含质量检测相关内容

faceverify()

faceverify(string  $image, array  $options = array()) : array

在线活体检测接口

Parameters

string	$image	图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipFace

Tags

description	options列表: max_face_num 最多处理人脸数目，默认值1 face_fields 如不选择此项，返回结果默认只有人脸框、概率和旋转角度。可选参数为qualities、faceliveness。qualities：图片质量相关判断；faceliveness：活体判断。如果两个参数都需要选择，请使用半角逗号分隔。

proccessRequest()

proccessRequest(string  $url, array  $params, array  $data, array  $headers)

处理请求参数

Parameters

string	$url
array	$params
array	$data
array	$headers

request()

request(string  $url, mixed  $data,   $headers = array()) : mixed

Api 请求

Parameters

string	$url
mixed	$data
	$headers

Returns

mixed

multi_request()

multi_request(string  $url, mixed  $data) : mixed

Api 多个并发请求

Parameters

string	$url
mixed	$data

Returns

mixed

validate()

validate(string  $url, array  $data) : \mix

格式检查

Parameters

string	$url
array	$data

Returns

\mix

proccessResult()

proccessResult(  $content) : mixed

格式化结果

Parameters

$content

string

Returns

mixed

isPermission()

isPermission(array  $authObj) : boolean

判断认证是否有权限

Parameters

array

$authObj

Returns

boolean

getAuthFilePath()

getAuthFilePath() : string

返回 access token 路径

Returns

string

writeAuthObj()

writeAuthObj(array  $obj) : void

写入本地文件

Parameters

array

$obj

readAuthObj()

readAuthObj() : array

读取本地缓存

Returns

array

auth()

auth(boolean  $refresh = false) : array

认证

Parameters

boolean

$refresh

是否刷新

Returns

array

getAuthHeaders()

getAuthHeaders(string  $method, string  $url,   $params = array(),   $headers = array()) : array

Parameters

string	$method	HTTP method
string	$url
	$params
	$headers

Returns

array