接口说明

更新时间：2022-11-15

相同图检索—入库

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

public void SameHqAddDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用相同图检索—入库, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqAdd(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
	    {"tags", "100,11"}
	};
	// 带参数调用相同图检索—入库, 图片参数为本地图片
	result = client.SameHqAdd(image, options);
	Console.WriteLine(result);
}
public void SameHqAddUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用相同图检索—入库, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqAddUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
	    {"tags", "100,11"}
	};
	// 带参数调用相同图检索—入库, 图片参数为远程url图片
	result = client.SameHqAddUrl(url, options);
	Console.WriteLine(result);
}

相同图检索—入库请求参数详情

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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	输入图片签名，可用于删除

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

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

相同图检索—检索

完成入库后，可使用该接口实现相同图检索。支持传入指定分类维度（具体变量tags）进行检索，返回结果支持翻页（具体变量pn、rn）。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。**

public void SameHqSearchDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用相同图检索—检索, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqSearch(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用相同图检索—检索, 图片参数为本地图片
	result = client.SameHqSearch(image, options);
	Console.WriteLine(result);
}
public void SameHqSearchUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用相同图检索—检索, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqSearchUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用相同图检索—检索, 图片参数为远程url图片
	result = client.SameHqSearchUrl(url, options);
	Console.WriteLine(result);
}

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

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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；如果不分页，不用关注该字段

相同图检索—检索返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

相同图检索—更新

更新图库中图片的摘要和分类信息（具体变量为brief、tags）

    public void SameHqUpdateDemo() {
    	var image = File.ReadAllBytes("图片文件路径");
    	// 调用相同图检索—更新, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.SameHqUpdate(image);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用相同图检索—更新, 图片参数为本地图片
    	result = client.SameHqUpdate(image, options);
    	Console.WriteLine(result);
    }
    public void SameHqUpdateUrlDemo() {
    	var url = "http//www.x.com/sample.jpg";
    	
    	// 调用相同图检索—更新, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.SameHqUpdateUrl(url);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用相同图检索—更新, 图片参数为远程url图片
    	result = client.SameHqUpdateUrl(url, options);
    	Console.WriteLine(result);
    }
   public void SameHqUpdateBySignDemo() {
    	var contSign = "8cnn32frvrr2cd901";
    	
    	// 调用更新摘要信息，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.SameHqUpdateBySign(contSign);
    	Console.WriteLine(result);
    }

相同图检索—更新请求参数详情

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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，用于问题定位

相同图检索—更新返回示例

{
    "log_id": 2263663554
}

相同图检索—删除

删除图库中的图片，支持批量删除，批量删除时请传cont_sign参数，勿传image，最多支持1000个cont_sign

public void SameHqDeleteByImageDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用删除相同图，传入参数为图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqDeleteByImage(image);
	Console.WriteLine(result);
}
public void SameHqDeleteByUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用删除相同图，图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqDeleteByUrl(url);
	Console.WriteLine(result);
}
public void SameHqDeleteBySignDemo() {
	var contSign = "8cnn32frvrr2cd901";
	
	// 调用删除相同图，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SameHqDeleteBySign(contSign);
	Console.WriteLine(result);
}

相同图检索—删除请求参数详情

参数	是否必选	类型	可选值范围	说明
image	否	byte[]	-	二进制图像数据（和url、cont_sign三选一，优先级：image > url > cont_sign），大小不超过4M，最短边至少300px，最长边最大4096px，支持jpg/png/bmp格式
url	否	string	-	图片URL，和image、cont_sign三选一，image优先级更高，由于图床的差异性，抓图服务无法适配所有的图床，部分URL可能抓不到图，或者图片下载超时，遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
cont_sign	否	string	-	图片签名（和image、url三选一，优先级最低），支持批量删除，批量删除时请勿传image、url，最多支持50个cont_sign列表，样例："932301884,1068006219;316336521,553141152;2491030726,1352091083"

相同图检索—删除返回数据参数详情

参数	类型	是否必须	说明	示例
log_id	number	是	请求标识码，随机数，唯一	507499361

相同图检索—删除返回示例

{
  "log_id": 50488417
}

相似图检索—入库

