更新元数据索引

最近更新时间:2024-06-07 10:38:42

我的收藏

功能描述

更新数据集内已索引的文件的部分元数据。
并非所有的元数据都允许您自定义更新,在您发起更新请求时需要填写数据集,会根据该数据集的检索模板重新提取元数据并更新已存在的元数据索引,此外您也可以更新部分自定义的元数据索引,如 CustomTags、CustomId 等字段,具体请参考 请求参数说明

授权说明

授权策略中 action 设置为 ci:UpdateFileMetaIndex 。查看所有 action

请求

请求示例

PUT /filemeta HTTP/1.1
Host: <AppId>.ci.<Region>.myqcloud.com
Authorization: Auth String
Content-Length: xxx
Content-Type: application/json
Accept: application/json
说明:
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

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

请求体

{
"DatasetName": "test001",
"File": {
"URI": "cos://examplebucket-1250000000/test1/img.jpg",
"CustomId": "001",
"CustomLabels": {
"age": "18",
"level": "18"
},
"MediaType": "image",
"ContentType": "image/jpeg"
}
}
具体的参数如下:
参数名称
描述
类型
是否必选
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

响应

响应头

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

响应体

{
"EventId": "wie3580c6ca88dd83382cf52540067****",
"RequestId": "NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****"
}
响应包体具体数据内容如下:
参数名称
类型
描述
EventId
String
创建元数据索引的任务 ID。
RequestId
String
请求 ID。