创建元数据索引

最近更新时间:2024-06-17 10:23:12

我的收藏

简介

创建元数据索引功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。 本文档提供关于创建元数据索引的相关 API 概览以及 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.8.1。
API
操作描述
提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。

创建元数据索引

功能说明

提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。

使用示例

function createFileMetaIndex() {
// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459
const config = {
// 需要替换成您自己的存储桶信息
AppId: '1250000000', // AppId,必须字段
Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing
};
const key = 'filemeta'; // 固定值
const host = `${config.AppId}.ci.${config.Region}.myqcloud.com`;
const url = `https://${host}/${key}`;
const body = JSON.stringify({
// 自定义数据集名称,同一个账户下唯一。;是否必传:是
DatasetName: 'test-dataset-imagesearch2',
// 元数据索引结果(以回调形式发送至您的回调地址,支持以 http:// 或者 https:// 开头的地址,例如: http://www.callback.com。;是否必传:否
// Callback: 'http://www.callback.com',
// 用于建立索引的文件信息。;是否必传:是
File: {
// 自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见字段和操作符的支持列表。 ;是否必传:否
// CustomId: '001',
// 自定义标签。您可以根据业务需要自定义添加标签键值对信息,用于在查询时可以据此为筛选项进行检索,详情请见字段和操作符的支持列表。 ;是否必传:否
// CustomLabels: {"age":"18","level":"18"},
// 可选项,文件媒体类型,枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 video:视频。 audio:音频。 ;是否必传:否
MediaType: 'image',
// 可选项,文件内容类型(MIME Type),如image/jpeg。 ;是否必传:否
ContentType: 'image/jpeg',
// 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos://<BucketName>,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址;是否必传:是
URI: 'cos://examplebucket-1250000000/exampleImage',
// 输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否
// MaxFaceNum: 20,
// 自定义人物属性(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否
// Persons: {
// },
},
});

cos.request(
{
Method: 'POST', // 固定值,必须
Key: key, // 必须
Url: url, // 请求的url,必须
Body: body, // 请求体参数,必须
Headers: {
// 设置请求体为 json,固定值,必须
'Content-Type': 'application/json',
// 设置响应体为json,固定值,必须
Accept: 'application/json',
},
},
function (err, data) {
if (err) {
// 处理请求失败
console.log(err.code, err.message);
} else {
// 处理请求成功
console.log(data);
}
}
);
}
createFileMetaIndex()

参数说明

cos.request 方法参数说明:
参数名称
参数描述
类型
是否必填
Method
固定值:POST
String
Key
固定值:filemeta
String
Url
请求 url,固定值
String
Body
请求体详情请参见 创建元数据索引
Object
ContentType
设置请求体为 json,固定值
String
Accept
设置响应体为 json,固定值
String

回调函数说明

function(err, data) { ... }
参数名称
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- EventId
创建元数据索引的任务 ID
String
- RequestId
请求 ID
String

相关链接