创建元数据索引

最近更新时间:2024-07-12 09:52:41

我的收藏

简介

本文档提供关于创建元数据索引的相关 API 概览以及 SDK 示例代码。
API
操作描述
提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。

SDK API 参考

SDK 所有接口的具体参数与方法说明,请参考 SDK API

创建元数据索引

功能说明

提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。
注意:
COS iOS SDK 版本需要大于等于 v6.4.1。

示例代码

Objective-C
QCloudCreateFileMetaIndexRequest * request = [QCloudCreateFileMetaIndexRequest new];
request.regionName = @"COS_REGIONNAME";
request.input = [QCloudCreateFileMetaIndex new];
// 数据集名称,同一个账户下唯一。;是否必传:是
request.input.DatasetName = @"test001";
// 用于建立索引的文件信息。;是否必传:是
request.input.File = [QCloudFile new];
// 自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。 ;是否必传:否
request.input.File.CustomId = @"001";
// 自定义标签。您可以根据业务需要自定义添加标签键值对信息,用于在查询时可以据此为筛选项进行检索,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。 ;是否必传:否
request.input.File.CustomLabels = @{@"key":@"value"};
// 可选项,文件媒体类型,枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 video:视频。 audio:音频。 ;是否必传:否
request.input.File.MediaType = @"image";
// 可选项,文件内容类型(MIME Type),如image/jpeg。 ;是否必传:否
request.input.File.ContentType = @"image/jpeg";
// 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos:///,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址;是否必传:是
request.input.File.URI = @"cos://examplebucket-1250000000/test.jpg";
// 输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否
request.input.File.MaxFaceNum = 20;
// 自定义人物属性(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否
request.input.File.Persons = @[[QCloudPersons new]];

[request setFinishBlock:^(QCloudCreateFileMetaIndexResponse * outputObject, NSError *error) {
// result:QCloudCreateFileMetaIndexResponse 包含所有的响应;
// 具体查看代码注释或api文档:https://cloud.tencent.com/document/product/460/106022
}];
[[QCloudCOSXMLService defaultCOSXML] CreateFileMetaIndex:request];

说明:
更多完整示例,请前往 GitHub 查看。
Swift
let request : QCloudCreateFileMetaIndexRequest = QCloudCreateFileMetaIndexRequest();
request.regionName = "COS_REGIONNAME";
request.input = QCloudCreateFileMetaIndex();
// 数据集名称,同一个账户下唯一。;是否必传:是
request.input.datasetName = "test001";
// 用于建立索引的文件信息。;是否必传:是
request.input.file = QCloudFile();
// 自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。 ;是否必传:否
request.input.file.customId = "001";
// 自定义标签。您可以根据业务需要自定义添加标签键值对信息,用于在查询时可以据此为筛选项进行检索,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。 ;是否必传:否
request.input.file.customLabels = NSDictionary() as! [AnyHashable : Any];
// 可选项,文件媒体类型,枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 video:视频。 audio:音频。 ;是否必传:否
request.input.file.mediaType = "image";
// 可选项,文件内容类型(MIME Type),如image/jpeg。 ;是否必传:否
request.input.file.contentType = "image/jpeg";
// 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos:///,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址;是否必传:是
request.input.file.uri = "cos://examplebucket-1250000000/test.jpg";
// 输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否
request.input.file.maxFaceNum = 20;

request.finishBlock = { result, error in
// result:QCloudCreateFileMetaIndexResponse 包含所有的响应;
// 具体查看代码注释或api文档:https://cloud.tencent.com/document/product/460/106022
};
QCloudCOSXMLService.defaultCOSXML().createFileMetaIndex(request);

说明:
更多完整示例,请前往 GitHub 查看。