图像搜索 IMAGESEARCH-搜索图片:请求参数

时间:2024-07-22 17:30:35

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

file

String

图片文件Base64编码字符串,仅支持JPEG/JPG/PNG/BMP格式,图片最小边不小于100px,最大边不超过2048px。该参数与path二选一,如果两个参数都存在,则以file为主。

path

String

图片的URL路径,图片库中的图片索引ID。该参数与file二选一,如果两个参数都存在,则以file为主。

limit

Integer

返回被检索图像的数量,取值为1~100的整数,默认为10。

最小值:1

最大值:100

缺省值:10

offset

Integer

偏移量,指定搜索结果返回起始位置,取值为大于或等于0的整数,默认为0。

最小值:0

tags

Object

图片自定义标签,最多不超过10个,格式为key:value对。 标签名(key)添加方式:

  • 登录管理控制台,单击“创建实例”,自定义标签名。
  • 登录管理控制台,在“实例管理”页签,单击实例名称,进入“基础信息”页添加自定义标签。 使用图片标签搜索时该参数必选。

is_crop

Boolean

是否用图片中指定区域(参数box)进行搜索。该参数目前仅对某些特定模型有效,其他模型暂不支持目标检测。 取值为true或false。

  • true:用图片中指定区域(参数box)进行搜索。
  • false:用全图进行搜索。

默认为false。

box

SearchBoxDetail object

图片中指定的区域。

表4 SearchBoxDetail

参数

是否必选

参数类型

描述

x

Integer

区域中x坐标的最小值,单位:像素。

y

Integer

区域中y坐标的最小值,单位:像素。

width

Integer

区域的宽度,单位:像素。

height

Integer

区域的高度,单位:像素。

support.huaweicloud.com/api-imagesearch/imagesearch_02_0011.html