文档

File

更新时间:
名称类型描述示例值
object

文件元数据信息。

OwnerIdstring

阿里云账号 ID。

102321002467****
ProjectNamestring

项目名称,见创建项目

test-project
DatasetNamestring

数据集名称,见创建数据集

test-dataset
ObjectTypestring

对象类型,固定取值为 file

file
ObjectIdstring

对象唯一 ID。

75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7
UpdateTimestring

元数据修改时间的时间戳, 格式为 RFC3339Nano。

2021-06-29T14:50:13.011643661+08:00
CreateTimestring

元数据创建时间的时间戳, 格式为 RFC3339Nano。

2021-06-29T14:50:13.011643661+08:00
URIstring

文件地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一地域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

PDS 地址规则为 pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。

oss://test-bucket/test-object.jpg
OSSURIstring

OSS 文件的 URI 路径。仅在 URI 为 PDS 地址时使用。

oss://examplebucket/sampleobject.jpg
Filenamestring

文件名称。对于 OSS 文件则为其 ObjectKey。

sampleobject.jpg
MediaTypestring

文件媒体类型。

枚举值:
  • image图片
  • other其他
  • document文档
  • archive压缩包
  • audio音频
  • video视频
image
ContentTypestring

文件内容类型(MIME Type)。

image/jpeg
Sizelong

文件大小,单位为字节。

1000
FileHashstring

文件哈希值。

1d9c280a7c4f67f7ef873e28449dbe17
FileModifiedTimestring

文件最近一次修改时间的时间戳, 格式为 RFC3339Nano。

2021-06-29T14:50:13.011643661+08:00
FileCreateTimestring

文件创建时间的时间戳,格式为 RFC3339Nano。

2021-06-29T14:50:13.011643661+08:00
FileAccessTimestring

文件访问时间的时间戳,格式为 RFC3339Nano。

2021-06-29T14:50:13.011643661+08:00
ProduceTimestring

照片拍摄时间。

2021-06-29T14:50:13.011643661+08:00
LatLongstring

GPS 经纬度信息。

30.134390,120.074997
Timezonestring

时区。预留参数,暂不支持。

Addressesarray

地址信息。

Address

地址信息。

TravelClusterIdstring

预留参数,暂不支持。

-
Orientationlong

图片旋转值,从 EXIF 信息中获取。

如果图片 EXIF 信息无此信息,则返回结果中无此参数。

0
Figuresarray

人物列表。通过 AI 模型自动检测。

FiguresFigure

人物信息。

FigureCountlong

人物数量。

10
Labelsarray

文件标签信息列表。通过 AI 模型自动检测。

LabelsLabel

文件标签信息。

Titlestring

文件标题。

test
ImageWidthlong

图片宽度,单位为像素(px)。

270
ImageHeightlong

图片高度,单位为像素(px)。

500
EXIFstring

图片原始 EXIF 信息,以 JSON Object 序列化后的格式存储。参考 OSS 获取图片信息

{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}
ImageScoreImageScore

图片评分信息。通过 AI 模型自动检测。

CroppingSuggestionsarray

图片的裁剪建议。预留参数,暂不支持。

CroppingSuggestionsCroppingSuggestion

图片的剪裁建议。

OCRContentsarray

OCR 识别结果。预留参数,暂不支持。

OCRContents

OCR 识别结果。

VideoWidthlong

视频画面宽度,单位为像素(px)。

1080
VideoHeightlong

视频画面高度,单位为像素(px)。

1920
VideoStreamsarray

视频流列表。

VideoStreamsVideoStream

视频流。

Subtitlesarray

字幕流列表。

SubtitlesSubtitleStream

字幕流。

AudioStreamsarray

音频流列表。

AudioStreamsAudioStream

音频流。

Artiststring

艺术家。

Jane
AlbumArtiststring

演唱者。

Jane
AudioCoversarray

音频封面。

AudioCoversImage

音频封面。

Composerstring

作曲家。

Jane
Performerstring

演奏者。

Jane
Languagestring

语言,格式为 BCP 47。

eng
Albumstring

专辑。

FirstAlbum
PageCountlong

页数。预留参数,暂不支持。

5
ETagstring

Object 生成时会创建相应的 ETag ,ETag 用于标识一个 Object 的内容。

"1D9C280A7C4F67F7EF873E28449****"
CacheControlstring

指定 Object 被下载时网页的缓存行为。

该字段需要设置 OSS Object HTTP 属性 Cache-Control,详情请参见管理文件元信息

no-cache
ContentDispositionstring