public void SimilarAddDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用相似图检索—入库, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarAdd(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
	    {"tags", "100,11"}
	};
	// 带参数调用相似图检索—入库, 图片参数为本地图片
	result = client.SimilarAdd(image, options);
	Console.WriteLine(result);
}
public void SimilarAddUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用相似图检索—入库, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarAddUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
	    {"tags", "100,11"}
	};
	// 带参数调用相似图检索—入库, 图片参数为远程url图片
	result = client.SimilarAddUrl(url, options);
	Console.WriteLine(result);
}

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

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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	输入图片签名，可用于删除

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

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

相似图检索—检索

完成入库后，可使用该接口实现相似图检索。支持传入指定分类维度（具体变量tags）进行检索，返回结果支持翻页（具体变量pn、rn）。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。**

public void SimilarSearchDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用相似图检索—检索, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarSearch(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用相似图检索—检索, 图片参数为本地图片
	result = client.SimilarSearch(image, options);
	Console.WriteLine(result);
}
public void SimilarSearchUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用相似图检索—检索, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarSearchUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用相似图检索—检索, 图片参数为远程url图片
	result = client.SimilarSearchUrl(url, options);
	Console.WriteLine(result);
}

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

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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；如果不分页，不用关注该字段

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

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

相似图检索—更新

更新图库中图片的摘要和分类信息（具体变量为brief、tags）

    public void SimilarUpdateDemo() {
    	var image = File.ReadAllBytes("图片文件路径");
    	// 调用相似图检索—更新, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.SimilarUpdate(image);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用相似图检索—更新, 图片参数为本地图片
    	result = client.SimilarUpdate(image, options);
    	Console.WriteLine(result);
    }
    public void SimilarUpdateUrlDemo() {
    	var url = "http//www.x.com/sample.jpg";
    	
    	// 调用相似图检索—更新, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.SimilarUpdateUrl(url);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用相似图检索—更新, 图片参数为远程url图片
    	result = client.SimilarUpdateUrl(url, options);
    	Console.WriteLine(result);
    }
    
   public void SimilarUpdateBySignDemo() {
    	var contSign = "8cnn32frvrr2cd901";
    	
    	// 调用相似图更新，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.SimilarUpdateBySign(contSign);
    	Console.WriteLine(result);
    }

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

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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，用于问题定位

相似图检索—更新返回示例

{
    "log_id": 2263663554
}

相似图检索—删除

删除图库中的图片，支持批量删除，批量删除时请传cont_sign参数，勿传image，最多支持1000个cont_sign

public void SimilarDeleteByImageDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用删除相似图，传入参数为图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarDeleteByImage(image);
	Console.WriteLine(result);
}
public void SimilarDeleteByUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用删除相似图，图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarDeleteByUrl(url);
	Console.WriteLine(result);
}
public void SimilarDeleteBySignDemo() {
	var contSign = "8cnn32frvrr2cd901";
	
	// 调用删除相似图，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.SimilarDeleteBySign(contSign);
	Console.WriteLine(result);
}

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

参数	是否必选	类型	可选值范围	说明
image	否	byte[]	-	二进制图像数据（和url、cont_sign三选一，优先级：image > url > cont_sign），大小不超过4M，最短边至少300px，最长边最大4096px，支持jpg/png/bmp格式
url	否	string	-	图片URL，和image、cont_sign三选一，image优先级更高，由于图床的差异性，抓图服务无法适配所有的图床，部分URL可能抓不到图，或者图片下载超时，遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
cont_sign	否	string	-	图片签名（和image、url三选一，优先级最低），支持批量删除，批量删除时请勿传image、url，最多支持50个cont_sign列表，样例："932301884,1068006219;316336521,553141152;2491030726,1352091083"

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

参数	类型	是否必须	说明	示例
log_id	number	是	请求标识码，随机数，唯一	507499361

相似图检索—删除返回示例

{
  "log_id": 50488417
}

商品检索—入库

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

public void ProductAddDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用商品检索—入库, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductAdd(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"手机\", \"id\":\"666\"}"},
	    {"class_id1", 1},
	    {"class_id2", 1}
	};
	// 带参数调用商品检索—入库, 图片参数为本地图片
	result = client.ProductAdd(image, options);
	Console.WriteLine(result);
}
public void ProductAddUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用商品检索—入库, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductAddUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"手机\", \"id\":\"666\"}"},
	    {"class_id1", 1},
	    {"class_id2", 1}
	};
	// 带参数调用商品检索—入库, 图片参数为远程url图片
	result = client.ProductAddUrl(url, options);
	Console.WriteLine(result);
}

