调用GetImage接口从媒体集中获取一张图片的信息。

调试

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

请求参数

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

操作接口名称,系统规定参数,固定取值为GetImage。

ImageUri String oss://imm-test/testcases/face1.jpg

图片的OSS URI。

OSS地址规则为oss://bucket/object,其中bucket为和当前项目处于同一区域的OSS Bucket名称,object为文件路径。

Project String immimagetest

项目名称。

SetId String set001

媒体集的唯一标识。

RegionId String cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com,例如当RegionId为cn-hangzhou时,地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

返回数据

名称 类型 示例值 描述
Address Struct

图片地理位置检测结果。

只有图片中包含地理位置信息时,检测结果才有值。

AddressLine String 中国浙江省杭州市西湖区转塘街道石龙山西路

图片地理位置的完整地址。

City String 杭州市

图片地理位置所在城市(或同级)。

Country String 中国

图片地理位置所在国家或地区。

District String 西湖区

图片地理位置所在区(或同级)。

Province String 浙江省

图片地理位置所在省(或同级)。

Township String 转塘街道

图片地理位置所在街道(或同级)。

AddressFailReason String Timeout

图片地理位置检测的失败原因。

只有当图片地理位置检测失败时,此参数才有值。

AddressModifyTime String 2020-11-24T10:56:52.461Z

图片地理位置检测的更新时间。

AddressStatus String Success

图片地理位置检测的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

CreateTime String 2020-11-24T9:56:52.461Z

图片加入媒体集的时间。

CroppingSuggestion Array of CroppingSuggestion

图片的裁减建议。

AspectRatio String 2:3

图片裁剪比例列表。

CroppingBoundary Struct

裁剪框信息。

Height Integer 300

裁剪框高度。单位为px。

Left Integer 10

顶点X坐标,距离左端距离。单位为px。

Top Integer 30

顶点Y坐标,距离顶端距离。单位为px。

Width Integer 200

裁剪框宽度。单位为px。

Score Float 0.8979608535766602

该裁剪方案的美学分数,分数越高表示该方案效果越好,取值范围为0~1。

CroppingSuggestionFailReason String Timeout

裁剪建议提供失败的原因。

只有当图片裁剪建议提供失败时,此参数才有值。

CroppingSuggestionModifyTime String 2020-11-24T10:56:52.461Z

提供最新裁剪建议的时间。

CroppingSuggestionStatus String NotProcessed

提供裁剪建议的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