指定 Object 被下载时的名称。

该字段需要设置 OSS Object HTTP 属性 Content-Disposition,详情请参见管理文件元信息

attachment; filename =test.jpg
ContentEncodingstring

指定该 Object 被下载时的内容编码格式。

该字段需要设置 OSS Object HTTP 属性 Content-Encoding,详情请参见管理文件元信息

UTF-8
ContentLanguagestring

Object 内容使用的语言。

该字段需要设置 OSS Object HTTP 属性 Content-Language,详情请参见管理文件元信息

zh-CN
AccessControlAllowOriginstring

允许的跨域请求的来源。

https://aliyundoc.com
AccessControlRequestMethodstring

在实际请求中会用到的方法。

PUT
ServerSideEncryptionCustomerAlgorithmstring

用户在服务端自定义加密文件时使用的加密编码算法。

SM4
ServerSideEncryptionstring

服务器端加密方式。

该字段需要设置 OSS Bucket 服务端加密,详情请参见服务端加密

AES256
ServerSideDataEncryptionstring

Object 的加密算法。

该字段需要设置 OSS Bucket 服务端加密,详情请参见服务端加密

SM4
ServerSideEncryptionKeyIdstring

表示 KMS 托管的用户主密钥。

该字段需要设置 OSS Bucket 服务端加密,详情请参见服务端加密

9468da86-3509-4f8d-a61e-6eab1eac****
OSSStorageClassstring

OSS 存储空间类型。

Standard
OSSCRC64string

CRC64 值。

559890638950338001
ObjectACLstring

OSS 对象 ACL。

default
ContentMd5string

MD5 值。

HZwoCnxPZ/fvhz4oRJ2+Fw==
OSSUserMetaobject

OSS 自定义元数据。

该字段需要设置 OSS Object 自定义元数据,详情请参见管理文件元信息

{"key": "val"}
OSSTaggingCountlong

OSS 对象标签数量。

该字段需要设置 OSS Object 对象标签,详情请参见对象标签

2
OSSTaggingobject

OSS 对象标签。

详情请参见对象标签

{"key": "val"}
OSSExpirationstring

OSS 过期时间。

该字段需要设置 OSS Object HTTP 属性 Expires,详情请参见管理文件元信息

2120-01-01T12:00:00.000Z
OSSVersionIdstring

OSS 文件版本。

该字段需要开启 OSS Bucket 版本控制,详情请参见版本控制介绍

CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****
OSSDeleteMarkerstring

OSS 删除标记。

CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****
OSSObjectTypestring

OSS Object 类型。一般为Normal

Normal
CustomIdstring

该文件的自定义 ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个 URI 关联到您系统内的某个 ID。推荐传入全局唯一的值。

member-image-id-0001
CustomLabelsobject

可选项,文件自定义标签列表。储存您业务自定义的键名、键值对信息,用于在查询时可以据此为筛选项进行检索。

{ "MemberName": "Tim", "Enabled": "True", "ItemCount": "10" }
StreamCountlong

媒体容器中媒体流的数量。

1
ProgramCountlong

媒体容器中节目数量。

1
FormatNamestring

媒体格式名称。

mov
FormatLongNamestring

媒体格式名称的全称。

QuickTime / MOV
StartTimedouble

首帧时间。单位秒。

0.000000
Bitratelong

码率,单位为比特每秒(bit/s)。

13091201
Durationdouble

视频的总时长。单位秒。

15.263000
SemanticTypesarray

在使用 SemanticQuery API 进行语义搜索时,当前文件被搜索出来的原因列表。

string

在使用 SemanticQuery API 进行语义搜索时,当前文件被搜索出来的原因。

可选值如下:

  • content:文档语义内容、图片上的内容相符。
  • text:文档的文字字符串、图片上的文字相符。
  • datetime:文件的创作时间相符。
  • address:文件的创作地点相符。
  • figure:文件中包含的人物名称相符。
    注意 可选值可能随着算法演进而增加。
content
Elementsarray

在使用 SemanticQuery API 进行语义搜索时,和当前搜索内容匹配的文档片段元素列表。

Element

和当前搜索内容匹配的文档片段元素信息。

SceneElementsarray

视频片段元素列表。使用 AI 大模型对视频进行分析后,抽取出来的若干场景片段元素。

SceneElement

视频片段元素信息。

OCRTextsstring

图片中检测到的文本。

阿里云IMM
Reasonstring

文件运行索引失败的原因。

[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****
ObjectStatusstring

文件状态。

Indexed