顾客识别SDK使用文档

本文档主要针对服务端SDK调用者，创迹AI开放平台需要购买后，下载SDK进行使用。本文以“顾客识别”能力为例，指引您开启开发之旅 。

1、顾客识别SDK配置文档

1.1 环境要求

1.1.1 依赖库

①Windows 平台需安装 vcredist2013 （注意区分 32 位和 64 位与算法库保持一致）

②Linux 平台需安装 glibc 2.17 库依赖及以上

1.1.2 兼容性

①x86、x64、linux64 三个版本

②支持 Win7，CentOS7，Ubuntu14.04及以上

1.2、SDK下载

具体操作请参照[SDK下载-SDK下载]，根据指南进行SDK下载。下载后进行解压路径如下：

|---libs
|     |---CustomerRecognizeSDK-1.0.0.jar 顾客识别SDK
|---CustomerRecognizeTest.java 代码演示文档

1.3、SDK接入配置

将CustomerRecognizeSDK-1.0.0.jar文件，放入项目中的libs文件夹中，并作为Library填入：

1.4、代码说明

文件解压后，找到其中的CustomerRecognizeTest.java文件，如下图：

接口依次有依赖关系，需权限认证通过，且初始化人脸引擎成功才可调用【顾客识别接口】，最后关闭人脸引擎：

①权限认证及初始化人脸引擎接口只需调用一次，不可重复调用

②顾客识别接口可重复调用

③关闭人脸引擎只调用一次，不可重复调用

1.5、注意事项

SDK是按照设备数来购买的，当一个设备使用成功后就减少一台次数，所以请合理安排设备，避免造成购买次数的浪费。

2、接口说明

2.1、鉴权接口

int authorizationOnline(String appKey, String secretKey, String serviceKey)
功能：进行权限认证。

2.2、人脸引擎初始化接口

int initEngine()
功能：进行人脸引擎初始化。

2.3、人脸特征提取接口

int extractFaceFeature(String imagePath, Feature out)
功能：给定一张图片地址进行人脸检测，并返回最主要的一张人脸特征。

参数：

Feature详细信息：

int extractFaceFeature(byte[] imageByteData, Feature out)
功能：给定的图片的byte数组进行人脸检测，并返回最主要的一张人脸特征。

参数：

Feature详细信息：

2.4、人脸比对接口

int compareFaceFeature(String sourceImagePath, String targetImagePath, Similar out)
功能：给定的两张图片的地址进行人脸检测，并返回两张人脸的相似度。

参数：

Similar详细信息：

int compareFaceFeature(byte[] sourceByteData, byte[] targetByteData, Similar out)
功能：给定的两张图片的byte数组进行人脸检测，并返回两张人脸的相似度。

参数：

Similar详细信息：

2.5、人脸搜索接口

int searchFaceFeature(String imagePath, List<Feature> featureList, int maxFaceNum, List<Search> out)
功能：提取给定图片主要一张人脸在人脸库查询相似度最高的人脸特征及特征ID;
支持1：N和M：N搜索（M最大支持5，N最大支持10000），人脸库：需要用户按照我们设定的规则封装人脸信息。

参数：

List<Search> out详细信息：

int searchFaceFeature(byte[] imageByteData, byte[] featureList, int maxFaceNum, List<Search> out)
功能：提取给定图片中主要一张人脸在人脸库查询相似度最高的人脸特征及特征ID;
支持1：N和M：N搜索（M最大支持5，N最大支持10000），人脸库：需要用户按照我们设定的规则封装人脸信息。

参数：

List<Search> out详细信息：

2.6人脸验证接口

int verifyFaceFeature(String imagePath, List<Feature> featureList, Similar out)
功能：用于判断“某人是否是某人”；判断给定图片中的主要一张人脸，是否是给定的身份，需要用户按照我们设定的规则封装人脸信息。

参数：

Similar详细信息：

int verifyFaceFeature(byte[] imageByteData, List<Feature> featureList, Similar out)
功能：用于判断“某人是否是某人”；判断给定图片中的主要一张人脸，是否是给定的身份，需要用户按照我们设定的规则封装人脸信息。

参数：

Similar详细信息：

2.7、人脸引擎关闭接口

CloseEngine()
功能：关闭人脸引擎（关闭一次即可，开启引擎与关闭引擎一一对应）。

3、信息码

• 顾客识别SDK使用文档
• 1.1、环境要求
• 1.2、SDK下载
• 1.3、SDK接入配置
• 2.1、鉴权接口
• 2.2、人脸引擎初始化接口
• 2.3、人脸特征提取接口
• 2.4、人脸比对接口
• 2.5、人脸搜索接口
• 2.6、人脸验证接口
• 3、信息码