商品检索—入库请求参数详情

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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	输入图片签名，可用于删除

商品检索—入库返回示例

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

商品检索—检索

完成入库后，可使用该接口实现商品检索。支持传入指定分类维度（具体变量class_id1、class_id2）进行检索，返回结果支持翻页（具体变量pn、rn）。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息**

public void ProductSearchDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用商品检索—检索, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductSearch(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"class_id1", 1},
	    {"class_id2", 1},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用商品检索—检索, 图片参数为本地图片
	result = client.ProductSearch(image, options);
	Console.WriteLine(result);
}
public void ProductSearchUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用商品检索—检索, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductSearchUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"class_id1", 1},
	    {"class_id2", 1},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用商品检索—检索, 图片参数为远程url图片
	result = client.ProductSearchUrl(url, options);
	Console.WriteLine(result);
}

商品检索—检索请求参数详情

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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；如果不分页，不用关注该字段

商品检索—检索返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/mobile.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

商品检索—更新

更新图库中图片的摘要和分类信息（具体变量为brief、class_id1/class_id2）

    public void ProductUpdateDemo() {
    	var image = File.ReadAllBytes("图片文件路径");
    	// 调用商品检索—更新, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.ProductUpdate(image);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"class_id1", 1},
    	    {"class_id2", 1}
    	};
    	// 带参数调用商品检索—更新, 图片参数为本地图片
    	result = client.ProductUpdate(image, options);
    	Console.WriteLine(result);
    }
    public void ProductUpdateUrlDemo() {
    	var url = "http//www.x.com/sample.jpg";
    	
    	// 调用商品检索—更新, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.ProductUpdateUrl(url);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"class_id1", 1},
    	    {"class_id2", 1}
    	};
    	// 带参数调用商品检索—更新, 图片参数为远程url图片
    	result = client.ProductUpdateUrl(url, options);
    	Console.WriteLine(result);
    }

   public void ProductUpdateBySignDemo() {
    	var contSign = "8cnn32frvrr2cd901";
    	
    	// 商品更新，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.ProductUpdateBySign(contSign);
    	Console.WriteLine(result);
    }

商品检索—更新请求参数详情

参数名称	是否必选	类型	说明
image	是	byte[]	二进制图像数据
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-60范围内的整数。
class_id2	否	string	更新的商品分类2，支持1-60范围内的整数。

商品检索—更新返回数据参数详情

字段	是否必选	类型	说明
log_id	是	uint64	唯一的log id，用于问题定位

商品检索—更新返回示例

{
    "log_id": 2263663554
}

商品检索—删除

删除图库中的图片，支持批量删除，批量删除时请传cont_sign参数，勿传image，最多支持1000个cont_sign

public void ProductDeleteByImageDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用删除商品，传入参数为图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductDeleteByImage(image);
	Console.WriteLine(result);
}
public void ProductDeleteByUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用删除商品，图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductDeleteByUrl(url);
	Console.WriteLine(result);
}
public void ProductDeleteBySignDemo() {
	var contSign = "8cnn32frvrr2cd901";
	
	// 调用删除商品，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.ProductDeleteBySign(contSign);
	Console.WriteLine(result);
}

商品检索—删除请求参数详情

参数	是否必选	类型	可选值范围	说明
image	否	byte[]	-	二进制图像数据（和url、cont_sign三选一，优先级：image > url > cont_sign），大小不超过4M，最短边至少300px，最长边最大4096px，支持jpg/png/bmp格式
url	否	string	-	图片URL，和image、cont_sign三选一，image优先级更高，由于图床的差异性，抓图服务无法适配所有的图床，部分URL可能抓不到图，或者图片下载超时，遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
cont_sign	否	string	-	图片签名（和image、url三选一，优先级最低），支持批量删除，批量删除时请勿传image、url，最多支持50个cont_sign列表，样例："932301884,1068006219;316336521,553141152;2491030726,1352091083"

商品检索—删除返回数据参数详情

