本文介绍搜索图片SearchImage的语法及示例。

功能描述

搜索图片可以根据输入图片，在数据库中搜索相似的图片。

前提条件

请确保您已开通视觉搜索服务，若未开通服务请立即开通。

输入限制

  • 图像格式：JPG、JPEG、PNG。
  • 图像大小：不超过3 MB。
  • 图像分辨率：大于128×128像素，小于1024×1024像素。
  • URL地址中不能包含中文字符。

计费说明

关于搜索图片的计费方式及报价，请参见计费介绍。

说明 下方调试接口为付费接口，如需免费体验调试请前往体验中心。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SearchImage

系统规定参数。取值：SearchImage。

DbName String 是 default

数据库名称。
ImageUrl String 是 https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/facebody/face_verification/tangyan/tangyan%20(1).jpeg

图像URL地址。当前仅支持上海地域的OSS链接，如何生成URL请参见生成URL。

Limit Integer 是 5

获取结果数量上限，取值范围1~200。

返回数据

名称 类型 示例值 描述
RequestId String A98DBCEB-45E2-5F5F-B5ED-F2340182FD87

请求ID。
Data Object

返回的结果数据内容。
MatchList Array of MatchList

相似的图片列表。
ImageUrl String http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****

查找结果，相似图像的URL地址。

说明 建议您使用EntryId来做结果判断，这里返回的ImageURL仅是您在建图片库输入的字符串，平台服务端不保留用户图片库的原始图片。如果上传图片库时使用的是有时效性的访问链接，需要您本地保留图片，并保存EntryID和图片的映射关系。
EntityId String 123456

实体ID。
Score Float 10

相似得分，取值0~10，分数越大，相似度越高。
DataId String 001

数据ID。
ExtraData String tangyan

自定义数据。

示例

请求示例

http(s)://imgsearch.cn-shanghai.aliyuncs.com/?Action=SearchImage
&DbName=default
&ImageUrl=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/facebody/face_verification/tangyan/tangyan%20(1).jpeg
&Limit=5
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchImageResponse>
    <RequestId>A98DBCEB-45E2-5F5F-B5ED-F2340182FD87</RequestId>
    <Data>
        <MatchList>
            <EntityId>123456</EntityId>
            <Score>10</Score>
            <DataId>001</DataId>
            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****</ImageUrl>
            <ExtraData>tangyan</ExtraData>
        </MatchList>
        <MatchList>
            <EntityId>123457</EntityId>
            <Score>1.1762875356333269</Score>
            <DataId>002</DataId>
            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1uimages1.jpg?Expires=1635151060&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=%2Byceg79YwiShi1RWDSQ%2FSZcIec****</ImageUrl>
            <ExtraData>tangyan</ExtraData>
        </MatchList>
        <MatchList>
            <EntityId>123458</EntityId>
            <Score>0.9932686334385976</Score>
            <DataId>003</DataId>
            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ximages2.jpg?Expires=1635151141&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=rHoEnFco%2BfLWyzHZGFwUpOaySZ****</ImageUrl>
            <ExtraData>tangyan</ExtraData>
        </MatchList>
        <MatchList>
            <EntityId>123459</EntityId>
            <Score>1.2938829068163327</Score>
            <DataId>004</DataId>
            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1m641.jpg?Expires=1635150931&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=5m8NJ50eokih%2Fcxp%2B%2BnsA%2BTT%2BG****</ImageUrl>
            <ExtraData>tangyan</ExtraData>
        </MatchList>
    </Data>
</SearchImageResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A98DBCEB-45E2-5F5F-B5ED-F2340182FD87",
  "Data" : {
    "MatchList" : [ {
      "EntityId" : 123456,
      "Score" : 10,
      "DataId" : 1,
      "ImageUrl" : "http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****",
      "ExtraData" : "tangyan"
    }, {
      "EntityId" : 123457,
      "Score" : 1.1762875356333269,
      "DataId" : 2,
      "ImageUrl" : "http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1uimages1.jpg?Expires=1635151060&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=%2Byceg79YwiShi1RWDSQ%2FSZcIec****",
      "ExtraData" : "tangyan"
    }, {
      "EntityId" : 123458,
      "Score" : 0.9932686334385976,
      "DataId" : 3,
      "ImageUrl" : "http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ximages2.jpg?Expires=1635151141&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=rHoEnFco%2BfLWyzHZGFwUpOaySZ****",
      "ExtraData" : "tangyan"
    }, {
      "EntityId" : 123459,
      "Score" : 1.2938829068163327,
      "DataId" : 4,
      "ImageUrl" : "http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1m641.jpg?Expires=1635150931&amp;OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&amp;Signature=5m8NJ50eokih%2Fcxp%2B%2BnsA%2BTT%2BG****",
      "ExtraData" : "tangyan"
    } ]
  }
}

错误码

关于搜索图片的错误码，详情请参见常见错误码。

SDK参考

阿里云视觉AI能力支持使用SDK调用，具体可参见SDK总览下载安装。

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。