功能描述
在数据集中建立一个 COS 文件的元数据索引,会根据数据集的检索模板提取元数据去建立索引,支持额外添加自定义的元数据。
授权说明
使用说明
文件元数据建立索引数据处理支持列表请参见 检索模板与算子。
文件元数据建立索引有文件总数量和文件总大小限制,请参考创建数据集(创建数据集)使用参数限制说明。
文件元数据建立索引后,您可以通过查询接口进行数据检索。
该接口为异步操作,在您提交请求后,需要一定时间对您提交的文件进行处理,处理完成后才会将元数据存储到数据集内。该过程视数据集所用的检索模板不同、文件内容的不同,需要数秒到数分钟甚至更久。您可以通过设置回调接收任务完成通知。
请求
请求示例
POST /filemeta HTTP/1.1Host: <AppId>.ci.<Region>.myqcloud.comAuthorization: Auth StringContent-Length: xxxContent-Type: application/jsonAccept: application/json
请求头
请求体
该请求操作的实现需要有以下请求体。
{"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 | 否 | |
Key | 自定义标签键。 | String | 否 |
Value | 自定义标签值。 | String | 否 |
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。 |