简介
本文档提供关于创建元数据索引的相关 API 概览以及 SDK 示例代码。
API | 操作描述 |
提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。 |
创建元数据索引
功能说明
提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。
示例代码
<?phprequire dirname(__FILE__, 2) . '/vendor/autoload.php';$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client(array('region' => $region,'scheme' => 'https', // 审核时必须为https'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {//提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。$result = $cosClient->CreateFileMetaIndex(array('AppId' => 'AppId', // 其中 APPID 获取参考 https://console.cloud.tencent.com/developer'Headers' => array('Accept' => 'application/json','Content-Type' => 'application/json',),'DatasetName'=> 'test001', // 数据集名称,同一个账户下唯一。;是否必传:是// 用于建立索引的文件信息。;是否必传:是'File'=> array('CustomId'=> '001', // 自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见字段和操作符的支持列表。 ;是否必传:否'CustomLabels'=> array('age' => '18','level' => '18',), // 自定义标签。您可以根据业务需要自定义添加标签键值对信息,用于在查询时可以据此为筛选项进行检索,详情请见字段和操作符的支持列表。 ;是否必传:否'MediaType'=> 'image', // 可选项,文件媒体类型,枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 video:视频。 audio:音频。 ;是否必传:否'ContentType'=> 'image/jpeg', // 可选项,文件内容类型(MIME Type),如image/jpeg。 ;是否必传:否'URI'=> 'cos://examplebucket-1250000000/test.jpg', // 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos://<BucketName>/<ObjectKey>,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址;是否必传:是'MaxFaceNum'=> 20, // 输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。;是否必传:否),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
参数名称 | 参数描述 | 类型 | 是否必填 |
DatasetName | 数据集名称,同一个账户下唯一。 | string | 是 |
File | 待建立元数据索引的文件信息及自定义元数据内容。 | File | 是 |
File 的具体数据描述如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
CustomId | 自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请参见 字段和操作符的支持列表。 | string | 否 |
CustomLabels | array() | 否 | |
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 有效)。 | Persons | 否 |
Persons 的具体数据描述如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
PersonId | 自定义人物 ID。 | string | 否 |