参数	类型	是否必须	说明	示例
log_id	number	是	请求标识码，随机数，唯一	507499361

商品检索—删除返回示例

{
  "log_id": 50488417
}

面料图片搜索

面料图片搜索—入库

SDK 调用示例

public void MaterielAddDemo() {
	var image = File.ReadAllBytes("图片文件路径");
    var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
	// 调用面料图片搜索—入库, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielAdd(image, brief);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{	    
	    {"tags", "100,11"}
	};
	// 带参数调用面料图片搜索—入库, 图片参数为本地图片
	result = client.MaterielAdd(image, brief, options);
	Console.WriteLine(result);
}
public void MaterielAddUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
	// 调用面料图片搜索—入库, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielAddUrl(url, brief);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{	   
	    {"tags", "100,11"}
	};
	// 带参数调用面料图片搜索—入库, 图片参数为远程url图片
	result = client.MaterielAddUrl(url, brief, options);
	Console.WriteLine(result);
}

接口详情

可参考API文档：面料图片搜索—入库

面料图片搜索—检索

SDK 调用示例

public void MaterielSearchDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用面料图片搜索—检索, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielSearch(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用面料图片搜索—检索, 图片参数为本地图片
	result = client.MaterielSearch(image, options);
	Console.WriteLine(result);
}
public void MaterielSearchUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用面料图片搜索—检索, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielSearchUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用面料图片搜索—检索, 图片参数为远程url图片
	result = client.MaterielSearchUrl(url, options);
	Console.WriteLine(result);
}

接口详情

可参考API文档：面料图片搜索—检索

面料图片搜索—更新

SDK 调用示例

    public void MaterielUpdateDemo() {
    	var image = File.ReadAllBytes("图片文件路径");
        var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    	// 调用面料图片搜索—更新, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.MaterielUpdate(image, brief);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{"name":"周杰伦", "id":"666"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用面料图片搜索—更新, 图片参数为本地图片
    	result = client.MaterielUpdate(image, brief, options);
    	Console.WriteLine(result);
    }
    public void MaterielUpdateUrlDemo() {
    	var url = "http//www.x.com/sample.jpg";
    	var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    	// 调用面料图片搜索—更新, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.MaterielUpdateUrl(url, brief);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{"name":"周杰伦", "id":"666"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用面料图片搜索—更新, 图片参数为远程url图片
    	result = client.MaterielUpdateUrl(url, brief, options);
    	Console.WriteLine(result);
    }
   public void MaterielUpdateBySignDemo() {
    	var contSign = "8cnn32frvrr2cd901";
    	var brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    	// 调用更新摘要信息，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.MaterielUpdateContSign(contSign, brief);
    	Console.WriteLine(result);
    }

接口详情

可参考API文档：面料图片搜索—更新

面料图片搜索—删除

SDK 调用示例

public void MaterielDeleteByImageDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用删除面料，传入参数为图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielDeleteByImage(image);
	Console.WriteLine(result);
}
public void MaterielDeleteByUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用删除面料，图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielDeleteByUrl(url);
	Console.WriteLine(result);
}
public void MaterielDeleteBySignDemo() {
	var contSign = "8cnn32frvrr2cd901";
	
	// 调用删除面料图片，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.MaterielDeleteBySign(contSign);
	Console.WriteLine(result);
}

接口详情

可参考API文档：面料图片搜索—删除

绘本图片搜索—入库

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

public void PicturebookAddDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用相同图检索—入库, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookAdd(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
	    {"tags", "100,11"}
	};
	// 带参数调用相同图检索—入库, 图片参数为本地图片
	result = client.PicturebookAdd(image, options);
	Console.WriteLine(result);
}
public void PicturebookAddUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用相同图检索—入库, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookAddUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
	    {"tags", "100,11"}
	};
	// 带参数调用相同图检索—入库, 图片参数为远程url图片
	result = client.PicturebookAddUrl(url, options);
	Console.WriteLine(result);
}

请求参数

参数	是否必选	类型	可选值范围	说明
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	入库图片的签名信息，请务必保存至本地，以便后续用作批量删除、查询某张图是否已经入过库等用途

返回示例

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

绘本图片搜索—检索

