SearchImage_图像搜索_API调试-阿里云OpenAPI开发者门户

接口说明

QPS 限制

查询操作默认的最大访问频率可在控制台中查看，为您购买时所选择的访问频次（QPS），当前支持 1QPS、5QPS、10QPS。

SDK 版本说明

图像 SDK 版本升级到 V3.1.1，可使用“多主体识别”、“相似性分数”功能。请参见Java SDK。

请求语法

POST /v2/image/search HTTP/1.1

请求参数

字段名称	字段详情
CategoryIdinteger<int32>	商品类目。具体请参见类目参考。展开详情示例值:88888888
InstanceNamestring	图搜实例名称。最多支持 20 个字符。展开详情示例值:phimagesearch
ProductIdstring	商品 ID，最多支持 512 个字符。展开详情示例值:pro-goods-25376
PicNamestring	图片名称，最多支持 512 个字符。展开详情示例值:goods-23312-1
PicContentstring	图片内容，Base64 编码。展开详情示例值:iVBORw0KGgoAAAANSUhEUgAAAV8AAADwAQMAAACdRvVNAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAADUExURQAAAKd6PdoAAAABdFJOUyR85Ty3AAAAIUlEQVRo3u3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAADPBiowAAGR02EbAAAAAElFTkSuQmCC
Cropboolean	是否需要进行主体识别。默认 true。展开详情示例值:true
Regionstring	图片的主体区域，格式为`x1,x2,y1,y2,` 其中`x1,y1` 是左上角的点，`x2,y2`是右下角的点。展开详情示例值:32,282,43,256
Numinteger<int32>	返回结果的数目。取值范围：1~100。默认值为 10。示例值:10
Startinteger<int32>	返回结果的起始位置。取值范围：0~499。默认值为 0。示例值:0
Typestring	搜索类型。包括：展开详情示例值:SearchByPic
Filterstring	过滤条件。int_attr 支持的操作符有大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr 支持的操作符有等于号(=)和不等号(!=)，多个条件之支持 AND 和 OR 进行连接。展开详情示例值:(int_attr >= 100000000 AND int_attr < 200000000 AND int_attr=100000252 AND str_attr=\"87\")

返回参数

字段名称	字段详情
Msgstring	错误信息。示例值:success
Headobject	搜索结果概述信息。
RequestIdstring	请求 ID。示例值:3033A0A7-36DA-5AC9-9973-953C38EBDFA9
Auctionsarray<object>	所有返回的商品描述信息。
Codeinteger<int32>	错误码。展开详情示例值:0
PicInfoobject	类目预测、主体识别结果等信息。
Successboolean	请求是否成功。示例值:true

变更历史

	变更时间	变更内容概要	操作
	2023-06-05	变更返回参数
	2021-11-22	变更错误码500