TAipFace (taip 4.3.5 API)

java.lang.Object
- cn.xsshome.taip.base.BaseClient
- - cn.xsshome.taip.face.TAipFace

```
public class TAipFace
extends BaseClient
```
计算机视觉人脸识别模块

版本:

4.1.0

作者:

小帅丶

字段概要
- 从类继承的字段 cn.xsshome.taip.base.BaseClient
  app_id, app_key, config

构造器概要

构造器
构造器和说明

TAipFace(String app_id, String app_key)

构造器
构造器和说明
`TAipFace(String app_id, String app_key)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`String`	`detect(byte[] image)` 人脸检测与分析识别上传图像上面的人脸信息
`String`	`detect(String filePath)` 人脸检测与分析识别上传图像上面的人脸信息
`String`	`detectByUrl(String url)` 已过时。
`String`	`detectCrossage(byte[] source_image, byte[] target_image)` 跨年龄人脸识别上传两张人脸照，返回最相似的两张人脸及相似度。
`String`	`detectCrossage(String source_imagefilePath, String target_imagefilePath)` 跨年龄人脸识别上传两张人脸照，返回最相似的两张人脸及相似度。
`String`	`detectMulti(byte[] image)` 多人脸检测识别上传图像上面的人脸位置，支持多人脸识别。
`String`	`detectMulti(String filePath)` 多人脸检测识别上传图像上面的人脸位置，支持多人脸识别。
`String`	`faceAddfaceByFilePath(List<String> filePaths, String person_id, String tag)` 增加人脸(图片路径) 将一组人脸（Face）加入到一个个体（Person）中
`String`	`faceAddfaceByte(List<byte[]> images, String person_id, String tag)` 增加人脸(byte图片数据) 将一组人脸（Face）加入到一个个体（Person）中
`String`	`faceCompare(byte[] image_a, byte[] image_b)` 人脸对比对请求图片进行人脸对比
`String`	`faceCompare(String filePathA, String filePathB)` 人脸对比对请求图片进行人脸对比
`String`	`faceDelFace(String person_id, String face_ids)` 删除人脸从一个个体（Person）中删除一组人脸（Face）
`String`	`faceDelperson(String person_id)` 删除个体删除一个个体（Person）
`String`	`faceGetInfo(String person_id)` 获取信息获取一个个体（Person）的信息
`String`	`faceIdentify(byte[] image, String group_id, int topn)` 人脸识别对请求图片中的人脸进行识别
`String`	`faceIdentify(String filePath, String group_id, int topn)` 人脸识别对请求图片中的人脸进行识别
`String`	`faceNewperson(byte[] image, String group_ids, String person_id, String person_name)` 个体创建(必填参数) 创建一个个体（Person）
`String`	`faceNewperson(byte[] image, String group_ids, String person_id, String person_name, String tag)` 个体创建(全部参数) 创建一个个体（Person）
`String`	`faceNewperson(String filePath, String group_ids, String person_id, String person_name)` 个体创建(必填参数) 创建一个个体（Person）
`String`	`faceNewperson(String filePath, String group_ids, String person_id, String person_name, String tag)` 个体创建(全部参数) 创建一个个体（Person）
`String`	`faceSetInfo(String person_id, String person_name, String tag)` 设置信息设置个体（Person）的名字或备注
`String`	`faceShape(byte[] image)` 五官定位对请求图片进行五官定位
`String`	`faceShape(String filePath)` 五官定位对请求图片进行五官定位
`String`	`faceVerify(byte[] image, String person_id)` 人脸验证对请求图片进行人脸验证
`String`	`faceVerify(String filePath, String person_id)` 人脸验证对请求图片进行人脸验证
`String`	`getFaceIds(String person_id)` 获取人脸列表根据个体（Person）ID 获取人脸（Face）ID列表
`String`	`getFaceInfo(String face_id)` 获取人脸信息根据人脸（Face）ID 获取人脸（Face）信息
`String`	`getGroupIds()` 获取组列表获取应用下所有的组（Group）ID列表获取一个AppId下所有Group ID
`String`	`getPersonIds(String group_id)` 获取个体列表获取一个组（Group）中的所有个体（Person）ID

从类继承的方法 cn.xsshome.taip.base.BaseClient
requestServer, setConnectionTimeoutInMillis, setHttpProxy, setSocketProxy, setSocketTimeoutInMillis

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

- 构造器详细资料
  - TAipFace
```
public TAipFace(String app_id,
                String app_key)
```
- 方法详细资料
  - detect
```
public String detect(byte[] image)
              throws Exception
