2019-04-22百度ai相似图检索接口体验

快速入门

安装ImageSearch Java SDK

ImageSearch Java SDK目录结构

com.baidu.aip
├── auth //签名相关类
├── http //Http通信相关类
├── client //公用类
├── exception //exception类
├── imagesearch
│ └── AipImageSearch //AipImageSearch类
└── util //工具类

支持 JAVA版本：1.7+

查看源码

Java SDK代码现已公开，您可以查看代码、或者在License范围内修改和编译SDK以适配您的环境。 github链接：https://github.com/Baidu-AIP/java-sdk

使用maven依赖：

添加以下依赖即可。其中版本号可在maven官网查询

    com.baidu.aip
    java-sdk
    ${version}

直接使用JAR包步骤如下：

1.在官方网站下载Java SDK压缩工具包。

2.将下载的aip-java-sdk-version.zip解压后，复制到工程文件夹中。

3.在Eclipse右键“工程 -> Properties -> Java Build Path -> Add JARs”。

4.添加SDK工具包aip-java-sdk-version.jar和第三方依赖工具包json-20160810.jar log4j-1.2.17.jar。

其中，version为版本号，添加完成后，用户就可以在工程中使用ImageSearch Java SDK。
新建AipImageSearch
AipImageSearch是图像搜索的Java客户端，为使用图像搜索的开发人员提供了一系列的交互方法。

用户可以参考如下代码新建一个AipImageSearch,初始化完成后建议单例使用,避免重复获取access_token：

public class Sample {
//设置APPID/AK/SK
public static final String APP_ID = "你的 App ID";
public static final String API_KEY = "你的 Api Key";
public static final String SECRET_KEY = "你的 Secret Key";

public static void main(String[] args) {
    // 初始化一个AipImageSearch
    AipImageSearch client = new AipImageSearch(APP_ID, API_KEY, SECRET_KEY);

    // 可选：设置网络连接参数
    client.setConnectionTimeoutInMillis(2000);
    client.setSocketTimeoutInMillis(60000);

    // 可选：设置代理服务器地址, http和socket二选一，或者均不设置
    client.setHttpProxy("proxy_host", proxy_port);  // 设置http代理
    client.setSocketProxy("proxy_host", proxy_port);  // 设置socket代理

    // 可选：设置log4j日志输出格式，若不设置，则使用默认配置
    // 也可以直接通过jvm启动参数设置此环境变量
    System.setProperty("aip.log4j.conf", "path/to/your/log4j.properties");

    // 调用接口
    String path = "test.jpg";
    JSONObject res = client.sameHqSearch(path, new HashMap());
    System.out.println(res.toString(2));
    
}

}
其中示例的log4j.properties文件内容如下：

#可以设置级别：debug>info>error
#debug：显示debug、info、error
#info：显示info、error
#error：只error
log4j.rootLogger=debug,appender1
#log4j.rootLogger=info,appender1
#log4j.rootLogger=error,appender1

#输出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#样式为TTCCLayout
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout

#自定义样式
# %r 时间 0
# %t 方法名 main
# %p 优先级 DEBUG/INFO/ERROR
# %c 所属类的全名(包括包名)
# %l 发生的位置，在某个类的某行
# %m 输出代码中指定的讯息，如log(message)中的message
# %n 输出一个换行

log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%t][%p] -%l %m%n

在上面代码中，常量APP_ID在百度云控制台中创建，常量API_KEY与SECRET_KEY是在创建完毕应用后，系统分配给用户的，均为字符串，用于标识用户，为访问做签名验证，可在AI服务控制台中的应用列表中查看。

注意：如您以前是百度云的老用户，其中API_KEY对应百度云的“Access Key ID”，SECRET_KEY对应百度云的“Access Key Secret”。

配置AipImageSearch

如果用户需要配置AipImageSearch的一些细节参数，可以在构造AipImageSearch之后调用接口设置参数，目前只支持以下参数：

