本文档介绍搜索图片SearchImage的语法及示例。
功能描述
SearchImage可以根据输入图片,在数据库中搜索相似的图片。
前提条件
输入限制
- 图片格式:JPG、JPEG、PNG。
- 图片大小:图片大小不超过3M。
- 图片分辨率:大于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~1000。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
返回的结果数据内容。 |
|
MatchList | Array of MatchList |
相似的图片列表。 |
|
DataId | String | 001 |
数据ID。 |
EntityId | String | 123456 |
实体ID。 |
ExtraData | String | tangyan |
自定义数据。 |
ImageUrl | String | http://viapi-test.oss-cn-shanghai.aliyuncs.com/test/facebody/face_verification/tangyan/tangyan%20(1).jpeg |
查找结果,相似图像的URL地址。 |
Score | Float | 10 |
相似得分,取值0~10,分数越大,相似度越高。 |
RequestId | String | 939687b4-e761-402f-a63e-9ef7f938f092 |
请求ID。 |
示例
请求示例
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
格式
<data>
<matchList>
<dataId>001</dataId>
<score>10</score>
<extraData>tangyan</extraData>
<entityId>123456</entityId>
<imageUrl>http://viapi-test.oss-cn-shanghai.aliyuncs.com/test/facebody/face_verification/tangyan/tangyan%20(1).jpeg</imageUrl>
</matchList>
<matchList>
<dataId>002</dataId>
<score>2.6943782648595627</score>
<extraData>tangyan</extraData>
<entityId>123457</entityId>
<imageUrl>http://vigen-invi.oss-cn-shanghai.aliyuncs.com/temp/faceparsing/1.jpeg</imageUrl>
</matchList>
<matchList>
<dataId>003</dataId>
<score>0.9670371546881185</score>
<extraData>tangyan</extraData>
<entityId>123459</entityId>
<imageUrl>http://vigen-invi.oss-cn-shanghai.aliyuncs.com/temp/faceparsing/noface2.jpg</imageUrl>
</matchList>
</data>
<requestId>939687b4-e761-402f-a63e-9ef7f938f092</requestId>
JSON
格式
{
"data": {
"matchList": [
{
"dataId": "001",
"score": 10,
"extraData": "tangyan",
"entityId": "123456",
"imageUrl": "http://viapi-test.oss-cn-shanghai.aliyuncs.com/test/facebody/face_verification/tangyan/tangyan%20(1).jpeg"
},
{
"dataId": "002",
"score": 2.6943782648595627,
"extraData": "tangyan",
"entityId": "123457",
"imageUrl": "http://vigen-invi.oss-cn-shanghai.aliyuncs.com/temp/faceparsing/1.jpeg"
},
{
"dataId": "003",
"score": 0.9670371546881185,
"extraData": "tangyan",
"entityId": "123459",
"imageUrl": "http://vigen-invi.oss-cn-shanghai.aliyuncs.com/temp/faceparsing/noface2.jpg"
}
]
},
"requestId": "939687b4-e761-402f-a63e-9ef7f938f092"
}
错误码
关于搜索图片的错误码,详情请参见常见错误码。
SDK参考
阿里云视觉AI能力支持使用SDK调用,具体可参见SDK总览下载安装。
安全声明
- 请确保上传的图片或文件来源符合相应的法律法规。
- 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。
在文档使用中是否遇到以下问题
更多建议
匿名提交