本文介绍图像搜索服务的图片查询方法。
背景信息
图像搜索服务支持通过API、SDK(推荐方式)和控制台(适用于功能体验场景)三种方式进行图片查询。
控制台方式
登录图像搜索控制台。
选择目标服务类型和实例。
单击图片搜索。
参数
对应API参数名称
说明
是否必选
搜索类型
Type
包括两种搜索类型:
SearchByPic:根据图片搜索相似图片。默认选项。
SearchByName:根据已添加的图片搜索相似图片。
是
上传图片
PicContent
图片内容本身,Base64编码。新增图片具体要求如下:
图片大小要求不超过4 MB。
图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。
传输等待时间不超过5秒。
服务类型为商品图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100且小于等于4096。
图片中不能包含旋转信息。
是
图片主体识别
Crop
在图片搜索过程中是否需要对上传图片进行主体识别。
为true时:进行主体识别,包括系统自动识别和自定义主体识别。具体请参见主体识别方式参数介绍。
为false时:不进行主体识别,以整张图进行搜索。
是
主体识别方式
不涉及
主体识别的方式:
系统自动识别:由系统自动进行主体识别,以识别的主体进行搜索,主体识别结果可以在Response中获取。
自定义主体区域:可自定义主体识别区域。格式为
x1,x2,y1,y2
,其中x1,y1
为左上角点,x2,y2
为右下角点。单击此选项可以通过拖拽的方式框选图片主体区域。若不设置自定义主体区域,则以整张图进行搜索。
是
图片类目
CategoryId
图片类目即CategoryId。图片搜索过程中可以指定图片所属类目,详情请参见类目参考。
说明对于商品搜索,如果设置类目,则以设置的为准;若不设置类目,将由系统进行类目预测,预测的类目结果可在Response中获取 。
对于通用搜索,不论是否设置类目,系统都会将类目设置为88888888。
否
返回结果数
Num
返回相似结果的最大值。取值范围1~100。默认值为10。
否
结果起始位置
Start
返回相似结果的起始位置。取值范围0~499。默认值为0。
否
过滤条件
Filter
搜索时可以设置过滤条件,只返回符合过滤条件的图像结果,比如只返回ownerId为1000的图像结果,或者只返回公司名称为”alibaba”的图像结果。
说明int_attr支持的操作符有>、>=、<、<=、=。
str_attr支持的操作符有=和!=。
多个条件之间支持AND和OR进行连接。
例如:int_attr=1000 AND str_attr=”value1”。
否
查看返回结果。
返回结果参数描述如下。
参数
类型
示例值
说明
Success
Boolean
true
请求是否成功。
RequestId
String
36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
请求ID。
Code
Integer
0
错误码:
0表示成功。
非0表示失败。
Message
String
success
错误信息。
Head
-
-
搜索结果信息。
└DocsReturn
Integer
10
返回结果数目。
└DocsFound
Integer
10000
实例中命中结果数目。
└SearchTime
Integer
95
搜索耗时,单位毫秒。
PicInfo
-
-
类目预测、主体识别结果等信息。
└CategoryId
Integer
88888888
类目预测结果。若请求中指定了类目,则以请求中指定为准。
└Region
String
280,486,232,351
主体识别结果。图片的主体区域,格式为x1,x2,y1,y2, 其中x1和y1是左上角的点,x2和y2是右下角的点。若用户请求中指定了主体区域,则以请求中指定为准。
└AllCategories
-
-
系统支持的所有类目信息。
└└Name
String
Tops
类目名称。
└└Id
Integer
0
类目ID。
└MultiRegion
-
-
主体识别结果集合。
说明需要版本升级至V3.1.1方可使用。
└└Region
String
280,486,232,351
主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中x1和y1是左上角的点,x2和y2是右下角的点。若用户请求中指定了主体区域,则以请求中指定为准。
Auctions
-
-
所有返回商品的描述信息。
└CustomContent
String
Demo Custom Content
用户自定义内容。
└PicName
String
DemoPic
图片名称。
└CategoryId
Integer
0
图片类目。
└ProductId
String
test
商品ID。
└SortExprValues
String
7.33136443711219e+24;0
系统打分信息。
说明当前字段已弃用,建议使用Score。
└Score
Float
1
图片相似打分。取值范围:0~1。
说明需要版本升级至V3.1.1方可使用。
└IntAttr
Integer
0
整数类型属性。
└IntAttr2
Integer
0
整数类型属性。
说明2023年1月3号之后创建的实例才能使用。
└StrAttr
String
demoStrAttr
字符串类型属性。
└StrAttr2
String
demoStrAttr
字符串类型属性。
说明2023年1月3号之后创建的实例才能使用。
API方式
通过HTTP或HTTPS协议直接访问,需要按照签名机制进行身份验证,发送请求的RequestBody需要按照给定的格式进行传输。通过API查询相似图片的QPS为购买的套餐包的QPS。更多详情请参见根据名称查询图片或根据图片查询图片。
SDK方式(推荐)
图像搜索服务提供多个版本的SDK,您无需关注签名验证以及RequestBody格式拼装等繁琐的事情。通过SDK查询相似图片的QPS为购买的套餐包的QPS。更多详情请见SDK参考。