查询元数据索引

最近更新时间:2024-07-11 09:54:11

我的收藏

简介

本文档提供关于查询元数据索引的相关 API 概览以及 SDK 示例代码。
API
操作描述
查询元数据索引

查询元数据索引

功能说明

获取数据集内已完成索引的一个文件的元数据。

示例代码

def ci_describe_file_meta_index():
# 查询元数据索引

response, data = client.ci_describe_file_meta_index(
DatasetName = "数据集名称",
Uri = "cos://facesearch-12500000000/test/img.jpg",
ContentType="application/json"
)
print(response)
print(data)
return response, data

参数说明

调用 ci_describe_file_meta_index 函数,具体请求参数如下:
参数名称
参数描述
类型
是否必填
DatasetName
数据集名称,同一个账户下唯一。
String
Uri
资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则:cos://<BucketName>/<ObjectKey>,其中 BucketName 表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg
注意:
仅支持本账号内的 COS 文件
不支持 HTTP 开头的地址 需 UrlEncode
String

返回结果说明

response 为响应头,data 为响应结果,数据类型都为 dict。
response 内容
返回公共响应头部,详情请参见 公共响应头部 文档。
响应体 data
响应体具体数据内容如下:
参数名称
参数描述
类型
RequestId
请求 ID。
String
Files
文件元数据的结构体。实际返回的数据可能并不包含该结构体的所有属性,这和您索引该文件时选用的工作流模板配置以及文件本身的内容有关。
Container Array
FilesDetail 节点内容:
参数名称
参数描述
类型
CreateTime
元数据创建时间的时间戳,格式为 RFC3339Nano
String
UpdateTime
元数据修改时间的时间戳,格式为 RFC3339Nano
创建元数据后,如果未更新过元数据,则元数据修改时间的时间戳和元数据创建时间的时间戳相同
String
URI
资源标识字段,表示需要建立索引的文件地址
String
Filename
文件路径
String
MediaType
文件媒体类型。 枚举值:
image:图片。
other:其他。
document:文档。
archive:压缩包。
audio:音频。
video:视频。
String
ContentType
文件内容类型(MIME Type)。
String
COSStorageClass
文件存储空间类型。
String
COSCRC64
文件CRC64值。
String
ObjectACL
对象ACL。
String
Size
文件大小,单位为字节。
Integer
CacheControl
指定 Object 被下载时网页的缓存行为。
String
ETag
Object 生成时会创建相应的 ETag ,ETag 用于标识一个 Object 的内容。
String
FileModifiedTime
文件最近一次修改时间的时间戳, 格式为 RFC3339Nano。
String
CustomId
该文件的自定义 ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个 URI 关联到您系统内的某个 ID。推荐传入全局唯一的值。
String
CustomLabels
文件自定义标签列表。储存您业务自定义的键名、键值对信息,用于在查询时可以据此为筛选项进行检索。
Container
DatasetName
数据集名称。
String