```
    人脸检测与分析识别上传图像上面的人脸信息
    
    参数:
    
    image - - 二进制图像数据
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - detectByUrl
```
@Deprecated
public String detectByUrl(String url)
                                throws Exception
```
    已过时。
    
    人脸检测与分析识别上传图像上面的人脸信息暂时不可以使用
    
    参数:
    
    url - - 图像网络地址
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - detect
```
public String detect(String filePath)
              throws Exception
```
    人脸检测与分析识别上传图像上面的人脸信息
    
    参数:
    
    filePath - - 本地路径图像文件
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - detectMulti
```
public String detectMulti(byte[] image)
                   throws Exception
```
    多人脸检测识别上传图像上面的人脸位置，支持多人脸识别。
    
    参数:
    
    image - - 二进制图像数据
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - detectMulti
```
public String detectMulti(String filePath)
                   throws Exception
```
    多人脸检测识别上传图像上面的人脸位置，支持多人脸识别。
    
    参数:
    
    filePath - - 本地路径图像文件
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceCompare
```
public String faceCompare(byte[] image_a,
                          byte[] image_b)
                   throws Exception
```
    人脸对比对请求图片进行人脸对比
    
    参数:
    
    image_a - - 二进制图像数据A
    
    image_b - - 二进制图像数据B
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceCompare
```
public String faceCompare(String filePathA,
                          String filePathB)
                   throws Exception
```
    人脸对比对请求图片进行人脸对比
    
    参数:
    
    filePathA - - 本地路径图像文件A
    
    filePathB - - 本地路径图像文件B
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - detectCrossage
```
public String detectCrossage(byte[] source_image,
                             byte[] target_image)
                      throws Exception
```
    跨年龄人脸识别上传两张人脸照，返回最相似的两张人脸及相似度。
    
    参数:
    
    source_image - - 二进制待比较图片图像数据
    
    target_image - - 二进制待比较图片图像数据
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - detectCrossage
```
public String detectCrossage(String source_imagefilePath,
                             String target_imagefilePath)
                      throws Exception
```
    跨年龄人脸识别上传两张人脸照，返回最相似的两张人脸及相似度。
    
    参数:
    
    source_imagefilePath - - 本地路径待比较图片图像文件
    
    target_imagefilePath - - 本地路径待比较图片图像文件
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceShape
```
public String faceShape(byte[] image)
                 throws Exception
```
    五官定位对请求图片进行五官定位
    
    参数:
    
    image - - 二进制图像数据
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceShape
```
public String faceShape(String filePath)
                 throws Exception
```
    五官定位对请求图片进行五官定位
    
    参数:
    
    filePath - - 本地路径图像文件
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceIdentify
```
public String faceIdentify(byte[] image,
                           String group_id,
                           int topn)
                    throws Exception
```
    人脸识别对请求图片中的人脸进行识别
    
    参数:
    
    image - 二进制图像数据
    
    group_id - 候选人组ID（个体创建时设定）
    
    topn - 返回的候选人个数
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceIdentify
```
public String faceIdentify(String filePath,
                           String group_id,
                           int topn)
                    throws Exception
```
    人脸识别对请求图片中的人脸进行识别
    
    参数:
    
    filePath - 本地路径图像文件
    
    group_id - 候选人组ID（个体创建时设定）
    
    topn - 返回的候选人个数
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceVerify
```
public String faceVerify(byte[] image,
                         String person_id)
                  throws Exception
```
    人脸验证对请求图片进行人脸验证
    
    参数:
    
    image - 二进制图像数据
    
    person_id - 待验证的个体
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceVerify
```
public String faceVerify(String filePath,
                         String person_id)
                  throws Exception
```
    人脸验证对请求图片进行人脸验证
    
    参数:
    
    filePath - 本地路径图像文件
    
    person_id - 待验证的个体
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceNewperson
```
public String faceNewperson(byte[] image,
                            String group_ids,
                            String person_id,
                            String person_name,
                            String tag)
                     throws Exception
```
    个体创建(全部参数) 创建一个个体（Person）
    
    参数:
    
    image - 二进制图像数据
    
    group_ids - 组id 可以是多个 eg:group01|group02
    
    person_id - 指定的个体id
    
    person_name - 个体名字
    
    tag - 备注信息
    
    返回:
    
    抛出:
    
    Exception
  - faceNewperson
```
public String faceNewperson(String filePath,
                            String group_ids,
                            String person_id,
                            String person_name,
                            String tag)
                     throws Exception
