net.gdface.sdk.fse

Class FeatureSeSpringController

java.lang.Object

net.gdface.sdk.fse.FeatureSeSpringController

@RestController
public class FeatureSeSpringController
extends java.lang.Object

特征码内存搜索引擎(feature search engine)接口
提供高速的人脸特征相似度比对搜索/排序,支持多线程并行搜索，适用于百万级以上人脸库的快速搜索。
1.使用 #addFeature(byte[], byte[], String)方法将特征添加到搜索引擎
2.使用 #searchCode(byte[], double, int)在内存中搜索与指定特征相似的的特征返回搜索结果

Author:

guyadong

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeatureSeSpringController.AddFeatureToFseArgs argClass-1 wrap arguments for method addFeature(AddFeatureToFseArgs)
static class	FeatureSeSpringController.AddFeatureToFseWithAppIdArgs argClass-2 wrap arguments for method addFeature(AddFeatureToFseWithAppIdArgs)
static class	FeatureSeSpringController.DefaultResponse FeatureSeSpringController.Response默认实现
static class	FeatureSeSpringController.DefaultResponseFactory FeatureSeSpringController.ResponseFactory接口默认实现
static class	FeatureSeSpringController.GetFeatureByHexFromFseArgs argClass-5 wrap arguments for method getFeatureByHex(GetFeatureByHexFromFseArgs)
static class	FeatureSeSpringController.GetFeatureFromFseArgs argClass-4 wrap arguments for method getFeature(GetFeatureFromFseArgs)
static interface	FeatureSeSpringController.InstanceSupplier 获取FeatureSe实例的接口， 用于应用层SPI方式提供FeatureSe实例
static class	FeatureSeSpringController.RemoveFeatureByHexFromFseArgs argClass-7 wrap arguments for method removeFeatureByHex(RemoveFeatureByHexFromFseArgs)
static class	FeatureSeSpringController.RemoveFeatureFromFseArgs argClass-6 wrap arguments for method removeFeature(RemoveFeatureFromFseArgs)
static interface	FeatureSeSpringController.Response web响应数据接口
static interface	FeatureSeSpringController.ResponseFactory 获取FeatureSeSpringController.Response接口实例的工厂类接口
static class	FeatureSeSpringController.SearchCodeFromFseArgs argClass-8 wrap arguments for method searchCode(SearchCodeFromFseArgs)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
FeatureSeSpringController()

Method Summary

Modifier and Type	Method and Description
FeatureSeSpringController.Response	addFeature(FeatureSeSpringController.AddFeatureToFseArgs args) 添加一条特征码到内存表
FeatureSeSpringController.Response	addFeature(FeatureSeSpringController.AddFeatureToFseWithAppIdArgs args) 添加一条特征码到内存表
FeatureSeSpringController.Response	clearAll() 删除内存表中所有特征数据
protected FeatureSe	delegate()
FeatureSeSpringController.Response	getFeature(FeatureSeSpringController.GetFeatureFromFseArgs args) 根据特征码ID在表中查找指定的记录
FeatureSeSpringController.Response	getFeatureByHex(FeatureSeSpringController.GetFeatureByHexFromFseArgs args) 根据特征码ID在表中查找指定的记录
FeatureSeSpringController.Response	removeFeature(FeatureSeSpringController.RemoveFeatureFromFseArgs args) 根据特征码ID中表中删除指定的记录
FeatureSeSpringController.Response	removeFeatureByHex(FeatureSeSpringController.RemoveFeatureByHexFromFseArgs args) 根据特征码ID中表中删除指定的记录
FeatureSeSpringController.Response	searchCode(FeatureSeSpringController.SearchCodeFromFseArgs args) 在内存表中根据比对相似度进行特征码搜索
static void	setInstanceSupplier(FeatureSeSpringController.InstanceSupplier instanceSupplier)
FeatureSeSpringController.Response	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DESCRIPTION

public static java.lang.String DESCRIPTION

Constructor Detail

FeatureSeSpringController

public FeatureSeSpringController()

Method Detail

setInstanceSupplier

public static void setInstanceSupplier(FeatureSeSpringController.InstanceSupplier instanceSupplier)

