对象存储创建元数据索引

一、授权说明

通过子账号使用时，需要在授权策略的 action 中添加 ci:CreateFileMetaIndex 权限。数据万象支持的所有操作接口请参见 CI action。

二、使用说明

·文件元数据建立索引数据处理支持列表请参见检索模板与算子。

·文件元数据建立索引有文件总数量限制或加密文件的限制，请参见创建数据集使用参数限制说明。

·文件元数据建立索引后，你可以通过查询接口进行数据检索。

·该接口为异步操作，在你提交请求后，需要一定时间对你提交的文件进行处理，处理完成后才会将元数据存储到数据集内。该过程视数据集所用的检索模板不同、文件内容的不同，需要数秒到数分钟甚至更久。

三、使用限制

使用该接口时，请先确认相关限制条件。详情请参见使用限制。

四、请求示例

POST /filemeta HTTP/1.1Host: <AppId>.ci.<Region>.myqcloud.comAuthorization: Auth StringContent-Length: xxxContent-Type: application/jsonAccept: application/json

注意：说明：

注意：Authorization：Auth String，详情请参见请求签名文档。

五、请求头

此接口仅使用公共请求头部，详情请参见公共请求头部文档。

六、请求体

该请求操作的实现需要有以下请求体。

{ "DatasetName": "test001", "File": { "URI": "cos://examplebucket-1250000000/test.jpg", "CustomId": "001", "CustomLabels": { "age": "18", "level": "18" }, "MediaType": "image", "ContentType": "image/jpeg", "MaxFaceNum": 20, "Persons": [{ "PersonId": "xxxxx" }] }}

具体的参数如下：

参数名称	描述	类型	是否必选
DatasetName	数据集名称，同一个账户下唯一。可通过控制台或接口查询。	String	是
File	待建立元数据索引的文件信息及自定义元数据内容。	Container	是

File 节点内容：

参数名称	描述	类型	是否必选
URI	资源标识字段，表示需要建立索引的文件地址，当前仅支持 COS 上的文件，字段规则：cos://<BucketName>/<ObjectKey>，其中 BucketName 表示 COS 存储桶名称，ObjectKey 表示文件完整路径，例如：cos://examplebucket-1250000000/test1/img.jpg。注意：仅支持本账号内的 COS 文件。不支持 HTTP 开头的地址。	String	是
CustomId	自定义 ID。该文件索引到数据集后，作为该行元数据的属性存储，用于和你的业务系统进行关联、对应。你可以根据业务需求传入该值，例如将某个 URI 关联到你系统内的某个 ID。推荐传入全局唯一的值。在查询时，该字段支持前缀查询和排序，详情请见字段和操作符的支持列表。	String	否
CustomLabels	自定义标签。你可以根据业务需要自定义添加标签键值对信息，用于在查询时可以据此为筛选项进行检索，详情请见字段和操作符的支持列表。	Object	否
MediaType	可选项，文件媒体类型，枚举值： image：图片。 document：文档。archive：压缩包。video：视频。audio：音频。other：其他。	String	否
ContentType	可选项，文件内容类型（MIME Type），如 image/jpeg。	String	否
MaxFaceNum	输入图片中检索的人脸数量，默认值为20，最大值为20。(仅当数据集的检索模板 ID 为 Official:FaceSearch 有效)。	Integer	否
Persons	自定义人物属性(仅当数据集的检索模板 ID 为 Official:FaceSearch 有效)。	Container Array	否

Persons 节点内容：

参数名称	描述	类型	是否必选
PersonId	自定义人物 ID。	String	否

七、响应头

此接口仅返回公共响应头部，详情请参见公共响应头部文档。

八、响应体

{ "EventId": "wie3580c6ca88dd83382cf52540067****", "RequestId": "NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****"}

响应包体具体数据内容如下：

参数名称	类型	描述
RequestId	String	请求 ID。
EventId	String	创建元数据索引的任务 ID。

对象存储 创建元数据索引