文档首页/ 图像搜索 ImageSearch/ API参考/ API/ 检查数据 V2
更新时间：2024-08-06 GMT+08:00
查看PDF
分享

检查数据 V2

功能介绍

检查指定服务实例中的对应数据，支持指定ID检查和条件检查。

调试

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

URI

POST /v2/{project_id}/mms/{service_name}/data/check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户的项目ID。获取方法请参见获取项目ID和名称。

service_name

是

String

服务实例的名称，用户创建服务实例时指定。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

item_id

否

String

数据的服务实例级唯一标识，字符长度范围为[1, 256]。

  • item_id/custom_tags/custom_num_tags中必须给定至少一个参数，以支持对服务实例中的数据进行指定ID检查或条件检查。
  • 如给定item_id参数，则进行指定ID检查，否则进行条件检查。

最小长度：1

最大长度：256

limit

否

Integer

返回检查结果的数量，默认为10，取值范围为[1, 100]。仅对条件检查生效。

最小值：1

最大值：100

缺省值：10

last_item

否

SearchAfterParam object

前一次检查的最后一个检查结果的排序信息。仅对条件检查生效，可将上一次检查返回结果中的last_item字段直接用于此处。

custom_tags

否

Map<String,Array<String>>

自定义字符标签，用于对服务实例中的数据进行条件查找。格式为键值对{key:value}。

  • key: 必须为服务实例custom_tags中已存在的key，可在创建服务实例时进行配置，或在更新服务实例时进行新增。
  • value: 标签值列表，列表内多个标签值为“或”关系，即满足一个即可。列表长度范围为[1, 32]，标签值类型为字符串，字符长度范围为[1, 64]。

custom_num_tags

否

Map<String,RangeParam>

自定义数值标签，用于对服务实例中的数据进行条件查找。格式为键值对{key:value}。

  • key: 必须为服务实例custom_num_tags中已存在的key，可在创建服务实例时进行配置，或在更新服务实例时进行新增。针对没有设置该数值标签的数据，会直接过滤。
  • value: 标签值的取值范围，标签值在给定的取值范围内即视为符合条件。
表3 SearchAfterParam

参数

是否必选

参数类型

描述

score

否

Double

搜索结果的得分。

id

否

String

搜索结果的唯一ID。
表4 RangeParam

参数

是否必选

参数类型

描述

from

否

Double

自定义数值标签的数值下界，默认包含该下界。

to

否

Double

自定义数值标签的数值上界，默认包含该上界。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

String

检查数据完成返回success。

data

CheckRestInfo object

检查数据的相关信息。
表6 CheckRestInfo

参数

参数类型

描述

existed

Boolean

数据是否存在，存在返回true，不存在返回false。仅在指定ID检查时包含该字段。

item_info

ItemSource object

数据的元信息,仅在指定ID检查时包含该字段。

items

Array of SearchItem objects

检查结果列表，仅在条件检查时包含该字段。

check_info

CheckInfo object

检查结果的相关信息，仅在条件检查时包含该字段。
表7 SearchItem

参数

参数类型

描述

id

String

数据唯一ID。

score

Double

数据匹配分数。

source

ItemSource object

数据的元信息，不同数据包含的字段可能不同。
表8 ItemSource

参数

参数类型

描述

desc

String

数据描述信息。

custom_tags

Map<String,String>

数据自定义字符标签。

custom_num_tags

Map<String,Number>

数据自定义数值标签。

keywords

Array of strings

数据关键词列表。
表9 CheckInfo

参数

参数类型

描述

total_num

Integer

符合条件的结果总数。

return_num

Integer

返回的结果总数。

last_item

SearchAfterParam object

最后一个检查结果的排序信息。
表10 SearchAfterParam

参数

参数类型

描述

score

Double

结果的得分。

id

String

结果的唯一ID。

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码，具体请参见错误码。

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

POST https://{endpoint}/v2/{project_id}/mms/{service_name}/data/check
{
  "item_id" : "electronics_01"
}

响应示例

状态码： 200

成功响应示例

{
  "result" : "success",
  "data" : {
    "existed" : true,
    "item_info" : {
      "desc" : "天地纵横自然",
      "custom_tags" : {
        "brand" : "HUAWEI"
      },
      "custom_num_tags" : {
        "year" : 2022
      }
    }
  }
}

状态码： 400

失败响应示例

{
  "error_code" : "MMS.0003",
  "error_msg" : "Invalid parameter: item_id"
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码。

父主题： API

相关文档