Parameters:

instanceSupplier - 要设置的 instanceSupplier

delegate

protected FeatureSe delegate()

Returns:

返回被装饰的FeatureSe实例

addFeature

@ResponseBody
 @RequestMapping(value="/FeatureSe/addFeatureToFse",
                method=POST)
public FeatureSeSpringController.Response addFeature(@RequestBody
                                                                                                                                                     FeatureSeSpringController.AddFeatureToFseArgs args)

添加一条特征码到内存表

Parameters:

featureId - 特征码ID(MD5校验码),为null时,native library会自动计算MD5作为特征码ID

feature - 特征码字节数组,为null时返回false

imgMD5 - 特征所属图的MD5(32字节HEX字符串),可为null

Returns:

添加成功返回true, 否则返回false

addFeature

@ResponseBody
 @RequestMapping(value="/FeatureSe/addFeatureToFseWithAppId",
                method=POST)
public FeatureSeSpringController.Response addFeature(@RequestBody
                                                                                                                                                              FeatureSeSpringController.AddFeatureToFseWithAppIdArgs args)

添加一条特征码到内存表

Parameters:

featureId - 特征码ID(MD5校验码),为null时,native library会自动计算MD5作为特征码ID

feature - 特征码字节数组,为null时返回false

appid - 应用id,由调用者定义,可为null

Returns:

添加成功返回true, 否则返回false

clearAll

@ResponseBody
 @RequestMapping(value="/FeatureSe/clearAllOfFse",
                method=POST)
public FeatureSeSpringController.Response clearAll()

删除内存表中所有特征数据

getFeature

@ResponseBody
 @RequestMapping(value="/FeatureSe/getFeatureFromFse",
                method=POST)
public FeatureSeSpringController.Response getFeature(@RequestBody
                                                                                                                                                       FeatureSeSpringController.GetFeatureFromFseArgs args)

根据特征码ID在表中查找指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(16 bytes)

Returns:

返回指定的特征记录,没有找到则返回null,featureId为null或空返回null

getFeatureByHex

@ResponseBody
 @RequestMapping(value="/FeatureSe/getFeatureByHexFromFse",
                method=POST)
public FeatureSeSpringController.Response getFeatureByHex(@RequestBody
                                                                                                                                                                 FeatureSeSpringController.GetFeatureByHexFromFseArgs args)

根据特征码ID在表中查找指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(32字节HEX字符串)

Returns:

返回指定的特征记录,没有找到则返回null,featureId为null或空返回null

removeFeature

@ResponseBody
 @RequestMapping(value="/FeatureSe/removeFeatureFromFse",
                method=POST)
public FeatureSeSpringController.Response removeFeature(@RequestBody
                                                                                                                                                             FeatureSeSpringController.RemoveFeatureFromFseArgs args)

根据特征码ID中表中删除指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(16 bytes)

Returns:

成功删除则返回true,否则返回false

removeFeatureByHex

@ResponseBody
 @RequestMapping(value="/FeatureSe/removeFeatureByHexFromFse",
                method=POST)
public FeatureSeSpringController.Response removeFeatureByHex(@RequestBody
                                                                                                                                                                       FeatureSeSpringController.RemoveFeatureByHexFromFseArgs args)

根据特征码ID中表中删除指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(32字节HEX字符串)

Returns:

成功删除则返回true,否则返回false

searchCode

@ResponseBody
 @RequestMapping(value="/FeatureSe/searchCodeFromFse",
                method=POST)
public FeatureSeSpringController.Response searchCode(@RequestBody
                                                                                                                                                       FeatureSeSpringController.SearchCodeFromFseArgs args)

在内存表中根据比对相似度进行特征码搜索

Parameters:

code - 要比对的特征码

sim - 相似度阀值

rows - 最大返回的记录数

Returns:

返回包含相似度(降序)的结果数组,如果没有查到匹配的记录则返回空数组

size

@ResponseBody
 @RequestMapping(value="/FeatureSe/sizeOfFse",
                method=POST)
public FeatureSeSpringController.Response size()

Returns:

内存表中元素个数