文档

IndexFileMeta - 文件元信息建立索引

更新时间:

对输入的文件进行数据处理如标签识别、人脸检测、地点检测等,将提取的文件元信息建立索引,支持用户在一个数据集内多样化的数据检索。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格
  • 文件元信息建立索引数据处理支持列表请参见工作流模板与算子
  • 文件元信息建立索引有文件总数量和文件总大小限制,请参考使用限制说明中数据集限制部分, 关于数据集创建请参考参数说明。
  • 文件元信息建立索引支持地域列表请参考使用限制说明中各地域支持的功能,数据集与索引部分。
  • 文件元信息建立索引后,您可以通过简单查询进行数据检索,其他检索能力请见查询与统计,还可以通过创建人脸聚类产生人脸分组,其他聚类能力请见智能管理
说明
  • 该接口为异步操作,在您提交请求后,需要一定时间对您提交的文件进行处理,处理完成后才会将元数据存储到数据集内。该过程视工作流模板与算子不同、文件内容不同,需要数秒到数分钟甚至更久。您可以通过消息订阅能力接收任务完成通知。
  • 调试

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

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    imm:IndexFileMetacreate
    • Dataset
      acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

    请求参数

    名称类型必填描述示例值
    ProjectNamestring

    项目名称,获取方式请参见创建项目

    test-project
    DatasetNamestring

    数据集名称, 获取方式请参见创建数据集

    test-dataset
    FileInputFile

    需要索引的文件,格式为 JSON。请参考结构体定义。

    NotificationNotification

    消息通知配置,详细内容请点击 Notification 查看,异步通知消息格式请参见异步通知消息格式元数据索引一栏。

    返回参数

    名称类型描述示例值
    object

    响应结构体。

    RequestIdstring

    请求 ID。

    6E93D6C9-5AC0-49F9-914D-E02678D3****
    EventIdstring

    事件 ID。

    30F-1D8FxFzDXKJH9YQdve4CjR****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****",
      "EventId": "30F-1D8FxFzDXKJH9YQdve4CjR****"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-04-15OpenAPI 入参发生变更查看变更详情
    2023-04-23OpenAPI 去除了 deprecated 标记查看变更详情
    2023-03-27OpenAPI 入参发生变更查看变更详情
    2023-03-09OpenAPI 入参发生变更查看变更详情
    2022-08-16OpenAPI 入参发生变更查看变更详情
    2022-08-16OpenAPI 入参发生变更查看变更详情
    2021-06-15新增 OpenAPI查看变更详情