凯发k8国际娱乐官网入口-k8凯发> 图像搜索 imagesearch> > > 搜索数据

更新时间：2023-09-22 gmt 08:00

搜索数据-凯发k8国际娱乐官网入口

功能介绍

从指定服务实例中进行搜索。

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

uri

post /v2/{project_id}/mms/{service_name}/search

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	string	用户的项目id。获取方法请参见。
service_name	是	string	服务实例的名称，用户创建服务实例时指定。

请求参数

表2 请求body参数
参数	是否必选	参数类型	描述
search_type	是	string	搜索类型，必须为服务实例支持的搜索类型。服务实例的搜索类型列表可在创建服务实例时进行配置。说明：可以使用枚举名或者枚举值（例如image/0），枚举值可能会变动，建议使用枚举名。枚举值： image keyword category
limit	否	integer	返回搜索结果的数量，默认为10，取值范围为[1, 100]。
offset	否	integer	返回搜索结果的偏移量，即返回序号在[offset, offset limit]内的搜索结果。默认为0，取值范围为[0, n]。默认情况下，搜索要求offset limit <= 1000。针对支持全量召回的场景，使用全量召回时要求offset必须为0。
last_item	否	searchafterparam object	前一次搜索的最后一个搜索结果的排序信息。仅对全量召回场景生效，可将上一次搜索返回结果中的last_item字段直接用于此处。目前仅有keyword支持全量召回。使用全量召回时，offset必须为0。
min_score	否	double	返回搜索结果的最小得分，用于对搜索结果进行score过滤，取值范围为[0, 1]。说明：目前仅对image/category搜索类型生效。
custom_tags	否	map>	自定义字符标签，用于对搜索结果进行条件过滤。格式为键值对{key:value}。 key: 必须为服务实例custom_tags中已存在的key，可在创建服务实例时进行配置，或在更新服务实例时进行新增。 value: 标签值列表，列表内多个标签值为“或”关系，即满足一个即可。列表长度范围为[1, 32]，标签值类型为字符串，字符长度范围为[1, 64]。
custom_num_tags	否	maprangeparam>	自定义数值标签，用于对搜索结果进行条件过滤。格式为键值对{key:value}。 key: 必须为服务实例custom_num_tags中已存在的key，可在创建服务实例时进行配置，或在更新服务实例时进行新增。针对没有设置该数值标签的数据，会直接过滤。 value: 标签值的取值范围，标签值在给定的取值范围内即视为符合条件。
image_base64	否	string	图像文件的base64字符串，基于图像搜索时，与image_url二选一。要求如下：目前仅支持jpeg/jpg/png/bmp/webp格式的图像。图像文件大小要求不超过5m。默认情况下，要求图像的最短边大于64px，最长边小于4096px。部分服务类型有特殊要求，可参见服务类型说明。图片中不能包含旋转信息。
image_url	否	string	图片的url路径，目前支持公网http:/https url，图像入库时，与image_base64二选一。说明：接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。
keywords	否	array of strings	关键词列表，搜索时关键词数量范围为[1, 10]，关键词字符长度范围为[1, 64]。使用keyword搜索类型进行搜索时，必须提供该参数。
optional_params	否	searchoptionalparam object	搜索的可选参数，其中每个参数仅对部分服务类型生效，具体可参见服务类型说明。

表3 searchafterparam
参数	是否必选	参数类型	描述
score	否	double	搜索结果的相似度。
id	否	string	搜索结果的唯一id。

表4 rangeparam
参数	是否必选	参数类型	描述
from	否	double	自定义数值标签数值下界，默认包含该下界。
to	否	double	自定义数值标签数值上界，默认包含该上界。

表5 searchoptionalparam
参数	是否必选	参数类型	描述
do_det	否	boolean	是否进行目标检测，默认为true。
box	否	string	目标矩形框坐标，如给定则不进行目标检测，直接使用该box作为目标。格式为“x1,y1,x2,y2”（无空格），x1/y1为目标左上角坐标，x2/y2为目标右下角坐标，具体要求如下： 0 <= x1 < x2 <= width，默认要求x2-x1 >= 15，具体可参考服务类型说明。 0 <= y1 < y2 <= height，默认要求y2-y1 >= 15，具体可参考服务类型说明。
do_cls	否	boolean	是否进行对象分类，默认为true。
category	否	integer	对象类目，如给定则不进行对象分类，直接使用该category作为类目。具体类目信息可参见对应的服务类型说明。
collapse_key	否	string	去重标签名，必须为服务实例custom_tags中已存在的key。如给定则会对该key下相同value的数据进行去重，仅保留得分最高的数据。针对没有设置该标签的数据，会直接过滤。
max_scan_num	否	integer	查询考察中心点的数目。值越大精度越高，查询速度变慢。取值范围：1-100000，默认值为100。
nprobe	否	integer	扫描节点上限。值越大精度越高，查询速度变慢。取值范围：1-100000，默认值为10000。