完成入库后，可使用该接口实现绘本图检索。支持传入指定分类维度（具体变量tags）进行检索，返回结果支持翻页（具体变量pn、rn）

public void PicturebookSearchDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用相同图检索—检索, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookSearch(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用相同图检索—检索, 图片参数为本地图片
	result = client.PicturebookSearch(image, options);
	Console.WriteLine(result);
}
public void PicturebookSearchUrlDemo() {
	var url = "http//www.x.com/sample.jpg";
	
	// 调用相同图检索—检索, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookSearchUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"tags", "100,11"},
	    {"tag_logic", "0"},
	    {"pn", "100"},
	    {"rn", "250"}
	};
	// 带参数调用相同图检索—检索, 图片参数为远程url图片
	result = client.PicturebookSearchUrl(url, options);
	Console.WriteLine(result);
}

请求参数

参数	是否必选	类型	可选值范围	说明
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；如果不分页，不用关注该字段

返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
	"has_more": "false",
    "log_id": 1968648150
}

绘本图片搜索—删除

删除图库中的图片，支持批量删除，批量删除时请传cont_sign参数，勿传image、url，最多支持100个cont_sign。

public void PitureboolDeleteByImageDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用删除商品，传入参数为图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookDeleteByImage(image);
	Console.WriteLine(result);
}
public void ProductDeleteByUrlDemo() {
	var url = "http//www.x.com/sample.jpg";

	// 调用删除商品，图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookDeleteByUrl(url);
	Console.WriteLine(result);
}
public void ProductDeleteBySignDemo() {
	var contSign = "8cnn32frvrr2cd901";
	
	// 调用删除商品，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.PicturebookDeleteByContSign(contSign);
	Console.WriteLine(result);
}

绘本检索—删除请求参数详情

参数	是否必选	类型	可选值范围	说明
image	否	byte[]	-	二进制图像数据（和url、cont_sign三选一，优先级：image > url > cont_sign），大小不超过4M，最短边至少300px，最长边最大4096px，支持jpg/png/bmp格式
url	否	string	-	图片URL，和image、cont_sign三选一，image优先级更高，由于图床的差异性，抓图服务无法适配所有的图床，部分URL可能抓不到图，或者图片下载超时，遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
cont_sign	否	string	-	图片签名（和image、url三选一，优先级最低），支持批量删除，批量删除时请勿传image、url，最多支持50个cont_sign列表，样例："932301884,1068006219;316336521,553141152;2491030726,1352091083"

绘本检索—删除返回数据参数详情

参数	类型	是否必须	说明	示例
log_id	number	是	请求标识码，随机数，唯一	507499361

绘本检索—删除返回示例

{
  "log_id": 50488417
}

绘本图片搜索—更新

更新图库中图片的摘要和分类信息（具体变量为brief、tags）

    public void PicturebookUpdateDemo() {
    	var image = File.ReadAllBytes("图片文件路径");
    	// 调用绘本图片检索—更新, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.PicturebookUpdate(image);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用相绘本图片检索—更新, 图片参数为本地图片
    	result = client.PicturebookUpdate(image, options);
    	Console.WriteLine(result);
    }
    public void PicturebookUpdateUrlDemo() {
    	var url = "http//www.x.com/sample.jpg";
    	
    	// 绘本图片检索—更新, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.PicturebookUpdateUrl(url);
    	Console.WriteLine(result);
    	// 如果有可选参数
    	var options = new Dictionary<string, object>{
    	    {"brief", "{\"name\":\"周杰伦\", \"id\":\"666\"}"},
    	    {"tags", "100,11"}
    	};
    	// 带参数调用相同图检索—更新, 图片参数为远程url图片
    	result = client.PicturebookUpdateUrl(url, options);
    	Console.WriteLine(result);
    }
     public void PicturebookUpdateBySignDemo() {
    	var contSign = "8cnn32frvrr2cd901";
    	
    	// 绘本图片检索—更新，传入参数为图片签名，可能会抛出网络等异常，请使用try/catch捕获
    	var result = client.PicturebookUpdateBySign(contSign);
    	Console.WriteLine(result);
    }

请求参数

参数	是否必选	类型	可选值范围	说明
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，用于问题定位

返回示例

{
    "log_id": 2263663554
}

快速入门

FAQ