简介
创建元数据索引功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于创建元数据索引的相关 API 概览以及 SDK 示例代码。
注意:
API | 操作描述 |
创建元数据索引 |
创建元数据索引
功能说明
提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。
方法原型
public CreateFileMetaIndexResponse createFileMetaIndex(CreateFileMetaIndexRequest customRequest)
请求示例
CreateFileMetaIndexRequest request = new CreateFileMetaIndexRequest();request.setAppId("1234567890");// 设置数据集名称,同一个账户下唯一。;是否必传:是request.setDatasetName("test001");// 设置自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。 ;是否必传:否request.getFile().setCustomId("001");// 设置自定义标签。您可以根据业务需要自定义添加标签键值对信息,用于在查询时可以据此为筛选项进行检索,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。 ;是否必传:否request.getFile().setCustomLabels([object Object]);// 设置可选项,文件媒体类型,枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 video:视频。 audio:音频。 ;是否必传:否request.getFile().setMediaType("image");// 设置可选项,文件内容类型(MIME Type),如image/jpeg。 ;是否必传:否request.getFile().setContentType("image/jpeg");// 设置资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos://<BucketName>/<ObjectKey>
/,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址;是否必传:是request.getFile().setURI("cos://examplebucket-1250000000/test.jpg");// 设置输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否request.getFile().setMaxFaceNum(20);CreateFileMetaIndexResponse response = client.createFileMetaIndex(request);
参数说明
Request: 中的具体数据描述如下:
参数名称 | 描述 | 类型 | 是否必传 |
AppId | String | 是 | |
datasetName | 数据集名称,同一个账户下唯一。 | String | 是 |
file | 待建立元数据索引的文件信息及自定义元数据内容。 | Container | 是 |
File 中的具体数据描述如下:
参数名称 | 描述 | 类型 | 是否必传 |
customId | 自定义 ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个 URI 关联到您系统内的某个 ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见 字段和操作符的支持列表。 | String | 否 |
customLabels | HashMap<String, String> | 否 | |
key | 自定义标签键 | String | 否 |
value | 自定义标签值 | String | 否 |
mediaType | 可选项,文件媒体类型,枚举值: image:图片 document:文档 archive:压缩包 video:视频 audio:音频 other:其他 | String | 否 |
contentType | 可选项,文件内容类型(MIME Type),如image/jpeg。 | String | 否 |
uRI | 资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则: cos://<BucketName>/<ObjectKey> ,其中 BucketName 表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。注意: 仅支持本账号内的 COS 文件。 不支持 HTTP 开头的地址。 | String | 是 |
maxFaceNum | 输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。 | Integer | 否 |
persons | 自定义人物属性(仅当数据集模板 ID 为 Official:FaceSearch 有效)。 | Container Array | 否 |
Persons 中的具体数据描述如下:
参数名称 | 描述 | 类型 | 是否必传 |
personId | 自定义人物 ID。 | String | 否 |
响应参数说明:
CreateFileMetaIndexResponse 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
requestId | 请求 ID | String |
eventId | 创建元数据索引的任务 ID | String |
返回结果说明
成功:返回 CreateFileMetaIndexResponse 对象响应信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。