简介
本文档提供关于创建元数据索引的相关 API 概览以及 SDK 示例代码。
API | 操作描述 |
创建元数据索引 |
创建元数据索引
功能说明
提取一个 COS 文件的元数据,在数据集中建立索引。会根据数据集中的算子提取不同的元数据建立索引,也支持建立自定义的元数据索引。
示例代码
def ci_create_file_meta_index():# 创建元数据索引body = {# 数据集名称,同一个账户下唯一。# 是否必传:是'DatasetName': "test001",# 用于建立索引的文件信息。# 是否必传:是'File': {# 自定义ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。# 是否必传:否'CustomId': "001",# 自定义标签。您可以根据业务需要自定义添加标签键值对信息,用于在查询时可以据此为筛选项进行检索,详情请见[字段和操作符的支持列表](https://cloud.tencent.com/document/product/460/106154)。# 是否必传:否'CustomLabels': {"age":"18","level":"18"},# 可选项,文件媒体类型,枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 video:视频。 audio:音频。# 是否必传:否'MediaType': "image",# 可选项,文件内容类型(MIME Type),如image/jpeg。# 是否必传:否'ContentType': "image/jpeg",# 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos://<BucketName>/<ObjectKey>
,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址# 是否必传:是'URI': "cos://examplebucket-1250000000/test.jpg",# 输入图片中检索的人脸数量,默认值为20,最大值为20。(仅当数据集模板 ID 为 Official:FaceSearch 有效)。# 是否必传:否'MaxFaceNum': 20,# 自定义人物属性(仅当数据集模板 ID 为 Official:FaceSearch 有效)。# 是否必传:否'Persons': [{# 自定义人物 ID。# 是否必传:否'PersonId': "xxxxx",}],},}response, data = client.ci_create_file_meta_index(Body=body,ContentType="application/json")print(response)print(data)return response, data
参数说明
调用 ci_create_file_meta_index 函数,具体请求参数如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
Body | 创建元数据索引请求参数 | Container | 是 |
Body 节点内容:
参数名称 | 参数描述 | 类型 | 是否必填 |
DatasetName | 数据集名称,同一个账户下唯一。 | String | 是 |
File | 用于建立索引的文件信息。 | Container | 是 |
File 节点内容:
参数名称 | 参数描述 | 类型 | 是否必填 |
CustomId | 自定义 ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个 URI 关联到您系统内的某个 ID。推荐传入全局唯一的值。在查询时,该字段支持前缀查询和排序,详情请见 字段和操作符的支持列表。 | String | 否 |
CustomLabels | Container | 否 | |
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 | 否 |
返回结果说明
response 为响应头,data 为响应结果,数据类型都为 dict。
response 内容
响应体 data
响应体具体数据内容如下:
参数名称 | 参数描述 | 类型 |
RequestId | 请求 ID | String |
EventId | 创建元数据索引的任务 ID | String |