```
    个体创建(全部参数) 创建一个个体（Person）
    
    参数:
    
    filePath - 本地路径图像文件
    
    group_ids - 组id 可以是多个 eg:group01|group02
    
    person_id - 指定的个体id
    
    person_name - 个体名字
    
    tag - 备注信息
    
    返回:
    
    抛出:
    
    Exception
  - faceNewperson
```
public String faceNewperson(byte[] image,
                            String group_ids,
                            String person_id,
                            String person_name)
                     throws Exception
```
    个体创建(必填参数) 创建一个个体（Person）
    
    参数:
    
    image - 二进制图像数据
    
    group_ids - 组id 可以是多个 eg:group01|group02
    
    person_id - 指定的个体id
    
    person_name - 个体名字
    
    返回:
    
    抛出:
    
    Exception
  - faceNewperson
```
public String faceNewperson(String filePath,
                            String group_ids,
                            String person_id,
                            String person_name)
                     throws Exception
```
    个体创建(必填参数) 创建一个个体（Person）
    
    参数:
    
    filePath - 本地路径图像文件
    
    group_ids - 组id 可以是多个 eg:group01|group02
    
    person_id - 指定的个体id
    
    person_name - 个体名字
    
    返回:
    
    抛出:
    
    Exception
  - faceDelperson
```
public String faceDelperson(String person_id)
                     throws Exception
```
    删除个体删除一个个体（Person）
    
    参数:
    
    person_id - 需要删除的个体（Person）ID
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceAddfaceByte
```
public String faceAddfaceByte(List<byte[]> images,
                              String person_id,
                              String tag)
                       throws Exception
```
    增加人脸(byte图片数据) 将一组人脸（Face）加入到一个个体（Person）中
    
    参数:
    
    images - 多个|单个图片的byte数据
    
    person_id - 指定的个体（Person）ID
    
    tag - 备注信息
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceAddfaceByFilePath
```
public String faceAddfaceByFilePath(List<String> filePaths,
                                    String person_id,
                                    String tag)
                             throws Exception
```
    增加人脸(图片路径) 将一组人脸（Face）加入到一个个体（Person）中
    
    参数:
    
    filePaths - 多个|单个图片本地路径
    
    person_id - 指定的个体（Person）ID
    
    tag - 备注信息
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceDelFace
```
public String faceDelFace(String person_id,
                          String face_ids)
                   throws Exception
```
    删除人脸从一个个体（Person）中删除一组人脸（Face）
    
    参数:
    
    person_id - 需要删除的个体（Person）ID
    
    face_ids - 需要删除的人脸（Face）ID（多个之间用“\
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceSetInfo
```
public String faceSetInfo(String person_id,
                          String person_name,
                          String tag)
                   throws Exception
```
    设置信息设置个体（Person）的名字或备注
    
    参数:
    
    person_id - 需要设置的个体（Person）ID
    
    person_name - 新的名字
    
    tag - 备注信息
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - faceGetInfo
```
public String faceGetInfo(String person_id)
                   throws Exception
```
    获取信息获取一个个体（Person）的信息
    
    参数:
    
    person_id - 需要查询的个体（Person）ID
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - getGroupIds
```
public String getGroupIds()
                   throws Exception
```
    获取组列表获取应用下所有的组（Group）ID列表获取一个AppId下所有Group ID
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - getPersonIds
```
public String getPersonIds(String group_id)
                    throws Exception
```
    获取个体列表获取一个组（Group）中的所有个体（Person）ID
    
    参数:
    
    group_id - 组（Group）ID
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - getFaceIds
```
public String getFaceIds(String person_id)
                  throws Exception
```
    获取人脸列表根据个体（Person）ID 获取人脸（Face）ID列表
    
    参数:
    
    person_id - 个体（Person）ID
    
    返回:
    
    String
    
    抛出:
    
    Exception
  - getFaceInfo
```
public String getFaceInfo(String face_id)
                   throws Exception
```
    获取人脸信息根据人脸（Face）ID 获取人脸（Face）信息
    
    参数:
    
    face_id - 人脸（Face） ID
    
    返回:
    
    String
    
    抛出:
    
    Exception

类 TAipFace

字段概要

从类继承的字段 cn.xsshome.taip.base.BaseClient

构造器概要

方法概要

从类继承的方法 cn.xsshome.taip.base.BaseClient

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

构造器详细资料

TAipFace

方法详细资料

detect

detectByUrl

detect

detectMulti

detectMulti

faceCompare

faceCompare

detectCrossage

detectCrossage

faceShape

faceShape

faceIdentify

faceIdentify

faceVerify

faceVerify

faceNewperson

faceNewperson

faceNewperson

faceNewperson

faceDelperson

faceAddfaceByte

faceAddfaceByFilePath

faceDelFace

faceSetInfo

faceGetInfo

getGroupIds

getPersonIds

getFaceIds

getFaceInfo