全部产品
云市场

IndexImage 索引图片

更新时间:2019-09-12 17:57:39

描述

传入一张图片,将其添加到媒体集 Set 中。并使用处理引擎进行 AI 识别操作。

IndexImage 对图片的处理是异步的,可通过 GetImage 接口获取该图片各个引擎的处理结果。该结果通常应在数秒内完成。

ImageUri 为唯一主键,不允许重复。如果 ImageUri 指向的 OSS 路径中的图片未变化,可以反复调用 IndexImage 接口,对失败的引擎进行重试。

当前支持引擎列表

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

请求参数

Parameter Type Required Comment
Project string Y Project 名称。
SetId string Y 媒体集 Set 的唯一标识。
ImageUri string Y 图片的 OSS Uri ,如 oss://imm-test/testcases/face1.jpg
OSS 地址规则为:oss://bucket/object,其中 bucket和当前 Project 在同一区域的 OSS 桶名, object 为文件路径。
RemarksA string N Remarks 标记信息
RemarksB string N Remarks 标记信息
RemarksC string N Remarks 标记信息
RemarksD string N Remarks 标记信息
ExternalId string N 外部 ID,用于和您的应用层的 ID (如果有)进行绑定
NotifyTopicName string N MNS 订阅的 Topic 主题名称
NotifyEndpoint string N MNS 订阅的 Endpoint

关于 MNS 的使用方式,参考 消息服务 MNS 概述

返回参数

Parameter Type Comment
RequestId string 该次请求的唯一识别码。
SetId string 媒体集 Set 的唯一标识。
ImageUri string 图片的 OSS Uri
CreateTime string 该图片加入 Set 时间。
ModifyTime string 该图片被 UpdateImage 接口修改的时间。
RemarksA string Remarks 标记信息
RemarksB string Remarks 标记信息
RemarksC string Remarks 标记信息
RemarksD string Remarks 标记信息
ExternalId string 外部 ID,用于和您的应用层的 ID (如果有)进行绑定

示例

请求示例

  1. POST https://imm.cn-shanghai.aliyuncs.com
  2. ?Action=IndexImage
  3. &Project=test-project
  4. &SetId=test-set
  5. &ImageUri=oss://imm-test/testcases/test.jpg
  6. ...

此处的示例,目的是展示关键参数,还需要其他的公共参数才能正常调用,推荐使用 SDK 来发送 API

成功返回示例

  1. {
  2. "RequestId": "C685AE1C-CCC3-4E3F-9661-F58FCBDEAA9E",
  3. "SetId": "test-set",
  4. "ImageUri": "oss://imm-test/testcases/test.jpg",
  5. "CreateTime": "2018-12-12T06:20:54Z",
  6. "ModifyTime": "2018-12-12T06:20:54Z",
  7. "ExternalId": "",
  8. "RemarksA": "",
  9. "RemarksB": "",
  10. "RemarksC": "",
  11. "RemarksD": ""
  12. }

订阅消息返回示例

返回参数

Parameter Type Comment
eventName string 任务类型,返回固定值 IndexImageTask
imm.ImageUri string 图片的 OSS Uri
imm.SetId string 媒体集 ID
imm.Project string Project 名称。
imm.RequestId string 该次请求的唯一识别码。
imm.Success string 成功与否。true / false

MNS 返回的消息格式如:

  1. {
  2. "eventName": "IndexImageTask",
  3. "eventSource": "acs:imm",
  4. "eventTime": "2019-09-03T02:20:50.529Z",
  5. "eventVersion": "1.0",
  6. "imm": {
  7. "ImageUri": "oss://imm-test/testcases/test.jpg",
  8. "Project": "PhotoTest",
  9. "RequestId": "4D3950B2-AB3D-4F06-BDF0-271022DA552C",
  10. "SetId": "test-set",
  11. "Success": "true"
  12. }
  13. }

若在使用中有疑问,请参考 FAQ,或者进入 钉钉用户群 实时交流。