API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 图像识别 > 图像搜索相关接口 > 检索图片

检索图片

最近更新时间：2024-03-12 01:55:36

我的收藏

本页目录：

1. 接口描述

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

本接口用于对一张图片，在指定图片库中检索出与之相似的图片列表。

  • 可前往 图像搜索 产品文档中查看更多产品信息。

默认接口请求频率限制：10次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SearchImage。
Version 是 String 公共参数，本接口取值：2019-05-29。
Region 是 String 公共参数，详见产品支持的 地域列表。
GroupId 是 String 图库名称。
示例值：test_group
ImageUrl 否 String 图片的 Url 。
ImageUrl和ImageBase64必须提供一个，如果都提供，只使用ImageUrl。
图片限制：
• 图片格式：支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
• 图片大小：对应图片 base64 编码后大小不可超过5M。图片分辨率不超过4096*4096。
• 如果在商品图像搜索中开启主体识别，分辨率不超过2000*2000，图片长宽比小于10。
建议：
• 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。
示例值：test.jpg
ImageBase64 否 String 图片 base64 数据。
ImageUrl和ImageBase64必须提供一个，如果都提供，只使用ImageUrl。
图片限制：
• 图片格式：支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
• 图片大小：base64 编码后大小不可超过5M。图片分辨率不超过4096*4096。
• 如果在商品图像搜索中开启主体识别，分辨率不超过2000*2000，图片长宽比小于10。
示例值：base64
Limit 否 Integer 返回结果的数量，默认值为10，最大值为100。
按照相似度分数由高到低排序。
服务类型为图案花纹搜索时Limit = 1，最多只能返回1个结果。
示例值：1
Offset 否 Integer 返回结果的起始序号，默认值为0。
示例值：0
MatchThreshold 否 Integer 匹配阈值。
只有图片相似度分数超过匹配阈值的结果才会返回。
当MatchThreshold为0（默认值）时，各服务类型将按照以下默认的匹配阈值进行结果过滤：
• 通用图像搜索1.0版：50。
• 商品图像搜索2.0升级版：45。
• 商品图像搜索1.0版：28。
• 图案花纹搜索1.0版：56。
建议：
可以手动调整MatchThreshold值来控制输出结果的范围。如果发现无检索结果，可能是因为图片相似度较低导致检索结果被匹配阈值过滤，建议调整为较低的阈值后再次尝试检索。
示例值：1
Filter 否 String 标签过滤条件。
针对创建图片时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
示例值：value > 1
ImageRect 否 ImageRect 图像主体区域。
若设置主体区域，提取指定的区域进行检索。
EnableDetect 否 Boolean 是否需要启用主体识别，默认为TRUE 。
• 为TRUE时，启用主体识别，返回主体信息。若没有指定ImageRect，自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在Response中获取。
• 为FALSE时，不启用主体识别，不返回主体信息。若没有指定ImageRect，以整张图检索图片。
注意：仅服务类型为商品图像搜索时才生效。
示例值：true
CategoryId 否 Integer 图像类目ID。
若设置类目ID，提取以下类目的主体进行检索。
类目取值说明：
0：上衣。
1：裙装。
2：下装。
3：包。
4：鞋。
5：配饰。
注意：仅服务类型为商品图像搜索时才生效。
示例值：1

3. 输出参数

参数名称 类型 描述
Count Integer 返回结果数量。
示例值：1
ImageInfos Array of ImageInfo 图片信息。
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]
Object ObjectInfo 输入图的主体信息。
若启用主体识别且在请求中指定了类目ID或主体区域，以指定的主体为准。若启用主体识别且没有指定，以最大面积主体为准。
注意：仅服务类型为商品图像搜索时才生效。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用成功示例

输入示例

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

{
    "ImageUrl": "http://test.com/1.jpg",
    "Filter": "value > 10",
    "MatchThreshold": "1",
    "Limit": "30",
    "Offset": "0",
    "GroupId": "work"
}

输出示例

{
    "Response": {
        "RequestId": "8bab9614-3f62-4b1d-bc9b-e773703c727e",
        "Count": 1,
        "ImageInfos": [
            {
                "EntityId": "test1",
                "PicName": "test2",
                "Score": 100,
                "CustomContent": "",
                "Tags": "{}"
            }
        ],
        "Object": {
            "Box": {
                "Rect": {
                    "Width": 447,
                    "Height": 816,
                    "X": 88,
                    "Y": 264
                },
                "Score": 53
            },
            "Colors": [
                {
                    "Color": "0A0A0A",
                    "Percentage": 15,
                    "Label": "Black-black"
                },
                {
                    "Color": "8B4513",
                    "Percentage": 11,
                    "Label": "Brown-saddlebrown"
                },
                {
                    "Percentage": 7,
                    "Label": "Yellow-khaki",
                    "Color": "D8C59D"
                },
                {
                    "Label": "Yellow-darkkhaki",
                    "Color": "BDB76B",
                    "Percentage": 6
                }
            ],
            "CategoryId": 5,
            "Attributes": []
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BalanceInsufficient 余额不足，开通失败，请充值后再开通。
FailedOperation.DownloadError 文件下载错误。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageGroupChargeStatusClose 停止服务，控制台开关关闭。
FailedOperation.ImageGroupEmpty 图库为空。
FailedOperation.ImageNotSupported 不支持的图片文件。
FailedOperation.ImageResolutionExceed 图片分辨率过大。
FailedOperation.ImageResolutionInsufficient 图片分辨率过小。
FailedOperation.ImageSearchInvalid 未查询到结果。
FailedOperation.ImageSizeExceed base64编码后的图片数据过大。
FailedOperation.ImageUrlInvalid url地址不合法，无法下载。
FailedOperation.InnerError 内部错误。
FailedOperation.RequestError 后端服务请求失败。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.RpcFail RPC请求失败，一般为算法微服务故障。
FailedOperation.ServerError 算法服务异常，请重试。
FailedOperation.UnKnowError 内部错误。
FailedOperation.Unknown 未知错误。
InvalidParameter.ImageFormatNotSupport 不支持的图片格式。
InvalidParameter.InvalidParameter 参数取值错误。
InvalidParameter.PictureSolidColorError 图片不可为纯色图。
InvalidParameterValue.EntityIdTooLong 物品ID超出长度限制。
InvalidParameterValue.FilterInvalid Filter参数不合法。
InvalidParameterValue.FilterSizeExceed Filter参数过长。
InvalidParameterValue.ImageGroupIdIllegal 图库ID不合法。
InvalidParameterValue.ImageGroupIdNotExist 图库ID不存在。
InvalidParameterValue.ImageGroupIdTooLong 图库ID超出长度限制。
InvalidParameterValue.LimitExceed 返回数量不在合法范围内。
MissingParameter.ErrorParameterEmpty 必选参数为空。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.IsOpening 服务正在开通中，请稍等。
ResourceUnavailable.NotExist 计费状态未知，请确认是否已在控制台开通服务。
中国站