调用FindImages接口根据指定条件,例如时间、地点、标签、人物特征等,搜索媒体集中图片。并可以按照给定要求进行排序。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imm:FindImages | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Project | string | 是 | 项目名称。 | immimagetest |
SetId | string | 是 | 媒体集的唯一标识。 | set001 |
ImageSizeRange | string | 是 | 图片大小范围,使用 JSON 格式表示,格式为 | {"MinWidth":100,"MaxWidth":3000,"MinHeight":50,"MaxHeight":5000} |
ImageTimeRange | string | 否 | 图片的时间范围,该时间从 EXIF 信息获取,使用 JSON 格式表示,格式为
| {"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"} |
CreateTimeRange | string | 否 | 图片加入媒体集的时间范围,使用 JSON 格式表示,格式为 | {"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"} |
ModifyTimeRange | string | 否 | 图片更新的时间范围,使用 JSON 格式表示,格式为
| {"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"} |
SourceType | string | 否 | 源数据的类型,包括如下选项:
| image |
SourceUriPrefix | string | 否 | 图片的 OSS URI 的前缀。 | oss://imm-test/ |
RemarksAPrefix | string | 否 | 标记信息的前缀,用于前缀匹配。 | remark |
RemarksBPrefix | string | 否 | 标记信息的前缀,用于前缀匹配。 | remark |
TagNames | string | 否 | 标签列表,设置多个标签时,请使用 JSON 格式表示,此时只有同时包含所有标签的图片才会返回,格式为["脸","人物"]。 | ["脸","人物"] |
OCRContentsMatch | string | 否 | OCR 识别的内容搜索。 | myh |
AgeRange | string | 否 | 年龄范围,使用 JSON 格式表示,格式为 | {"Start":0,"End":99} |
Gender | string | 否 | 性别,可选值为 MALE 和 FEMALE。 | MALE |
Emotion | string | 否 | 表情,可选值为 HAPPY、SAD、ANGRY、SURPRISED、SCARED、DISGUSTED 和 CALM。 | HAPPY |
OrderBy | string | 否 | 排序字段,可选值为 CreateTime、ModifyTime、ImageTime、FacesModifyTime、TagsModifyTime、RemarksA、RemarksB、RemarksC 和 RemarksD。 | CreateTime |
Order | string | 否 | 排序方式,可选值为 ASC 和 DESC。
| ASC |
Marker | string | 否 | 从 Marker 开始按字典序返回图片信息列表。如果不设置此参数,则从头开始返回图片。 | imm |
LocationBoundary | string | 否 | 地理位置范围,使用 JSON 格式表示,格式为 其中 TopLeft(左上)和 BottomRight(右下)两个顶点的格式为 说明
Top 的值必须大于 Bottom 的值,Left 的值必须小于 Right 的值。
| {"TopLeft":"50.2,100.1","BottomRight":"30.5,120.1"} |
RemarksCPrefix | string | 否 | 标记信息的前缀,用于前缀匹配。 | remark |
RemarksDPrefix | string | 否 | 标记信息的前缀,用于前缀匹配。 | remark |
ExternalId | string | 否 | 外部 ID,用于和您的应用层的 ID(如果有)进行绑定。 | externalId001 |
GroupId | string | 否 | 人脸分组 ID。如果人脸未分组,则此参数返回值为 group-not-grouped。 | group-not-grouped |
Limit | integer | 否 | 返回图片的最大个数,默认值为 20,取值范围为 1~100。 | 20 |
FacesModifyTimeRange | string | 否 | 人脸信息更新的时间范围,使用 JSON 格式表示,格式为 | {"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"} |
TagsModifyTimeRange | string | 否 | 标签信息更新的时间范围,使用 JSON 格式表示,格式为 | {"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"} |
AddressLineContentsMatch | string | 否 | 只有当 Location 有值,即带有地理信息标记的文件时,此参数才有效。 地址搜索。 | zhejiang |
RemarksArrayAIn | string | 否 | 只有图片的标签列表中存在至少一个标签匹配查询条件,则图片就会返回。 | ["remarka1","remarka2"] |
RemarksArrayBIn | string | 否 | 只有图片的标签列表中存在至少一个标签匹配查询条件,则图片就会返回。 | ["remarkb1","remarkb2"] |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "810FE908-522F-4951-8AF8-7211890D4B2A",
"Images": [
{
"CroppingSuggestionStatus": "NotProcessed",
"ImageQualityModifyTime": "2020-11-25T10:12:59.57Z",
"TagsFailReason": "Timeout",
"RemarksC": "remarkc",
"CreateTime": "2020-11-25T10:12:59.57Z",
"SourceType": "image",
"FacesFailReason": "Timeout",
"Tags": [
{
"TagConfidence": 0.9812195897102356,
"CentricScore": 0,
"TagName": "脸",
"TagLevel": 2,
"ParentTagName": "人物"
}
],
"FacesModifyTime": "2020-11-25T10:12:59.57Z",
"ImageTime": "2020-11-25T10:12:59.57Z",
"OCRModifyTime": "2020-11-25T10:12:59.57Z",
"AddressModifyTime": "2020-11-25T10:12:59.57Z",
"OCR": [
{
"OCRConfidence": 0.8254936695098877,
"OCRContents": "欢迎使用智能媒体管理",
"OCRBoundary": {
"Top": 12,
"Width": 12,
"Height": 12,
"Left": 12
}
}
],
"ImageQualityFailReason": "Timeout",
"FacesStatus": "Success",
"ImageHeight": 861,
"RemarksArrayA": "[\"remarka1\",\"remarka2\"]",
"Address": {
"Township": "转塘街道",
"District": "西湖区",
"AddressLine": "浙江省杭州市西湖区转塘街道石龙山西路",
"Country": "中国",
"City": "杭州市",
"Province": "浙江省"
},
"ExternalId": "externalId001",
"SourceUri": "oss://imm-test/testcases/face1.jpg",
"ModifyTime": "2020-11-25T10:12:59.57Z",
"FileSize": 69732,
"SourcePosition": "00000000.010",
"Faces": [
{
"Gender": "FEMALE",
"FaceId": "59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51",
"GenderConfidence": 1,
"FaceAttributes": {
"GlassesConfidence": 1,
"Glasses": "NONE",
"Mask": "NONE",
"BeardConfidence": 1,
"MaskConfidence": 1,
"FaceBoundary": {
"Top": 152,
"Width": 139,
"Height": 141,
"Left": 267
},
"HeadPose": {
"Pitch": 18.385589599609375,
"Roll": 4.204030513763428,
"Yaw": 2.4945924282073975
},
"Beard": "NONE"
},
"FaceQuality": 0.9321779608726501,
"Emotion": "HAPPY",
"Age": 29,
"FaceConfidence": 0.9608758687973022,
"EmotionConfidence": 0.7079545259475708,
"Attractive": 0.96,
"GroupId": "group-not-grouped",
"EmotionDetails": {
"HAPPY": 0.7079545259475708,
"SURPRISED": 0.00006676767952740192,
"CALM": 0.2918718755245209,
"DISGUSTED": 0.000033771051676012576,
"ANGRY": 0.00001282201901631197,
"SAD": 0.00001527295717096422,
"SCARED": 0.0000014976058082538657
}
}
],
"ImageQualityStatus": "Success",
"OCRFailReason": "Timeout",
"AddressFailReason": "Timeout",
"ImageQuality": {
"OverallScore": 0.7759467363357544,
"Color": 0.6101377010345459,
"ColorScore": 0.6101377010345459,
"ContrastScore": 0.6101377010345459,
"Contrast": 0.6101377010345459,
"ExposureScore": 0.6101377010345459,
"ClarityScore": 0.6101377010345459,
"Clarity": 0.6101377010345459,
"Exposure": 0.6101377010345459,
"CompositionScore": 0.6101377010345459
},
"CroppingSuggestionModifyTime": "2020-11-25T10:12:59.57Z",
"ImageFormat": "jpg",
"ImageWidth": 500,
"RemarksArrayB": "[\"remarkb1\",\"remarkb2\"]",
"CroppingSuggestion": [
{
"Score": 0.8979608535766602,
"CroppingBoundary": {
"Top": 77,
"Width": 500,
"Height": 499,
"Left": 0
},
"AspectRatio": "1:1"
}
],
"Orientation": "{\"val\":\"Right-top\",\"type\":3}",
"RemarksD": "remarkd",
"TagsStatus": "Success",
"CroppingSuggestionFailReason": "Timeout",
"RemarksA": "remarka",
"ImageUri": "oss://imm-test/testcases/face1.jpg",
"TagsModifyTime": "2020-11-25T10:12:59.57Z",
"OCRStatus": "NotProcessed",
"AddressStatus": "Success",
"Exif": "{\"FileSize\":{\"value\":\"29304\"},\"Format\":{\"value\":\"jpg\"},\"ImageHeight\":{\"value\":\"417\"},\"ImageWidth\":{\"value\":\"500\"},\"ResolutionUnit\":{\"value\":\"2\"},\"XResolution\":{\"value\":\"96/1\"},\"YResolution\":{\"value\":\"96/1\"}}",
"Location": "30.134390,120.074997",
"RemarksB": "remarkb"
}
],
"NextMarker": "CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx",
"SetId": "set001"
}
错误码
访问错误中心查看更多错误码。