检索图片

最近更新时间:2022-01-13 09:10:30

我的收藏

1. 接口描述

接口请求域名: tiia.tencentcloudapi.com 。

本接口用于对一张待识别的商品图片,在指定图片库中检索出最相似的图片列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SearchImage。
Version String 公共参数,本接口取值:2019-05-29。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 图库名称。
ImageUrl String 图片的 Url 。对应图片 base64 编码后大小不可超过2M。
图片分辨率不超过1920*1080。
Url、Image必须提供一个,如果都提供,只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
ImageBase64 String 图片 base64 数据,base64 编码后大小不可超过2M。
图片分辨率不超过1920*1080。
支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
MatchThreshold Integer 出参Score中,只有超过MatchThreshold值的结果才会返回。默认为0
Offset Integer 起始序号,默认值为0。
Limit Integer 返回数量,默认值为10,最大值为100。
Filter String 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=,!=,多个条件之间支持AND和OR进行连接。
ImageRect ImageRect 图像主体区域。

3. 输出参数

参数名称 类型 描述
Count Integer 返回结果数量。
ImageInfos Array of ImageInfo 图片信息。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用成功示例

输入示例

POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchImage
<公共请求参数>

{
    "ImageUrl": "http://crawl.ws.126.net/img/999674ed516ef903e486cd2ff83e1d2f.jpg",
    "Filter": "value > 10",
    "MatchThreshold": "1",
    "Limit": "30",
    "Offset": "0",
    "GroupId": "work"
}

输出示例

{
  "Response": {
    "Count": 2,
    "ImageInfos": [
      {
        "CustomContent": "",
        "EntityId": "test2",
        "PicName": "3001",
        "Score": 0,
        "Tags": "{\"value\": 15}"
      },
      {
        "CustomContent": "",
        "EntityId": "test2",
        "PicName": "3002",
        "Score": 0,
        "Tags": "{\"value\": 20}"
      }
    ],
    "RequestId": "2d658a05-62d5-4f82-913c-50832146f6f3"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownloadError 文件下载错误。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageGroupEmpty 图库为空。
FailedOperation.ImageNotSupported 不支持的图片文件。
FailedOperation.ImageSearchInvalid 未查询到结果。
FailedOperation.ImageSizeExceed base64编码后的图片数据过大。
FailedOperation.ImageUrlInvalid url地址不合法,无法下载。
FailedOperation.InnerError 内部错误。
FailedOperation.RequestError 后端服务请求失败。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.RpcFail RPC请求失败,一般为算法微服务故障。
InvalidParameter.InvalidParameter 参数取值错误。
InvalidParameterValue.EntityIdTooLong 物品ID超出长度限制。
InvalidParameterValue.FilterInvalid Filter参数不合法。
InvalidParameterValue.FilterSizeExceed Filter参数过长。
InvalidParameterValue.ImageGroupIdIllegal 图库ID不合法。
InvalidParameterValue.ImageGroupIdNotExist 图库ID不存在。
InvalidParameterValue.ImageGroupIdTooLong 图库ID超出长度限制。
InvalidParameterValue.LimitExceed 返回数量不在合法范围内。
MissingParameter.ErrorParameterEmpty 必选参数为空。
目录