FACE 文档
2017-08-23
2
目录
1 API参考
1.1 简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.1.1 接口能力 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.1.2 请求格式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.1.3 返回格式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.1.4 请求限制 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 调用方式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.1 调用方式一 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2 调用方式二 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3 人脸检测 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4 人脸比对 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
1
1
2
2
2
2
2
3
4
4
4
5
9
9
1.4.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.5 人脸识别 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.5.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.5.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.5.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
i
1.6 人脸认证 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.6.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.6.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.6.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.7 人脸注册 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.7.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.7.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.7.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.8 人脸更新 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.8.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.8.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.8.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.9 人脸删除 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.9.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.9.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.9.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.10 用户信息查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.10.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.10.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.10.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.11 组列表查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.11.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.11.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.11.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.12 组内用户列表查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.12.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.12.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.12.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
ii
1.13 组内添加用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.13.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.13.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.13.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.14 组内删除用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.14.1 接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.14.2 请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.14.3 返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.15 错误码 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2 C# SDK文档
35
2.0.1 依赖 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.1 快速入门 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.2 错误信息格式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.3 人脸检测 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.4 人脸比对 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.5 人脸查找 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.5.1 人脸注册 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.5.2 人脸更新 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.5.3 人脸删除 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
2.5.4 人脸认证 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
2.5.5 人脸识别 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.5.6 用户信息查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
2.5.7 组列表查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.5.8 组内用户列表查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.5.9 组内添加用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.5.10 组内删除用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
2.6 版本更新记录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
iii
3 Java SDK文档
55
3.1 简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.1.1 接口能力 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.1.2 版本更新记录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.2 快速入门 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
3.2.1 安装人脸检测 Java SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
3.2.2 新建AipFaceClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.2.3 配置AipFaceClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.3 接口调用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.3.1 人脸检测 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.3.2 人脸比对 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.3.3 人脸识别 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.3.4 人脸认证 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.3.5 人脸注册 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
iv
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.3.6 人脸更新 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.3.7 人脸删除 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.3.8 用户信息查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
3.3.9 组列表查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
3.3.10 组内用户列表查询 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.3.11 组间复制用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
3.3.12 组内删除用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
v
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.4 错误信息 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.4.1 错误返回格式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.4.2 错误码 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
4 Node SDK文档
81
4.1 简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4.1.1 接口能力 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4.1.2 版本更新记录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4.2 快速入门 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
4.2.1 安装人脸检测 Node SDK . . . . . . . . . . . . . . . . . . . . . . . . . . 82
4.2.2 新建AipFaceClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
4.3 接口调用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
4.3.1 人脸检测 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
4.3.2 人脸比对 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.3.3 人脸识别 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
返回说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
4.3.4 人脸认证 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
接口描述 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
请求说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
vi