调用IndexImage接口将图片添加到媒体集中，并使用处理引擎进行图片AI识别操作。

注意事项

IndexImage对图片的处理为异步方式，您可以通过GetImage接口获取通过各个引擎处理该图片的结果，该结果通常能在数秒内完成。

ImageUri作为图片的唯一标识，不能重复。如果ImageUri指向的OSS路径中的图片未变化，可以重复调用IndexImage接口重试处理图片失败的引擎。

引擎列表

  • 标签识别
  • 人脸检测识别

调试

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

请求参数

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

操作接口名称，固定取值为IndexImage。
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。

RemarksA String 否 AdminGroup/AdminUserA/

标记信息，为使用者预留的筛选参数，用于记录所需要的信息。

在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：

  • 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入，例如nas://path/to/file。
RemarksB String 否 nas://path/to/file

标记信息，为使用者预留的筛选参数，用于记录所需要的信息。

在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：

  • 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入，例如nas://path/to/file。
SourceType String 否 image

源数据的类型，包括如下选项：

  • image：源数据类型为图片。
  • video：源数据类型为视频。
SourceUri String 否 oss://imm-test/testcases/face1.jpg

图片的OSS URI。

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

SourcePosition String 否 00000000.010

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

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

RemarksC String 否 remarkc

标记信息，为使用者预留的筛选参数，用于记录所需要的信息。

在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：

  • 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入，例如nas://path/to/file。
RemarksD String 否 remarkd

标记信息，为使用者预留的筛选参数，用于记录所需要的信息。

在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：

  • 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入，例如nas://path/to/file。
ExternalId String 否 externalId001

外部ID，用于和您的应用层的ID（如果有）进行绑定。
NotifyEndpoint String 否 http://1111111111.mns.cn-hangzhou.aliyuncs.com

异步反向通知的Endpoint，图片处理结果可以通过该Endpoint异步通知给调用者。使用此功能需要先开通MNS服务，新建topic和queue，并配置订阅关系。具体操作，请参见消息服务MNS快速入门概述。

说明 MNS服务和智能媒体管理必须处于同一地域。
NotifyTopicName String 否 topic2

异步反向通知的TopicName。
RemarksArrayA String 否 ["remarka1","remarka2"]

标记信息列表，格式为数组。
RemarksArrayB String 否 ["remarkb1","remarkb2"]

标记信息列表，格式为数组。

MNS通知

请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持MNS事件通知，则智能媒体管理会为您返回异步通知。通知的消息格式为： 


{
   "eventName": "IndexImageTask",
   "eventSource": "acs:imm",
   "eventTime": "2019-09-03T02:20:50.529Z",
   "eventVersion": "1.0",
   "imm": {
      "ImageUri": "oss://imm-test/testcases/test.jpg",
      "Project": "PhotoTest",
      "RequestId": "4D3950B2-AB3D-4F06-BDF0-271022DA552C",
      "SetId": "test-set",
      "Success": "true"
   }
}

MNS通知返回参数说明请参见下表。

名称

类型

描述

eventName

String

任务类型，返回为固定值IndexImageTask。

imm.ImageUri

String

源数据的OSS URI。

imm.SetId

String

媒体集的唯一标识。

imm.Project

String

项目名称。

imm.RequestId

String

当次请求的Request ID。

imm.Success

String

执行是否成功。取值为true或false。

返回数据

名称 类型 示例值 描述
CreateTime String 2020-11-24T10:56:52.461Z

图片加入媒体集的时间。
ExternalId String externalId001

外部ID，用于和您的应用层的ID（如果有）进行绑定。

如果请求时未设置此参数，则返回值为空。
ImageUri String oss://imm-test/testcases/face1.jpg

图片的OSS URI。
ModifyTime String 2020-11-24T10:56:52.461Z

图片的修改时间。

添加图片后，如果未修改过图片，则图片的修改时间和图片的创建时间相同。
RemarksA String AdminGroup/AdminUserA/

标记信息。

如果请求时未设置此参数，则返回值为空。
RemarksArrayA String ["remarka1","remarka2"]

标记信息列表。

如果请求时未设置此参数，则返回值为空。
RemarksArrayB String ["remarkb1","remarkb2"]

标记信息列表。

如果请求时未设置此参数，则返回值为空。
RemarksB String nas://path/to/file

标记信息。

如果请求时未设置此参数，则返回值为空。
RemarksC String remarkc

标记信息。

如果请求时未设置此参数，则返回值为空。
RemarksD String remarkd

标记信息。

如果请求时未设置此参数，则返回值为空。
RequestId String 144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25

当次请求的Request ID。
SetId String set001

媒体集的唯一标识。

示例

请求示例

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

正常返回示例

XML格式 

<ModifyTime>2020-11-24T10:56:52.461Z</ModifyTime>
<RequestId>144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25</RequestId>
<ExternalId>externalId001</ExternalId>
<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>
<RemarksA>AdminGroup/AdminUserA/</RemarksA>
<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>
<RemarksB>nas://path/to/file</RemarksB>
<RemarksArrayB>["remarkb1","remarkb2"]</RemarksArrayB>
<RemarksC>remarkc</RemarksC>
<RemarksD>remarkd</RemarksD>
<RemarksArrayA>["remarka1","remarka2"]</RemarksArrayA>
<SetId>set001</SetId>

JSON格式 

{
    "ModifyTime": "2020-11-24T10:56:52.461Z",
    "RequestId": "144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25",
    "ExternalId": "externalId001",
    "CreateTime": "2020-11-24T10:56:52.461Z",
    "RemarksA": "AdminGroup/AdminUserA/",
    "ImageUri": "oss://imm-test/testcases/face1.jpg",
    "RemarksB": "nas://path/to/file",
    "RemarksArrayB": "[\"remarkb1\",\"remarkb2\"]",
    "RemarksC": "remarkc",
    "RemarksD": "remarkd",
    "RemarksArrayA": "[\"remarka1\",\"remarka2\"]",
    "SetId": "set001"
}