接口 说明

setConnectionTimeoutInMillis 建立连接的超时时间（单位：毫秒）
setSocketTimeoutInMillis 通过打开的连接传输数据的超时时间（单位：毫秒）
setHttpProxy 设置http代理服务器
setSocketProxy 设置socket代理服务器 （http和socket类型代理服务器只能二选一）

----------------------------------------------------分割线----------------------------------------------
以上都来源于百度sdk文档https://ai.baidu.com/docs#/ImageSearch-Java-SDK/top
，细节可以自己慢慢研究，我这里就类似图试别定义一些返回参数的规则。

相似图检索—入库

该接口实现单张图片入库，入库时需要同步提交图片及可关联至本地图库的摘要信息（具体变量为brief，具体可传入图片在本地标记id、图片url、图片名称等）；同时可提交分类维度信息（具体变量为tags，最多可传入2个tag），方便对图库中的图片进行管理、分类检索。**注：重复添加完全相同的图片会返回错误。

 HashMap options = new HashMap();
    options.put("brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}");
    options.put("tags", "100,11");

 // 参数为本地路径（图片不能大于4M,要写个方法判断一下）
    String image = "test.jpg";
    JSONObject res = client.similarAdd(image, options);
    System.out.println(res.toString(2));

值得注意的就hashmap的参数设置，是查找的返回json，别的都没啥难度。
这里相关参数暂时定个规则表,

类别	tag	brief（最长256B，处理成json对象）
失物：动物	2，7	{"name:物品名称，限定10个字， "describe:详细描述，限定40字","fileName:图片资源名称"}
失物：证件	2，14	{"name:校园卡， "describe:xx学院xx班小明同学丢失的校园卡，拾取于xxx"，"fileName:201909011234_fanka.jpg"}
失物：日用品	2，21	{"name:水杯， "describe:蓝色不锈钢水杯，拾取于阶梯教室"}
失物：急用	2，28	etc.
失物：贵重物品	2，35	etc.
失物：文件	2，42	etc.
其他	2，47	etc.

相似图检索—入库 返回数据参数详情

字段	是否必选	类型	说明
log_id	是	uint64	唯一的log id，用于问题定位
cont_sign	是	string	输入图片签名，可用于删除

相似图检索—入库 返回示例

{
    "log_id": 2263663554,
    "cont_sign": "4261577168,501945506"
}

相似图检索—检索

// 传入可选参数调用接口
    HashMap options = new HashMap();
    options.put("tags", "100,11");
    options.put("tag_logic", "0");
    options.put("pn", "100");
    options.put("rn", "250");
    

相似图检索—检索 请求参数详情

参数名称	是否必选	类型	说明
tags	否	String	1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索
tag_logic	否	String	检索时tag之间的逻辑， 0：逻辑and，1：逻辑or
pn	否	String	分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条
rn	否	String	分页功能，截取条数，例：250

分页一般获得个前十条就够了，数据太多，传输也慢。

相似图检索—检索 返回数据参数详情

字段	是否必选	类型	说明
log_id	是	uint64	唯一的log id，用于问题定位
result_num	是	uint32	检索结果数
result	是	object[]	结果数组
+cont_sign	是	string	图片签名，可以用来删除图片或定位问题
+score	是	float	图片相关性，0-1
+brief	是	string	add是添加的brief信息
has_more	是	bool	是否还有下一页，返回值：true、false； 如果不分页，不用关注该字段

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",//这里可以传文件信息，方便资源定位和查找，不论是在数据库还是本地
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

相似图检索—更新，删除(大部分代码类似，罗列核心代码)

 // 更新
    String image = "test.jpg";
    JSONObject res = client.similarUpdate(image, options);
// 删除
    String image = "test.jpg";
    JSONObject res = client.similarDeleteByImage(image, options);

还有个商品查找的功能，大致思想也是找同类的产品，在商铺类app里可以试着接入使用。

image.png

还有个商品查找的功能