Exif String {"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}

图片原始EXIF信息,以JSON Object序列化后的格式存储。

ExternalId String externalId001

外部ID,用于和您的应用层的ID(如果有)进行绑定。

Faces Array of Faces

人脸识别结果。

Age String 29

年龄。

Attractive Float 0.96

人脸吸引力,分数越高吸引力越强,取值范围为0~1。

Emotion String HAPPY

心情。

EmotionConfidence Float 0.7079545259475708

心情置信度。

EmotionDetails Struct

七种心情对应的置信度。

ANGRY Float 0.00001282201901631197

ANGRY心情置信度。

CALM Float 0.2918718755245209

CALM心情置信度。

DISGUSTED Float 0.000033771051676012576

DISGUSTED心情置信度。

HAPPY Float 0.7079545259475708

HAPPY心情置信度。

SAD Float 0.00001527295717096422

SAD心情置信度。

SCARED Float 0.0000014976058082538657

SCARED心情置信度。

SURPRISED Float 0.00006676767952740192

SURPRISED心情置信度。

FaceAttributes Struct

人脸其他属性。

Beard String NONE

是否有胡子。

BeardConfidence Float 1

是否有胡子置信度。

FaceBoundary Struct

人脸框信息。

Height Integer 252

人脸框高度。单位为px。

Left Integer 95

顶点X坐标,距离左端距离。单位为px。

Top Integer 191

顶点Y坐标,距离顶端距离。单位为px。

Width Integer 269

人脸框宽度。单位为px。

Glasses String NONE

是否带眼镜。

GlassesConfidence Float 1

是否戴眼镜置信度。

HeadPose Struct

头部朝向。

Pitch Float 18.385589599609375

人脸的俯仰角,取值范围为-180~+180度,可信的范围建议为-30~+30度。

Roll Float 4.204030513763428

内偏转角,取值范围为-180~+180度,可信的建议范围为-45~+45度。

Yaw Float 2.4945924282073975

人脸的左右偏转角,取值范围为-180~+180度,可信的范围建议为-80~+80 度。

Mask String NONE

是否带口罩。

MaskConfidence Float 1

是否带口罩置信度。

FaceConfidence Float 0.9608758687973022

人脸置信度。

FaceId String 59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51

人脸ID。

FaceQuality Float 0.9321779608726501

人脸质量。

Gender String MALE

性别,可选项包括MALE和FEMALE。

GenderConfidence Float 1

性别置信度。

GroupId String group-not-grouped

人脸分组ID。如果人脸未分组,则此参数返回值为group-not-grouped。

FacesFailReason String Timeout

人脸识别的失败原因。

只有当人脸识别失败时,此参数才有值。

FacesModifyTime String 2020-11-24T10:56:52.461Z

人脸识别的更新时间。

FacesStatus String Success

人脸识别的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

FileSize Integer 69732

文件大小,单位为字节。

ImageFormat String jpg

图片格式。

ImageHeight Integer 861

图片高度。

ImageQuality Struct

图片质量分数。

Clarity Float 0.6101377010345459

当前版本不支持此参数。

图片清晰度。

ClarityScore Float 0.6101377010345459

当前版本不支持此参数。

图片曝光程度的分数。

Color Float 0.6101377010345459

当前版本不支持此参数。

图片色度。

ColorScore Float 0.6101377010345459

当前版本不支持此参数。

图片色度的分数。

CompositionScore Float 0.6101377010345459

当前版本不支持此参数。

图片构成的分数。

Contrast Float 0.6101377010345459

当前版本不支持此参数。

图片对比度。

ContrastScore Float 0.6101377010345459

当前版本不支持此参数。

图片对比度的分数。

Exposure Float 0.6101377010345459

当前版本不支持此参数。

图片曝光程度。

ExposureScore Float 0.6101377010345459

当前版本不支持此参数。

图片曝光程度的分数。

OverallScore Float 0.7759467363357544

综合质量分数。

ImageQualityFailReason String Timeout

图片质量打分失败原因。

ImageQualityModifyTime String 2020-11-24T10:56:52.461Z

图片质量打分的更新时间。

ImageQualityStatus String Success

图片质量打分状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

ImageTime String 2020-11-24T10:56:52.461Z

图片的拍摄日期,该日期从EXIF信息中获取。

如果图片EXIF信息无此信息,则返回结果中无此参数。

ImageUri String oss://imm-test/testcases/face1.jpg

图片的OSS URI。

ImageWidth Integer 500

图片宽度。

Location String 30.134390,120.074997

图片地理位置,从EXIF信息中获取,格式为lat,long,以英文逗号(,)分隔的浮点数。

如果图片EXIF信息无此信息,则返回结果中无此参数。

ModifyTime String 2020-11-24T10:56:52.461Z

图片的修改时间。

添加图片后,如果未修改过图片,则图片的修改时间和图片的创建时间相同。

OCR Array of OCR

OCR识别结果。

OCRBoundary Struct

文字位置框信息。

Height Integer 12

文字位置框高度。单位为px。

Left Integer 12

顶点X坐标,距离左端距离。单位为px。

Top Integer 12

顶点Y坐标,距离顶端距离。单位为px。

Width Integer 12

文字位置框宽度。单位为px。

OCRConfidence Float 0.8254936695098877

文字置信度。

OCRContents String 欢迎使用智能媒体管理

文字内容。

OCRFailReason String Timeout

OCR识别的失败原因。

OCRModifyTime String 2020-11-24T10:56:52.461Z

OCR识别的更新时间。

OCRStatus String NotProcessed

OCR识别的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

Orientation String {"val":"Right-top","type":3}

图片旋转值,从EXIF信息中获取。

如果图片EXIF信息无此信息,则返回结果中无此参数。

RemarksA String remarka

标记信息。

RemarksArrayA String ["remarka1","remarka2"]

标记信息列表。

RemarksArrayB String ["remarkb1","remarkb2"]

标记信息列表。

RemarksB String remarkb

标记信息。

RemarksC String remarkc

标记信息。

RemarksD String remarkd

标记信息。

RequestId String D349D345-4744-472C-ABDC-7A29A5E04042

当次请求的Request ID。

SetId String set001

媒体集的唯一标识。

SourcePosition String 00000000.010

只有当SourceType为video时,此参数才生效。

视频中该图片帧处于源视频的时间轴位置。格式为00000000.010,即%8.3f。

SourceType String image

源数据的类型。

SourceUri String oss://imm-test/testcases/face1.jpg

图片的OSS Uri。

Tags Array of Tags

标签识别结果。

ParentTagName String 人物

父级标签名称。

TagConfidence Float 0.9812195897102356

标签置信度。

TagLevel Integer 2

标签级别,取值范围为1~4。

TagName String

标签名称。

TagsFailReason String Timeout

标签识别的失败原因。格式为[HTTPStatusCode ErrorCode] ErrorMessage,例如[400 InvalidResource] Specified resource is too large. Please check.

只有当标签识别失败时,此参数才有值。

TagsModifyTime String 2020-11-24T10:56:52.461Z

标签识别的更新时间。当TagsStatus更改时更新。

TagsStatus String Success

标签识别的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

示例

请求示例

http(s)://[Endpoint]/?Action=GetImage
&ImageUri=oss://imm-test/testcases/face1.jpg
&Project=immimagetest
&SetId=set001
&<公共请求参数>

正常返回示例

XML 格式

<ImageQuality>
    <OverallScore>0.7759467363357544</OverallScore>
</ImageQuality>
<Address>
    <Township>转塘街道</Township>
    <AddressLine>浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>
    <Country>中国</Country>
    <City>杭州市</City>
    <District>西湖区</District>
    <Province>浙江省</Province>
</Address>
<SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>
<SourceType>image</SourceType>
<CroppingSuggestionFailReason/>
<FacesFailReason/>
<AddressFailReason/>
<ImageFormat>jpg</ImageFormat>
<RemarksArrayB>["remarkb1","remarkb2"]</RemarksArrayB>
<Exif>{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}</Exif>
<ImageWidth>500</ImageWidth>
<RemarksArrayA>["remarka1","remarka2"]</RemarksArrayA>
<Faces>
    <FaceConfidence>0.9608758687973022</FaceConfidence>
    <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>
    <FaceQuality>0.9321779608726501</FaceQuality>
    <Attractive>0.96</Attractive>
    <GenderConfidence>1</GenderConfidence>
    <EmotionConfidence>0.7079545259475708</EmotionConfidence>
    <Emotion>HAPPY</Emotion>
    <Gender>FEMALE</Gender>
    <Age>29</Age>
    <GroupId>group-not-grouped</GroupId>
</Faces>
<Faces>
    <EmotionDetails>
        <CALM>0.2918718755245209</CALM>
        <SCARED>0.0000014976058082538657</SCARED>
        <HAPPY>0.7079545259475708</HAPPY>
        <SURPRISED>0.00006676767952740192</SURPRISED>
        <SAD>0.00001527295717096422</SAD>
        <DISGUSTED>0.000033771051676012576</DISGUSTED>
        <ANGRY>0.00001282201901631197</ANGRY>
    </EmotionDetails>
    <FaceAttributes>
        <Beard>NONE</Beard>
        <FaceBoundary>
            <Left>95</Left>
            <Top>191</Top>
            <Height>252</Height>
            <Width>269</Width>
        </FaceBoundary>
        <BeardConfidence>1</BeardConfidence>
        <HeadPose>
            <Pitch>18.385589599609375</Pitch>
            <Roll>4.204030513763428</Roll>
            <Yaw>2.4945924282073975</Yaw>
        </HeadPose>
        <MaskConfidence>1</MaskConfidence>
        <Mask>NONE</Mask>
        <Glasses>NONE</Glasses>
        <GlassesConfidence>1</GlassesConfidence>
    </FaceAttributes>
</Faces>
<Tags>
    <TagName>脸</TagName>
    <TagConfidence>0.9812195897102356</TagConfidence>
    <TagLevel>2</TagLevel>
    <ParentTagName>人物</ParentTagName>
</Tags>
<Tags>
    <TagName>人物</TagName>
    <TagConfidence>0.9812195897102356</TagConfidence>
    <TagLevel>1</TagLevel>
</Tags>
<Tags>
    <TagName>微笑</TagName>
    <TagConfidence>0.7626392841339111</TagConfidence>
    <TagLevel>3</TagLevel>
    <ParentTagName>日常行为</ParentTagName>
</Tags>
<Tags>
    <TagName>日常行为</TagName>
    <TagConfidence>0.7626392841339111</TagConfidence>
    <TagLevel>2</TagLevel>
    <ParentTagName>生活</ParentTagName>
</Tags>
<Tags>
    <TagName>生活</TagName>
    <TagConfidence>0.7626392841339111</TagConfidence>
    <TagLevel>1</TagLevel>
</Tags>
<AddressStatus>Success</AddressStatus>
<ImageQualityModifyTime>2020-11-24T10:56:52.461Z</ImageQualityModifyTime>
<RequestId>D349D345-4744-472C-ABDC-7A29A5E04042</RequestId>
<ImageQualityFailReason/>
<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>
<ImageQualityStatus>Success</ImageQualityStatus>
<TagsStatus>Success</TagsStatus>
<ImageHeight>861</ImageHeight>
<SetId>set001</SetId>
<FileSize>69732</FileSize>
<ModifyTime>2020-11-24T10:56:52.461Z</ModifyTime>
<CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>
<RemarksA>remarka</RemarksA>
<AddressModifyTime>2020-11-24T10:56:52.461Z</AddressModifyTime>
<RemarksB>remarkb</RemarksB>
<TagsFailReason/>
<FacesModifyTime>2020-11-24T10:56:52.461Z</FacesModifyTime>
<RemarksC>remarkc</RemarksC>
<RemarksD>remarkd</RemarksD>
<FacesStatus>Success</FacesStatus>
<ExternalId>externalId001</ExternalId>
<TagsModifyTime>2020-11-24T10:56:52.461Z</TagsModifyTime>
<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>
<OCRStatus>NotProcessed</OCRStatus>
<Location>30.134390,120.074997</Location>

JSON 格式

{
    "ImageQuality": {
        "OverallScore": 0.7759467363357544
    },
    "Address": {
        "Township": "转塘街道",
        "AddressLine": "浙江省杭州市西湖区转塘街道石龙山西路",
        "Country": "中国",
        "City": "杭州市",
        "District": "西湖区",
        "Province": "浙江省"
    },
    "SourceUri": "oss://imm-test/testcases/face1.jpg",
    "SourceType": "image",
    "CroppingSuggestionFailReason": "",
    "FacesFailReason": "",
    "AddressFailReason": "",
    "ImageFormat": "jpg",
    "RemarksArrayB": "[\"remarkb1\",\"remarkb2\"]",
    "Exif": "{\"FileSize\":{\"value\":\"29304\"},\"Format\":{\"value\":\"jpg\"},\"ImageHeight\":{\"value\":\"417\"},\"ImageWidth\":{\"value\":\"500\"},\"ResolutionUnit\":{\"value\":\"2\"},\"XResolution\":{\"value\":\"96/1\"},\"YResolution\":{\"value\":\"96/1\"}}",
    "ImageWidth": 500,
    "RemarksArrayA": "[\"remarka1\",\"remarka2\"]",
    "Faces": [
        {
            "FaceConfidence": 0.9608758687973022,
            "FaceId": "59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51",
            "FaceQuality": 0.9321779608726501,
            "Attractive": 0.96,
            "GenderConfidence": 1,
            "EmotionConfidence": 0.7079545259475708,
            "Emotion": "HAPPY",
            "Gender": "FEMALE",
            "Age": 29,
            "GroupId": "group-not-grouped"
        },
        {
            "EmotionDetails": {
                "CALM": 0.2918718755245209,
                "SCARED": 0.0000014976058082538657,
                "HAPPY": 0.7079545259475708,
                "SURPRISED": 0.00006676767952740192,
                "SAD": 0.00001527295717096422,
                "DISGUSTED": 0.000033771051676012576,
                "ANGRY": 0.00001282201901631197
            },
            "FaceAttributes": {
                "Beard": "NONE",
                "FaceBoundary": {
                    "Left": 95,
                    "Top": 191,
                    "Height": 252,
                    "Width": 269
                },
                "BeardConfidence": 1,
                "HeadPose": {
                    "Pitch": 18.385589599609375,
                    "Roll": 4.204030513763428,
                    "Yaw": 2.4945924282073975
                },
                "MaskConfidence": 1,
                "Mask": "NONE",
                "Glasses": "NONE",
                "GlassesConfidence": 1
            }
        }
    ],
 	"Tags": [
		{
			"TagName": "脸",
			"TagConfidence": "0.9812195897102356",
			"TagLevel": 2,
			"ParentTagName": "人物"
		},
		{
			"TagName": "人物",
			"TagConfidence": "0.9812195897102356",
			"TagLevel": 1
		},
		{
			"TagName": "微笑",
			"TagConfidence": "0.7626392841339111",
			"TagLevel": 3,
			"ParentTagName": "日常行为"
		},
		{
			"TagName": "日常行为",
			"TagConfidence": "0.7626392841339111",
			"TagLevel": 2,
			"ParentTagName": "生活"
		},
		{
			"TagName": "生活",
			"TagConfidence": "0.7626392841339111",
			"TagLevel": 1
		}
	],
    "AddressStatus": "Success",
    "ImageQualityModifyTime": "2020-11-24T10:56:52.461Z",
    "RequestId": "D349D345-4744-472C-ABDC-7A29A5E04042",
    "ImageQualityFailReason": "",
    "ImageUri": "oss://imm-test/testcases/face1.jpg",
    "ImageQualityStatus": "Success",
    "TagsStatus": "Success",
    "ImageHeight": 861,
    "SetId": "set001",
    "FileSize": 69732,
    "ModifyTime": "2020-11-24T10:56:52.461Z",
    "CroppingSuggestionStatus": "NotProcessed",
    "RemarksA": "remarka",
    "AddressModifyTime": "2020-11-24T10:56:52.461Z",
    "RemarksB": "remarkb",
    "TagsFailReason": "",
    "FacesModifyTime": "2020-11-24T10:56:52.461Z",
    "RemarksC": "remarkc",
    "RemarksD": "remarkd",
    "FacesStatus": "Success",
    "ExternalId": "externalId001",
    "TagsModifyTime": "2020-11-24T10:56:52.461Z",
    "CreateTime": "2020-11-24T10:56:52.461Z",
    "OCRStatus": "NotProcessed",
    "Location": "30.134390,120.074997",
    "OCR": []
}