接口说明
相同图检索—入库
该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**
1$image = file_get_contents('example.jpg');
2$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
3
4// 调用相同图检索—入库, 图片参数为本地图片
5$client->sameHqAdd($image, $brief);
6
7// 如果有可选参数
8$options = array();
9$options["tags"] = "100,11";
10
11// 带参数调用相同图检索—入库, 图片参数为本地图片
12$client->sameHqAdd($image, $brief, $options);
13$url = "http//www.x.com/sample.jpg";
14
15$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
16
17// 调用相同图检索—入库, 图片参数为远程url图片
18$client->sameHqAddUrl($url, $brief);
19
20// 如果有可选参数
21$options = array();
22$options["tags"] = "100,11";
23
24// 带参数调用相同图检索—入库, 图片参数为远程url图片
25$client->sameHqAddUrl($url, $brief, $options);
相同图检索—入库 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| brief | 是 | string | 检索时原样带回,最长256B。 |
| tags | 否 | string | 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索 |
相同图检索—入库 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
| cont_sign | 是 | string | 输入图片签名,可用于删除 |
相同图检索—入库 返回示例
1{
2 "log_id": 2263663554,
3 "cont_sign": "4261577168,501945506"
4}
相同图检索—检索
完成入库后,可使用该接口实现相同图检索。支持传入指定分类维度(具体变量tags)进行检索,返回结果支持翻页(具体变量pn、rn)。**请注意,检索接口不返回原图,仅反馈当前填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。**
1$image = file_get_contents('example.jpg');
2
3// 调用相同图检索—检索, 图片参数为本地图片
4$client->sameHqSearch($image);
5
6// 如果有可选参数
7$options = array();
8$options["tags"] = "100,11";
9$options["tag_logic"] = "0";
10$options["pn"] = "100";
11$options["rn"] = "250";
12
13// 带参数调用相同图检索—检索, 图片参数为本地图片
14$client->sameHqSearch($image, $options);
15$url = "http//www.x.com/sample.jpg";
16
17// 调用相同图检索—检索, 图片参数为远程url图片
18$client->sameHqSearchUrl($url);
19
20// 如果有可选参数
21$options = array();
22$options["tags"] = "100,11";
23$options["tag_logic"] = "0";
24$options["pn"] = "100";
25$options["rn"] = "250";
26
27// 带参数调用相同图检索—检索, 图片参数为远程url图片
28$client->sameHqSearchUrl($url, $options);
相同图检索—检索 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| 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信息,为保证该结果有效性,请入库是填写有效可关联至本地图片库的有效id信息 |
| has_more | 是 | bool | 是否还有下一页,返回值:true、false;如果不分页,不用关注该字段 |
相同图检索—检索 返回示例
1{
2 "result_num": 1,
3 "result": [
4 {
5 "score": 0.97976700290421,
6 "brief": "./data/jay1.jpg",
7 "cont_sign": "475124309,1080176642"
8 }
9 ],
10 "log_id": 1968648150
11}
相同图检索—更新
更新图库中图片的摘要和分类信息(具体变量为brief、tags)
1 $image = file_get_contents('example.jpg');
2
3 // 调用相同图检索—更新, 图片参数为本地图片
4 $client->sameHqUpdate($image);
5
6 // 如果有可选参数
7 $options = array();
8 $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
9 $options["tags"] = "100,11";
10
11 // 带参数调用相同图检索—更新, 图片参数为本地图片
12 $client->sameHqUpdate($image, $options);
13 $url = "http//www.x.com/sample.jpg";
14
15 // 调用相同图检索—更新, 图片参数为远程url图片
16 $client->sameHqUpdateUrl($url);
17
18 // 如果有可选参数
19 $options = array();
20 $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
21 $options["tags"] = "100,11";
22
23 // 带参数调用相同图检索—更新, 图片参数为远程url图片
24 $client->sameHqUpdateUrl($url, $options);
25
26 // 带参数调用相同图检索—更新, 图片签名
27 $cont_sign="g988312421";
28 $client->sameHqUpdateContSign($cont_sign, $options);
相同图检索—更新 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| cont_sign | 三选一,优先级:image > url > cont_sign** ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 | ||
| brief | 否 | string | 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"} |
| tags | 否 | string | 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索 |
相同图检索—更新 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
相同图检索—更新 返回示例
1{
2 "log_id": 2263663554
3}
相同图检索—删除
删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign
1$image = file_get_contents('example.jpg');
2
3// 调用删除相同图,传入参数为图片
4$client->sameHqDeleteByImage($image);
5$url = "http//www.x.com/sample.jpg";
6
7// 调用删除相同图,图片参数为远程url图片
8$client->sameHqDeleteByUrl($url);
9$contSign = "8cnn32frvrr2cd901";
10
11// 调用删除相同图,传入参数为图片签名
12$client->sameHqDeleteBySign($contSign);
相同图检索—删除 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| cont_sign | 是 | string | 图片签名 |
相同图检索—删除 返回数据参数详情
| 参数 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| log_id | number | 是 | 请求标识码,随机数,唯一 | 507499361 |
相同图检索—删除 返回示例
1{
2 "log_id": 50488417
3}
相似图检索—入库
该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**
1$image = file_get_contents('example.jpg');
2$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
3
4// 调用相似图检索—入库, 图片参数为本地图片
5$client->similarAdd($image, $brief);
6
7// 如果有可选参数
8$options = array();
9$options["tags"] = "100,11";
10
11// 带参数调用相似图检索—入库, 图片参数为本地图片
12$client->similarAdd($image, $brief, $options);
13$url = "http//www.x.com/sample.jpg";
14
15$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
16
17// 调用相似图检索—入库, 图片参数为远程url图片
18$client->similarAddUrl($url, $brief);
19
20// 如果有可选参数
21$options = array();
22$options["tags"] = "100,11";
23
24// 带参数调用相似图检索—入库, 图片参数为远程url图片
25$client->similarAddUrl($url, $brief, $options);
相似图检索—入库 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| brief | 是 | string | 检索时原样带回,最长256B。 |
| tags | 否 | string | 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索 |
相似图检索—入库 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
| cont_sign | 是 | string | 输入图片签名,可用于删除 |
相似图检索—入库 返回示例
1{
2 "log_id": 2263663554,
3 "cont_sign": "4261577168,501945506"
4}
相似图检索—检索
完成入库后,可使用该接口实现相似图检索。支持传入指定分类维度(具体变量tags)进行检索,返回结果支持翻页(具体变量pn、rn)。**请注意,检索接口不返回原图,仅反馈当前填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。**
1$image = file_get_contents('example.jpg');
2
3// 调用相似图检索—检索, 图片参数为本地图片
4$client->similarSearch($image);
5
6// 如果有可选参数
7$options = array();
8$options["tags"] = "100,11";
9$options["tag_logic"] = "0";
10$options["pn"] = "100";
11$options["rn"] = "250";
12
13// 带参数调用相似图检索—检索, 图片参数为本地图片
14$client->similarSearch($image, $options);
15$url = "http//www.x.com/sample.jpg";
16
17// 调用相似图检索—检索, 图片参数为远程url图片
18$client->similarSearchUrl($url);
19
20// 如果有可选参数
21$options = array();
22$options["tags"] = "100,11";
23$options["tag_logic"] = "0";
24$options["pn"] = "100";
25$options["rn"] = "250";
26
27// 带参数调用相似图检索—检索, 图片参数为远程url图片
28$client->similarSearchUrl($url, $options);
相似图检索—检索 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| 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;如果不分页,不用关注该字段 |
相似图检索—检索 返回示例
1{
2 "result_num": 1,
3 "result": [
4 {
5 "score": 0.97976700290421,
6 "brief": "./data/jay1.jpg",
7 "cont_sign": "475124309,1080176642"
8 }
9 ],
10 "log_id": 1968648150
11}
相似图检索—更新
更新图库中图片的摘要和分类信息(具体变量为brief、tags)
1 $image = file_get_contents('example.jpg');
2
3 // 调用相似图检索—更新, 图片参数为本地图片
4 $client->similarUpdate($image);
5
6 // 如果有可选参数
7 $options = array();
8 $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
9 $options["tags"] = "100,11";
10
11 // 带参数调用相似图检索—更新, 图片参数为本地图片
12 $client->similarUpdate($image, $options);
13 $url = "http//www.x.com/sample.jpg";
14
15 // 调用相似图检索—更新, 图片参数为远程url图片
16 $client->similarUpdateUrl($url);
17
18 // 如果有可选参数
19 $options = array();
20 $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
21 $options["tags"] = "100,11";
22
23 // 带参数调用相似图检索—更新, 图片参数为远程url图片
24 $client->similarUpdateUrl($url, $options);
25
26 // 带参数调用相似图检索—更新, 图片签名
27 $cont_sign="g988312421";
28 $client->similarUpdateContSign($cont_sign, $options);
相似图检索—更新 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| cont_sign | 三选一,优先级:image > url > cont_sign** ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 | ||
| brief | 否 | string | 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"} |
| tags | 否 | string | 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索 |
相似图检索—更新 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
相似图检索—更新 返回示例
1{
2 "log_id": 2263663554
3}
相似图检索—删除
删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign
1$image = file_get_contents('example.jpg');
2
3// 调用删除相似图,传入参数为图片
4$client->similarDeleteByImage($image);
5$url = "http//www.x.com/sample.jpg";
6
7// 调用删除相似图,图片参数为远程url图片
8$client->similarDeleteByUrl($url);
9$contSign = "8cnn32frvrr2cd901";
10
11// 调用删除相似图,传入参数为图片签名
12$client->similarDeleteBySign($contSign);
相似图检索—删除 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| cont_sign | 是 | string | 图片签名 |
相似图检索—删除 返回数据参数详情
| 参数 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| log_id | number | 是 | 请求标识码,随机数,唯一 | 507499361 |
相似图检索—删除 返回示例
1{
2 "log_id": 50488417
3}
商品检索—入库
该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等)。同时可提交分类维度信息(具体变量为class_id1、class_id2),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**
1$image = file_get_contents('example.jpg');
2$brief = "{\"name\":\"手机\", \"id\":\"666\"}";
3
4// 调用商品检索—入库, 图片参数为本地图片
5$client->productAdd($image, $brief);
6
7// 如果有可选参数
8$options = array();
9$options["class_id1"] = 1;
10$options["class_id2"] = 1;
11
12// 带参数调用商品检索—入库, 图片参数为本地图片
13$client->productAdd($image, $brief, $options);
14$url = "http//www.x.com/sample.jpg";
15
16$brief = "{\"name\":\"手机\", \"id\":\"666\"}";
17
18// 调用商品检索—入库, 图片参数为远程url图片
19$client->productAddUrl($url, $brief);
20
21// 如果有可选参数
22$options = array();
23$options["class_id1"] = 1;
24$options["class_id2"] = 1;
25
26// 带参数调用商品检索—入库, 图片参数为远程url图片
27$client->productAddUrl($url, $brief, $options);
商品检索—入库 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| brief | 是 | string | 检索时原样带回,最长256B。请注意,检索接口不返回原图,仅反馈当前填写的brief信息,所以调用该入库接口时,brief信息请尽量填写可关联至本地图库的图片id或者图片url、图片名称等信息 |
| class_id1 | 否 | string | 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索 |
| class_id2 | 否 | string | 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索 |
商品检索—入库 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
| cont_sign | 是 | string | 输入图片签名,可用于删除 |
商品检索—入库 返回示例
1{
2 "log_id": 2263663554,
3 "cont_sign": "4261577168,501945506"
4}
商品检索—检索
完成入库后,可使用该接口实现商品检索。支持传入指定分类维度(具体变量class_id1、class_id2)进行检索,返回结果支持翻页(具体变量pn、rn)。**请注意,检索接口不返回原图,仅反馈当前填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息**
1$image = file_get_contents('example.jpg');
2
3// 调用商品检索—检索, 图片参数为本地图片
4$client->productSearch($image);
5
6// 如果有可选参数
7$options = array();
8$options["class_id1"] = 1;
9$options["class_id2"] = 1;
10$options["pn"] = "100";
11$options["rn"] = "250";
12
13// 带参数调用商品检索—检索, 图片参数为本地图片
14$client->productSearch($image, $options);
15$url = "http//www.x.com/sample.jpg";
16
17// 调用商品检索—检索, 图片参数为远程url图片
18$client->productSearchUrl($url);
19
20// 如果有可选参数
21$options = array();
22$options["class_id1"] = 1;
23$options["class_id2"] = 1;
24$options["pn"] = "100";
25$options["rn"] = "250";
26
27// 带参数调用商品检索—检索, 图片参数为远程url图片
28$client->productSearchUrl($url, $options);
商品检索—检索 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| class_id1 | 否 | string | 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索 |
| class_id2 | 否 | string | 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索 |
| 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;如果不分页,不用关注该字段 |
商品检索—检索 返回示例
1{
2 "result_num": 1,
3 "result": [
4 {
5 "score": 0.97976700290421,
6 "brief": "./data/mobile.jpg",
7 "cont_sign": "475124309,1080176642"
8 }
9 ],
10 "log_id": 1968648150
11}
商品检索—更新
更新图库中图片的摘要和分类信息(具体变量为brief、class_id1/class_id2)
1 $image = file_get_contents('example.jpg');
2
3 // 调用商品检索—更新, 图片参数为本地图片
4 $client->productUpdate($image);
5
6 // 如果有可选参数
7 $options = array();
8 $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
9 $options["class_id1"] = 1;
10 $options["class_id2"] = 1;
11
12 // 带参数调用商品检索—更新, 图片参数为本地图片
13 $client->productUpdate($image, $options);
14 $url = "http//www.x.com/sample.jpg";
15
16 // 调用商品检索—更新, 图片参数为远程url图片
17 $client->productUpdateUrl($url);
18
19 // 如果有可选参数
20 $options = array();
21 $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
22 $options["class_id1"] = 1;
23 $options["class_id2"] = 1;
24
25 // 带参数调用商品检索—更新, 图片参数为远程url图片
26 $client->productUpdateUrl($url, $options);
27 // 带参数调用商品检索—更新, 图片签名
28 $cont_sign="g988312421";
29 $client->productUpdateContSign($cont_sign, $options);
商品检索—更新 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| cont_sign | 三选一,优先级:image > url > cont_sign** ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 | ||
| brief | 否 | string | 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"} |
| class_id1 | 否 | string | 更新的商品分类1,支持1-60范围内的整数。 |
| class_id2 | 否 | string | 更新的商品分类2,支持1-60范围内的整数。 |
商品检索—更新 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
商品检索—更新 返回示例
1{
2 "log_id": 2263663554
3}
商品检索—删除
删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign
1$image = file_get_contents('example.jpg');
2
3// 调用删除商品,传入参数为图片
4$client->productDeleteByImage($image);
5$url = "http//www.x.com/sample.jpg";
6
7// 调用删除商品,图片参数为远程url图片
8$client->productDeleteByUrl($url);
9$contSign = "8cnn32frvrr2cd901";
10
11// 调用删除商品,传入参数为图片签名
12$client->productDeleteBySign($contSign);
商品检索—删除 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式 |
| url | 是 | string | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效 |
| cont_sign | 是 | string | 图片签名 |
商品检索—删除 返回数据参数详情
| 参数 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| log_id | number | 是 | 请求标识码,随机数,唯一 | 507499361 |
商品检索—删除 返回示例
1{
2 "log_id": 50488417
3}
绘本图片搜索—入库
该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。
注:重复添加完全相同的图片会返回错误。
1// 如果有可选参数
2$options = array("tags"=> "100,11")
3
4$image = file_get_contents('example.jpg');
5$brief = array("name"=>"周杰伦", "id"=>"666")
6
7// 调用绘本图片搜索—入库, 图片参数为本地图片
8$client->pictureBookAddImage($image, $brief, options);
9
10// 调用绘本图片搜索—入库, 图片参数为远程url图片
11$url = "http//www.x.com/sample.jpg";
12$client->pictureBookAddUrl($url, $brief, options);
绘本图片搜索—入库 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| image | 否 | string | - | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M。(和url二选一,image优先级更高),注意要去掉图片头部,如(data:image/jpg;base64,);最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式。重复添加完全相同的图片会返回错误,提示不能重复入库。 |
| url | 否 | string | - | 图片URL,和image二选一,image优先级更高,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 |
| brief | 是 | string | - | 检索时原样带回,最长256B。样例:{"name":"周杰伦", "id":"666"} 。请注意,检索接口不返回原图,仅返回入库时填写的brief信息,所以调用入库接口时,brief信息请尽量填写可关联至本地图库的图片id或者图片url、图片名称等信息 |
| tags | 否 | string | 1 - 65535范围内的整数 | tag间以逗号分隔,最多2个tag,2个tag无层级关系,检索时支持逻辑运算。样例:"100,11" ;检索时可圈定分类维度进行检索 |
绘本图片搜索—入库 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,无实际意义,用于问题定位 |
| cont_sign | 是 | string | 入库图片的签名信息,请务必保存至本地,以便后续用作批量删除、查询某张图是否已经入过库等用途 |
绘本图片搜索—入库 返回示例
1{
2 "log_id": 2263663554,
3 "cont_sign": "4261577168,501945506"
4}
绘本图片搜索—检索
完成入库后,可使用该接口实现绘本图检索。支持传入指定分类维度(具体变量tags)进行检索,返回结果支持翻页(具体变量pn、rn)。
请注意,检索接口不返回原图,仅反馈入库时填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。
1// 如果有可选参数
2$options = array("tags"=> "100,11", "tag_logic"=>"0", "pn"=>"100", "rn"=>"250")
3
4// 带参数调用绘本图片搜索—检索, 图片参数为本地图片
5client.pictureBookSearchImage($image, $options)
6
7// 调用绘本图片搜索—入库, 图片参数为本地图片
8$image = file_get_contents('example.jpg');
9$client->pictureBookSearchUrl($image, $options);
绘本图片搜索—检索 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| image | 否 | string | - | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M。(和url二选一,image优先级更高),注意要去掉图片头部,如(data:image/jpg;base64,);最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式 |
| url | 否 | string | - | 图片URL,和image二选一,image优先级更高,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 |
| tags | 否 | string | 1 - 65535范围内的整数 | 分类维度信息,tag间以逗号分隔,最多可传入2个tag,tag间无层级关系,示例:"100,11" |
| tag_logic | 否 | string | 0,1 | 检索时tag之间的逻辑, 0:逻辑and,1:逻辑or |
| pn | 否 | string | 0 - 999范围内的整数 | 分页功能,起始位置,例:0,代表从第1个结果开始。注:未指定分页时,默认返回前300个结果;接口返回数量最大限制1000个,例如:起始位置为900,截取条数500条,接口也只返回第901 - 1000条的结果,共计100条 |
| rn | 否 | string | 1 - 1000范围内的整数 | 分页功能,截取条数,例:250 |
绘本图片搜索—检索 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,无实际含义,用于问题定位 |
| result_num | 是 | uint32 | 检索结果数 |
| result | 是 | object[] | 结果数组 |
| +cont_sign | 是 | string | 入库图片签名,可以用来删除图片或定位问题 |
| +score | 是 | float | 图片相关性,取值范围0-1,越接近1表示越相关 |
| +brief | 是 | string | 调用入库add接口时添加的brief信息,为保证该结果有效性,请入库时填写可关联至本地图片库的有效id信息 |
| has_more | 是 | bool | 是否还有下一页,返回值:true、false;如果不分页,不用关注该字段 |
绘本图片搜索—检索 返回示例
1{
2 "result_num": 1,
3 "result": [
4 {
5 "score": 0.97976700290421,
6 "brief": "./data/jay1.jpg",
7 "cont_sign": "475124309,1080176642"
8 }
9 ],
10 "has_more": "false",
11 "log_id": 1968648150
12}
绘本图片搜索—更新
更新图库中图片的摘要和分类信息(具体变量为brief、tags)。
1// 如果有可选参数
2$options = array("brief"=> array("name"=>"周杰伦", "id"=>"6666"), "tags"=>"100,11")
3
4// 带参数调用绘本图片搜索—更新, 图片参数为本地图片
5$image = file_get_contents('example.jpg');
6$client->pictureBookUpdate($image, $options)
7
8// 调用绘本图片搜索—入库, 图片参数为远程url图片
9$url = "http//www.x.com/sample.jpg";
10$client->pictureBookUpdateUrl($url, $options);
11
12// 带参数调用绘本图片搜索—更新, 图片参数为图片签名
13$contSign = "8cnn32frvrr2cd901"
14$client.pictureBookUpdateContSign($contSign, $options)
绘本图片搜索—更新 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| image | 否 | string | - | 图片数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,和url、cont_sign三选一,优先级:image > url > cont_sign,注意要去掉图片头部,如(data:image/jpg;base64,),最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式 |
| url | 否 | string | - | 图片URL,和image、cont_sign三选一,优先级:image > url > cont_sign ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 |
| cont_sign | 否 | string | - | 图片签名,和image、url三选一,优先级:image > url > cont_sign;不支持批量传入签名,样例:"932301884,10680062193" |
| brief | 否 | string | - | 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"} |
| tags | 否 | string | 1 - 65535范围内的整数 | 更新的分类信息,tag间以逗号分隔,最多2个tag。样例:"100,11" |
绘本图片搜索—更新 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
绘本图片搜索—更新 返回示例
1{
2 "log_id": 2263663554
3}
绘本图片搜索—删除
删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image、url,最多支持100个cont_sign。
图片删除延时生效,每天数据库定时更新进行物理删除,刚删除时仍然可以在图库中检索到(但图库管理后台是同步清除),请过一段时间再验证,一般最多延时4小时左右。
1// 如果有可选参数
2$options = array("brief"=> array("name"=>"周杰伦", "id"=>"6666"), "tags"=>"100,11")
3
4// 带参数调用绘本图片搜索—更新, 图片参数为本地图片
5$image = file_get_contents('example.jpg');
6$client->pictureBookDeleteByImage($image, $options)
7
8// 调用绘本图片搜索—入库, 图片参数为远程url图片
9$url = "http//www.x.com/sample.jpg";
10$client->pictureBookDeleteByUrl($url, $options);
11
12// 带参数调用绘本图片搜索—更新, 图片参数为图片签名
13$contSign = "8cnn32frvrr2cd901"
14$client.pictureBookDeleteBySign($contSign, $options)
绘本图片搜索—删除 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| image | 否 | string | - | 图片数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,(和url、cont_sign三选一,优先级:image > url > cont_sign),注意要去掉图片头部,如(data:image/jpg;base64,)。最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式 |
| url | 否 | string | - | 图片URL,和image、cont_sign三选一,image优先级更高,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传 |
| cont_sign | 否 | string | - | 图片签名(和image、url三选一),支持批量删除,批量删除时请勿传image、url,最多支持100个cont_sign列表,样例:"932301884,1068006219;316336521,553141152;2491030726,1352091083" |
绘本图片搜索—删除 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
绘本图片搜索—删除 返回示例
1{
2 "log_id": 50488417
3}
面料图片搜索—入库
SDK 调用示例
1$image = file_get_contents('example.jpg');
2$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
3
4// 调用面料图片搜索—入库, 图片参数为本地图片
5$client->materielAdd($image, $brief);
6
7// 如果有可选参数
8$options = array();
9$options["tags"] = "100,11";
10
11// 带参数调用面料图片搜索—入库, 图片参数为本地图片
12$client->materielAdd($image, $brief, $options);
13$url = "http//www.x.com/sample.jpg";
14
15$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
16
17// 调用面料图片搜索—入库, 图片参数为远程url图片
18$client->materielAddUrl($url, $brief);
19
20// 如果有可选参数
21$options = array();
22$options["tags"] = "100,11";
23
24// 带参数调用面料图片搜索—入库, 图片参数为远程url图片
25$client->materielAddUrl($url, $brief, $options);
接口详情
可参考API文档:面料图片搜索—入库
面料图片搜索—检索
SDK 调用示例
1$image = file_get_contents('example.jpg');
2
3// 调用面料图片搜索检索, 图片参数为本地图片
4$client->materielSearch($image);
5
6// 如果有可选参数
7$options = array();
8$options["tags"] = "100,11";
9$options["tag_logic"] = "0";
10$options["pn"] = "100";
11$options["rn"] = "250";
12
13// 带参数调用面料图片搜索—检索, 图片参数为本地图片
14$client->materielSearch($image, $options);
15$url = "http//www.x.com/sample.jpg";
16
17// 调用面料图片搜索—检索, 图片参数为远程url图片
18$client->materielSearchUrl($url);
19
20// 如果有可选参数
21$options = array();
22$options["tags"] = "100,11";
23$options["tag_logic"] = "0";
24$options["pn"] = "100";
25$options["rn"] = "250";
26
27// 带参数调用面料图片搜索—检索, 图片参数为远程url图片
28$client->materielSearchUrl($url, $options);
接口详情
可参考API文档:面料图片搜索—检索
面料图片搜索—更新
SDK 调用示例
1 $image = file_get_contents('example.jpg');
2
3 $brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
4
5 // 调用面料图片搜索—更新, 图片参数为本地图片
6 $client->materielUpdate($image, $brief);
7
8 // 如果有可选参数
9 $options = array();
10 $options["tags"] = "100,11";
11
12 // 带参数调用面料图片搜索—更新, 图片参数为本地图片
13 $client->materielUpdate($image, $brief, $options);
14 $url = "http//www.x.com/sample.jpg";
15
16 // 调用面料图片搜索—更新, 图片参数为远程url图片
17 $client->materielUpdateUrl($url, $brief);
18
19 // 如果有可选参数
20 $options = array();
21 $options["tags"] = "100,11";
22
23 // 带参数调用面料图片搜索—更新, 图片参数为远程url图片
24 $client->materielUpdateUrl($url, $brief, $options);
25
26 // 带参数调用面料图片搜索—更新, 图片签名
27 $cont_sign="g988312421";
28 $client->materielUpdateContSign($cont_sign, $brief, $options);
接口详情
可参考API文档:面料图片搜索—更新
面料图片搜索—删除
SDK 调用示例
1$image = file_get_contents('example.jpg');
2
3// 调用删除面料图片,传入参数为图片
4$client->materielDeleteByImage($image);
5$url = "http//www.x.com/sample.jpg";
6
7// 调用删除面料图片,图片参数为远程url图片
8$client->materielDeleteByUrl($url);
9$contSign = "8cnn32frvrr2cd901";
10
11// 调用删除面料图片,传入参数为图片签名
12$client->materielDeleteBySign($contSign);
接口详情
可参考API文档:面料图片搜索—删除
