接口说明
相同图检索—入库
该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
5
6// 调用相同图检索—入库, 图片参数为本地图片
7client.sameHqAdd(image, brief).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 如果有可选参数
15var options = {};
16options["tags"] = "100,11";
17
18// 带参数调用相同图检索—入库, 图片参数为本地图片
19client.sameHqAdd(image, brief, options).then(function(result) {
20 console.log(JSON.stringify(result));
21}).catch(function(err) {
22 // 如果发生网络错误
23 console.log(err);
24});;
25
26var url = "http//www.x.com/sample.jpg";
27
28var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
29
30// 调用相同图检索—入库, 图片参数为远程url图片
31client.sameHqAddUrl(url, brief).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["tags"] = "100,11";
41
42// 带参数调用相同图检索—入库, 图片参数为远程url图片
43client.sameHqAddUrl(url, brief, options).then(function(result) {
44 console.log(JSON.stringify(result));
45}).catch(function(err) {
46 // 如果发生网络错误
47 console.log(err);
48});;
相同图检索—入库 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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等信息。**
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用相同图检索—检索, 图片参数为本地图片
6client.sameHqSearch(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["tags"] = "100,11";
16options["tag_logic"] = "0";
17options["pn"] = "100";
18options["rn"] = "250";
19
20// 带参数调用相同图检索—检索, 图片参数为本地图片
21client.sameHqSearch(image, options).then(function(result) {
22 console.log(JSON.stringify(result));
23}).catch(function(err) {
24 // 如果发生网络错误
25 console.log(err);
26});;
27
28var url = "http//www.x.com/sample.jpg";
29
30// 调用相同图检索—检索, 图片参数为远程url图片
31client.sameHqSearchUrl(url).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["tags"] = "100,11";
41options["tag_logic"] = "0";
42options["pn"] = "100";
43options["rn"] = "250";
44
45// 带参数调用相同图检索—检索, 图片参数为远程url图片
46client.sameHqSearchUrl(url, options).then(function(result) {
47 console.log(JSON.stringify(result));
48}).catch(function(err) {
49 // 如果发生网络错误
50 console.log(err);
51});;
相同图检索—检索 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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)
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用相同图检索—更新, 图片参数为本地图片
6client.sameHqUpdate(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
16options["tags"] = "100,11";
17
18// 带参数调用相同图检索—更新, 图片参数为本地图片
19client.sameHqUpdate(image, options).then(function(result) {
20 console.log(JSON.stringify(result));
21}).catch(function(err) {
22 // 如果发生网络错误
23 console.log(err);
24});;
25
26var url = "http//www.x.com/sample.jpg";
27
28// 调用相同图检索—更新, 图片参数为远程url图片
29client.sameHqUpdateUrl(url).then(function(result) {
30 console.log(JSON.stringify(result));
31}).catch(function(err) {
32 // 如果发生网络错误
33 console.log(err);
34});
35
36// 如果有可选参数
37var options = {};
38options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
39options["tags"] = "100,11";
40
41// 带参数调用相同图检索—更新, 图片参数为远程url图片
42client.sameHqUpdateUrl(url, options).then(function(result) {
43 console.log(JSON.stringify(result));
44}).catch(function(err) {
45 // 如果发生网络错误
46 console.log(err);
47});;
48
49var contSign = "8cnn32frvrr2cd901";
50
51// 调用相同图检索—更新, 图片参数为图片签名
52client.sameHqUpdateContSign(contSign).then(function(result) {
53 console.log(JSON.stringify(result));
54}).catch(function(err) {
55 // 如果发生网络错误
56 console.log(err);
57});
58
59// 如果有可选参数
60var options = {};
61options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
62options["tags"] = "100,11";
63
64// 带参数调用相同图检索—更新, 图片参数为图片签名
65client.sameHqUpdateContSign(contSign, options).then(function(result) {
66 console.log(JSON.stringify(result));
67}).catch(function(err) {
68 // 如果发生网络错误
69 console.log(err);
70});;
相同图检索—更新 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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 | 图片签名 |
| 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
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用删除相同图,传入参数为图片
6client.sameHqDeleteByImage(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13var url = "http//www.x.com/sample.jpg";
14
15// 调用删除相同图,图片参数为远程url图片
16client.sameHqDeleteByUrl(url).then(function(result) {
17 console.log(JSON.stringify(result));
18}).catch(function(err) {
19 // 如果发生网络错误
20 console.log(err);
21});
22
23var contSign = "8cnn32frvrr2cd901";
24
25// 调用删除相同图,传入参数为图片签名
26client.sameHqDeleteBySign(contSign).then(function(result) {
27 console.log(JSON.stringify(result));
28}).catch(function(err) {
29 // 如果发生网络错误
30 console.log(err);
31});
相同图检索—删除 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
5
6// 调用相似图检索—入库, 图片参数为本地图片
7client.similarAdd(image, brief).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 如果有可选参数
15var options = {};
16options["tags"] = "100,11";
17
18// 带参数调用相似图检索—入库, 图片参数为本地图片
19client.similarAdd(image, brief, options).then(function(result) {
20 console.log(JSON.stringify(result));
21}).catch(function(err) {
22 // 如果发生网络错误
23 console.log(err);
24});;
25
26var url = "http//www.x.com/sample.jpg";
27
28var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
29
30// 调用相似图检索—入库, 图片参数为远程url图片
31client.similarAddUrl(url, brief).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["tags"] = "100,11";
41
42// 带参数调用相似图检索—入库, 图片参数为远程url图片
43client.similarAddUrl(url, brief, options).then(function(result) {
44 console.log(JSON.stringify(result));
45}).catch(function(err) {
46 // 如果发生网络错误
47 console.log(err);
48});;
相似图检索—入库 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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等信息。**
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用相似图检索—检索, 图片参数为本地图片
6client.similarSearch(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["tags"] = "100,11";
16options["tag_logic"] = "0";
17options["pn"] = "100";
18options["rn"] = "250";
19
20// 带参数调用相似图检索—检索, 图片参数为本地图片
21client.similarSearch(image, options).then(function(result) {
22 console.log(JSON.stringify(result));
23}).catch(function(err) {
24 // 如果发生网络错误
25 console.log(err);
26});;
27
28var url = "http//www.x.com/sample.jpg";
29
30// 调用相似图检索—检索, 图片参数为远程url图片
31client.similarSearchUrl(url).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["tags"] = "100,11";
41options["tag_logic"] = "0";
42options["pn"] = "100";
43options["rn"] = "250";
44
45// 带参数调用相似图检索—检索, 图片参数为远程url图片
46client.similarSearchUrl(url, options).then(function(result) {
47 console.log(JSON.stringify(result));
48}).catch(function(err) {
49 // 如果发生网络错误
50 console.log(err);
51});;
相似图检索—检索 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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)
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用相似图检索—更新, 图片参数为本地图片
6client.similarUpdate(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
16options["tags"] = "100,11";
17
18// 带参数调用相似图检索—更新, 图片参数为本地图片
19client.similarUpdate(image, options).then(function(result) {
20 console.log(JSON.stringify(result));
21}).catch(function(err) {
22 // 如果发生网络错误
23 console.log(err);
24});;
25
26var url = "http//www.x.com/sample.jpg";
27
28// 调用相似图检索—更新, 图片参数为远程url图片
29client.similarUpdateUrl(url).then(function(result) {
30 console.log(JSON.stringify(result));
31}).catch(function(err) {
32 // 如果发生网络错误
33 console.log(err);
34});
35
36// 如果有可选参数
37var options = {};
38options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
39options["tags"] = "100,11";
40
41// 带参数调用相似图检索—更新, 图片参数为远程url图片
42client.similarUpdateUrl(url, options).then(function(result) {
43 console.log(JSON.stringify(result));
44}).catch(function(err) {
45 // 如果发生网络错误
46 console.log(err);
47});;
48
49var contSign = "8cnn32frvrr2cd901";
50
51// 调用相似图检索—更新, 图片参数为图片签名
52client.similarUpdateContSign(contSign).then(function(result) {
53 console.log(JSON.stringify(result));
54}).catch(function(err) {
55 // 如果发生网络错误
56 console.log(err);
57});
58
59// 如果有可选参数
60var options = {};
61options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
62options["tags"] = "100,11";
63
64// 带参数调用相似图检索—更新, 图片参数为图片签名
65client.similarUpdateContSign(contSign, options).then(function(result) {
66 console.log(JSON.stringify(result));
67}).catch(function(err) {
68 // 如果发生网络错误
69 console.log(err);
70});;
相似图检索—更新 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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 | 图片签名 |
| 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
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用删除相似图,传入参数为图片
6client.similarDeleteByImage(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13var url = "http//www.x.com/sample.jpg";
14
15// 调用删除相似图,图片参数为远程url图片
16client.similarDeleteByUrl(url).then(function(result) {
17 console.log(JSON.stringify(result));
18}).catch(function(err) {
19 // 如果发生网络错误
20 console.log(err);
21});
22
23var contSign = "8cnn32frvrr2cd901";
24
25// 调用删除相似图,传入参数为图片签名
26client.similarDeleteBySign(contSign).then(function(result) {
27 console.log(JSON.stringify(result));
28}).catch(function(err) {
29 // 如果发生网络错误
30 console.log(err);
31});
相似图检索—删除 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4var brief = "{\"name\":\"手机\", \"id\":\"666\"}";
5
6// 调用商品检索—入库, 图片参数为本地图片
7client.productAdd(image, brief).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 如果有可选参数
15var options = {};
16options["class_id1"] = "1";
17options["class_id2"] = "1";
18
19// 带参数调用商品检索—入库, 图片参数为本地图片
20client.productAdd(image, brief, options).then(function(result) {
21 console.log(JSON.stringify(result));
22}).catch(function(err) {
23 // 如果发生网络错误
24 console.log(err);
25});;
26
27var url = "http//www.x.com/sample.jpg";
28
29var brief = "{\"name\":\"手机\", \"id\":\"666\"}";
30
31// 调用商品检索—入库, 图片参数为远程url图片
32client.productAddUrl(url, brief).then(function(result) {
33 console.log(JSON.stringify(result));
34}).catch(function(err) {
35 // 如果发生网络错误
36 console.log(err);
37});
38
39// 如果有可选参数
40var options = {};
41options["class_id1"] = "1";
42options["class_id2"] = "1";
43
44// 带参数调用商品检索—入库, 图片参数为远程url图片
45client.productAddUrl(url, brief, options).then(function(result) {
46 console.log(JSON.stringify(result));
47}).catch(function(err) {
48 // 如果发生网络错误
49 console.log(err);
50});;
商品检索—入库 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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-65535范围内的整数。检索时可圈定该分类维度进行检索 |
| class_id2 | 否 | string | 商品分类维度1,支持1-65535范围内的整数。检索时可圈定该分类维度进行检索 |
商品检索—入库 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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等信息**
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用商品检索—检索, 图片参数为本地图片
6client.productSearch(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["class_id1"] = "1";
16options["class_id2"] = "1";
17options["pn"] = "100";
18options["rn"] = "250";
19
20// 带参数调用商品检索—检索, 图片参数为本地图片
21client.productSearch(image, options).then(function(result) {
22 console.log(JSON.stringify(result));
23}).catch(function(err) {
24 // 如果发生网络错误
25 console.log(err);
26});;
27
28var url = "http//www.x.com/sample.jpg";
29
30// 调用商品检索—检索, 图片参数为远程url图片
31client.productSearchUrl(url).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["class_id1"] = "1";
41options["class_id2"] = "1";
42options["pn"] = "100";
43options["rn"] = "250";
44
45// 带参数调用商品检索—检索, 图片参数为远程url图片
46client.productSearchUrl(url, options).then(function(result) {
47 console.log(JSON.stringify(result));
48}).catch(function(err) {
49 // 如果发生网络错误
50 console.log(err);
51});;
商品检索—检索 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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-65535范围内的整数。检索时可圈定该分类维度进行检索 |
| class_id2 | 否 | string | 商品分类维度1,支持1-65535范围内的整数。检索时可圈定该分类维度进行检索 |
| 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)
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用商品检索—更新, 图片参数为本地图片
6client.productUpdate(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
16options["class_id1"] = "1";
17options["class_id2"] = "1";
18
19// 带参数调用商品检索—更新, 图片参数为本地图片
20client.productUpdate(image, options).then(function(result) {
21 console.log(JSON.stringify(result));
22}).catch(function(err) {
23 // 如果发生网络错误
24 console.log(err);
25});;
26
27var url = "http//www.x.com/sample.jpg";
28
29// 调用商品检索—更新, 图片参数为远程url图片
30client.productUpdateUrl(url).then(function(result) {
31 console.log(JSON.stringify(result));
32}).catch(function(err) {
33 // 如果发生网络错误
34 console.log(err);
35});
36
37// 如果有可选参数
38var options = {};
39options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
40options["class_id1"] = "1";
41options["class_id2"] = "1";
42
43// 带参数调用商品检索—更新, 图片参数为远程url图片
44client.productUpdateUrl(url, options).then(function(result) {
45 console.log(JSON.stringify(result));
46}).catch(function(err) {
47 // 如果发生网络错误
48 console.log(err);
49});;
50
51var contSign = "8cnn32frvrr2cd901";
52
53// 调用商品检索—更新, 图片参数为图片签名
54client.productUpdateContSign(contSign).then(function(result) {
55 console.log(JSON.stringify(result));
56}).catch(function(err) {
57 // 如果发生网络错误
58 console.log(err);
59});
60
61// 如果有可选参数
62var options = {};
63options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
64options["class_id1"] = "1";
65options["class_id2"] = "1";
66
67// 带参数调用商品检索—更新, 图片参数为图片签名
68client.productUpdateContSign(contSign, options).then(function(result) {
69 console.log(JSON.stringify(result));
70}).catch(function(err) {
71 // 如果发生网络错误
72 console.log(err);
73});;
商品检索—更新 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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 | 图片签名 |
| brief | 否 | string | 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"} |
| class_id1 | 否 | string | 更新的商品分类1,支持1-65535范围内的整数。 |
| class_id2 | 否 | string | 更新的商品分类2,支持1-65535范围内的整数。 |
商品检索—更新 返回数据参数详情
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
商品检索—更新 返回示例
1{
2 "log_id": 2263663554
3}
商品检索—删除
删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用删除商品,传入参数为图片
6client.productDeleteByImage(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13var url = "http//www.x.com/sample.jpg";
14
15// 调用删除商品,图片参数为远程url图片
16client.productDeleteByUrl(url).then(function(result) {
17 console.log(JSON.stringify(result));
18}).catch(function(err) {
19 // 如果发生网络错误
20 console.log(err);
21});
22
23var contSign = "8cnn32frvrr2cd901";
24
25// 调用删除商品,传入参数为图片签名
26client.productDeleteBySign(contSign).then(function(result) {
27 console.log(JSON.stringify(result));
28}).catch(function(err) {
29 // 如果发生网络错误
30 console.log(err);
31});
商品检索—删除 请求参数详情
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| 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),方便对图库中的图片进行管理、分类检索。
注:重复添加完全相同的图片会返回错误。
1var fs = require('fs');
2var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}"
3// 如果有可选参数
4var options = {"tags": "100,11"}
5
6// 调用绘本图片搜索—入库, 图片参数为本地图片
7var image = fs.readFileSync("assets/example.jpg").toString("base64");
8client.pictureBookAddImage(image, brief, options).then(function(result) {
9 console.log(JSON.stringify(result));
10}).catch(function(err) {
11 // 如果发生网络错误
12 console.log(err);
13});
14
15var url = "http//www.x.com/sample.jpg";
16// 调用绘本图片搜索—入库, 图片参数为远程url图片
17client.pictureBookAddUrl(url, brief, options).then(function(result) {
18 console.log(JSON.stringify(result));
19}).catch(function(err) {
20 // 如果发生网络错误
21 console.log(err);
22});
绘本图片搜索—入库 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| 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等信息。
1var fs = require('fs');
2
3// 如果有可选参数
4var options = {"tags": "100,114", "tag_logic":"0", "pn":"100", "rn":"250"}
5
6// 调用绘本图片搜索—检索, 图片参数为本地图片
7var image = fs.readFileSync("assets/example.jpg").toString("base64");
8client.pictureBookSearchImage(image, options).then(function(result) {
9 console.log(JSON.stringify(result));
10}).catch(function(err) {
11 // 如果发生网络错误
12 console.log(err);
13});
14
15// 调用绘本图片搜索—检索, 图片参数为远程url图片
16var url = "http//www.x.com/sample.jpg";
17client.pictureBookSearchUrl(url, options).then(function(result) {
18 console.log(JSON.stringify(result));
19}).catch(function(err) {
20 // 如果发生网络错误
21 console.log(err);
22});
绘本图片搜索—检索 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| 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)。
1var fs = require('fs');
2// 如果有可选参数
3var options = {"brief": {"name":"周杰伦", "id":"6666"}, "tags":"100,11"}
4
5// 调用绘本图片搜索—更新, 图片参数为本地图片
6var image = fs.readFileSync("assets/example.jpg").toString("base64");
7client.pictureBookUpdate(image, options).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 调用绘本图片搜索—更新, 图片参数为远程url图片
15var url = "http//www.x.com/sample.jpg";
16client.pictureBookUpdateUrl(url, options).then(function(result) {
17 console.log(JSON.stringify(result));
18}).catch(function(err) {
19 // 如果发生网络错误
20 console.log(err);
21});
22
23// 调用绘本图片搜索—更新, 图片参数为远程url图片
24var contSign = "8cnn32frvrr2cd901"
25client.pictureBookUpdateContSign(contSign, options).then(function(result) {
26 console.log(JSON.stringify(result));
27}).catch(function(err) {
28 // 如果发生网络错误
29 console.log(err);
30});
绘本图片搜索—更新 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| 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小时左右。
1var fs = require('fs');
2// 如果有可选参数
3var options = {"brief": {"name":"周杰伦", "id":"6666"}, "tags":"100,11"}
4
5// 调用绘本图片搜索—删除, 图片参数为本地图片
6var image = fs.readFileSync("assets/example.jpg").toString("base64");
7client.pictureBookDeleteByImage(image, options).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 调用绘本图片搜索—删除, 图片参数为远程url图片
15var url = "http//www.x.com/sample.jpg";
16client.pictureBookDeleteByUrl(url, options).then(function(result) {
17 console.log(JSON.stringify(result));
18}).catch(function(err) {
19 // 如果发生网络错误
20 console.log(err);
21});
22
23// 调用绘本图片搜索—删除, 图片参数为远程url图片
24var contSign = "8cnn32frvrr2cd901"
25client.pictureBookDeleteBySign(contSign, options).then(function(result) {
26 console.log(JSON.stringify(result));
27}).catch(function(err) {
28 // 如果发生网络错误
29 console.log(err);
30});
绘本图片搜索—删除 请求参数详情
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| 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 调用示例
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
5
6// 调用面料图片搜索—入库, 图片参数为本地图片
7client.materielAdd(image, brief).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 如果有可选参数
15var options = {};
16options["tags"] = "100,11";
17
18// 带参数调用面料图片搜索—入库, 图片参数为本地图片
19client.materielAdd(image, brief, options).then(function(result) {
20 console.log(JSON.stringify(result));
21}).catch(function(err) {
22 // 如果发生网络错误
23 console.log(err);
24});;
25
26var url = "http//www.x.com/sample.jpg";
27
28var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
29
30// 调用面料图片搜索—入库, 图片参数为远程url图片
31client.materielAddUrl(url, brief).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["tags"] = "100,11";
41
42// 带参数调用面料图片搜索—入库, 图片参数为远程url图片
43client.materielAddUrl(url, brief, options).then(function(result) {
44 console.log(JSON.stringify(result));
45}).catch(function(err) {
46 // 如果发生网络错误
47 console.log(err);
48});;
接口详情
可参考API文档:面料图片搜索—入库
面料图片搜索—检索
SDK 调用示例
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用面料图片搜索—检索, 图片参数为本地图片
6client.materielSearch(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13// 如果有可选参数
14var options = {};
15options["tags"] = "100,11";
16options["tag_logic"] = "0";
17options["pn"] = "100";
18options["rn"] = "250";
19
20// 带参数调用面料图片搜索—检索, 图片参数为本地图片
21client.materielSearch(image, options).then(function(result) {
22 console.log(JSON.stringify(result));
23}).catch(function(err) {
24 // 如果发生网络错误
25 console.log(err);
26});;
27
28var url = "http//www.x.com/sample.jpg";
29
30// 调用面料图片搜索—检索, 图片参数为远程url图片
31client.materielSearchUrl(url).then(function(result) {
32 console.log(JSON.stringify(result));
33}).catch(function(err) {
34 // 如果发生网络错误
35 console.log(err);
36});
37
38// 如果有可选参数
39var options = {};
40options["tags"] = "100,11";
41options["tag_logic"] = "0";
42options["pn"] = "100";
43options["rn"] = "250";
44
45// 带参数调用面料图片搜索—检索, 图片参数为远程url图片
46client.materielSearchUrl(url, options).then(function(result) {
47 console.log(JSON.stringify(result));
48}).catch(function(err) {
49 // 如果发生网络错误
50 console.log(err);
51});;
接口详情
可参考API文档:面料图片搜索—检索
面料图片搜索—更新
SDK 调用示例
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
5
6// 调用面料图片搜索—更新, 图片参数为本地图片
7client.materielUpdate(image, brief).then(function(result) {
8 console.log(JSON.stringify(result));
9}).catch(function(err) {
10 // 如果发生网络错误
11 console.log(err);
12});
13
14// 如果有可选参数
15var options = {};
16options["tags"] = "100,11";
17
18// 带参数调用面料图片搜索—更新, 图片参数为本地图片
19client.materielUpdate(image, brief, options).then(function(result) {
20 console.log(JSON.stringify(result));
21}).catch(function(err) {
22 // 如果发生网络错误
23 console.log(err);
24});;
25
26var url = "http//www.x.com/sample.jpg";
27var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
28
29// 调用面料图片搜索—更新, 图片参数为远程url图片
30client.materielUpdateUrl(url, brief).then(function(result) {
31 console.log(JSON.stringify(result));
32}).catch(function(err) {
33 // 如果发生网络错误
34 console.log(err);
35});
36
37// 如果有可选参数
38var options = {};
39options["tags"] = "100,11";
40
41// 带参数调用面料图片搜索—更新, 图片参数为远程url图片
42client.materielUpdateUrl(url, brief, options).then(function(result) {
43 console.log(JSON.stringify(result));
44}).catch(function(err) {
45 // 如果发生网络错误
46 console.log(err);
47});;
48
49var contSign = "8cnn32frvrr2cd901";
50var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
51
52// 调用面料图片搜索—更新, 图片参数为图片签名
53client.materielUpdateContSign(contSign, brief).then(function(result) {
54 console.log(JSON.stringify(result));
55}).catch(function(err) {
56 // 如果发生网络错误
57 console.log(err);
58});
59
60// 如果有可选参数
61var options = {};
62options["tags"] = "100,11";
63
64// 带参数调用面料图片搜索—更新, 图片参数为图片签名
65client.materielUpdateContSign(contSign, brief, options).then(function(result) {
66 console.log(JSON.stringify(result));
67}).catch(function(err) {
68 // 如果发生网络错误
69 console.log(err);
70});;
接口详情
可参考API文档:面料图片搜索—更新
面料图片搜索—删除
SDK 调用示例
1var fs = require('fs');
2
3var image = fs.readFileSync("assets/example.jpg").toString("base64");
4
5// 调用删除面料图片,传入参数为图片
6client.materielDeleteByImage(image).then(function(result) {
7 console.log(JSON.stringify(result));
8}).catch(function(err) {
9 // 如果发生网络错误
10 console.log(err);
11});
12
13var url = "http//www.x.com/sample.jpg";
14
15// 调用删除面料图片,图片参数为远程url图片
16client.materielDeleteByUrl(url).then(function(result) {
17 console.log(JSON.stringify(result));
18}).catch(function(err) {
19 // 如果发生网络错误
20 console.log(err);
21});
22
23var contSign = "8cnn32frvrr2cd901";
24
25// 调用删除面料图片,传入参数为图片签名
26client.materielDeleteBySign(contSign).then(function(result) {
27 console.log(JSON.stringify(result));
28}).catch(function(err) {
29 // 如果发生网络错误
30 console.log(err);
31});
接口详情
可参考API文档:面料图片搜索—删除