响应参数

状态码： 200

表6 响应body参数
参数	参数类型	描述
result	string	搜索完成返回success。
data	searchrestinfo object	搜索的相关信息。

表7 searchrestinfo
参数	参数类型	描述
items	array of searchitem objects	搜索结果列表。
search_info	searchinfo object	搜索结果的相关信息。
image_info	image_info object	搜索图像的相关信息，不同服务类型返回信息不同，具体可参见服务类型说明。

表8 searchitem
参数	参数类型	描述
id	string	数据唯一id。
score	double	数据匹配分数。
source	itemsource object	数据的元信息，不同数据包含的字段可能不同。

表9 itemsource
参数	参数类型	描述
desc	string	数据描述信息。
custom_tags	map	数据自定义字符标签。
custom_num_tags	map	数据自定义数值标签。
keywords	array of strings	数据关键词列表。

**表10** searchinfo
参数	参数类型	描述
total_num	integer	搜索结果总数。
return_num	integer	返回结果总数。
search_time	integer	搜索过程耗时，单位为毫秒。
last_item	searchafterparam object	最后一个搜索结果的排序信息。仅对全量召回生效，非全量召回场景返回null。

**表11** searchafterparam
参数	参数类型	描述
score	double	搜索结果的得分。
id	string	搜索结果的唯一id。

**表12** image_info
参数	参数类型	描述
box	string	用于搜索的主体目标框。
category	integer	用于搜索的主体类目序号。
category_name	string	用于搜索的主体类目名称。
objects	array of objects objects	搜索图像中的所有主体列表。

**表13** objects
参数	参数类型	描述
box	string	主体目标框。
category	integer	主体类目序号。
category_name	string	主体类目名称。

状态码： 400

**表14** 响应body参数
参数	参数类型	描述
error_code	string	调用失败时的错误码，具体请参见。调用成功时无此字段。
error_msg	string	调用失败时的错误信息。调用成功时无此字段。

请求示例

搜索商品图像，使用图像base64编码

post https://{endpoint}/v2/{project_id}/mms/{service_name}/search
{
  "search_type" : "category",
  "image_base64" : "/9j/4aaqskzjrgabageasabiaad/4rfzrxhpzgaatu0akgaaaagabwesaamaaaabaaeaaaeaaauaaaabaaaaygebaa...",
  "custom_tags" : {
    "brand" : [ "huawei" ]
  },
  "custom_num_tags" : {
    "year" : {
      "from" : 2020,
      "to" : 2022
    }
  }
}

响应示例

状态码： 200

成功响应示例

{
  "result" : "success",
  "data" : {
    "items" : [ {
      "id" : "electronics_01",
      "score" : 1,
      "source" : {
        "desc" : "天地纵横自然",
        "custom_tags" : {
          "brand" : "huawei"
        },
        "custom_num_tags" : {
          "year" : 2022
        }
      }
    } ],
    "search_info" : {
      "total_num" : 10,
      "return_num" : 1,
      "search_time" : 512
    },
    "image_info" : {
      "box" : "26,223,771,704",
      "category" : 11,
      "category_name" : "electronics",
      "objects" : [ {
        "box" : "26,223,771,704",
        "category" : 11,
        "category_name" : "electronics"
      }, {
        "box" : "55,66,420,315",
        "category" : 0,
        "category_name" : "others"
      } ]
    }
  }
}

状态码： 400

失败响应示例

{
  "error_code" : "mms.0003",
  "error_msg" : "invalid parameter: custom_tags"
}

状态码

状态码	描述
200	成功响应示例。
400	失败响应示例。

错误码

请参见。

父主题：

上一篇：添加数据

下一篇：检查数据

意见反馈

文档内容是否对您有帮助？

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