List of fields and operators for AISearch - Object Storage Service

This topic describes the fields and operators that OSS AISearch supports.

Supported fields

To search for files using the OSSUserMeta.* field, you can replace the asterisk (*) with the key of the user-defined metadata. The system searches for files based on the specified key-value pair, where the key is case-insensitive and the value is case-sensitive.
For example, to search for files that contain the user-defined metadata x-oss-meta-location=hangzhou, set the query condition to {"Field": "OSSUserMeta.x-oss-meta-location", "Value": "hangzhou", "Operation": "eq"}.
To search for files using the OSSTagging.* field, you can replace the asterisk (*) with the key of the object tag. The system searches for files based on the specified key-value pair. Both the key and value of the object tag are case-sensitive.
For example, to search for files that contain the tag owner=John, set the query condition to {"Field": "OSSTagging.owner", "Value": "John", "Operation": "eq"}.

Category	Field	Description	Is this field retrievable?	Fields that can be included in search results
Category	Field	Description	Is this field retrievable?	Semantic content search (regardless of the number of files)	Metadata search (fewer than 100 million files)	Metadata search (100 million to 10 billion files)
Basic information	URI	Object path	✓	✓	✓	✓
	FileModifiedTime	File modification time*	✓	✓	✓	✓
	Filename	File name*	✓	✓	✓	✓
	Size	File size*	✓	✓	✓	✓
	MediaType	Media type*	✓	✓	×	×
	ContentType	MIME type*	✓	✓	×	×
	ProduceTime	Creation time	✓	✓	×	×
	LatLong	Latitude and longitude	✓	✓	×	×
	Title	Title	✓	✓	×	×
OSS object information	ObjectACL	Object Read and Write Permissions	✓	✓	✓	✓
	ETag	ETag	✓	✓	✓	✓
	OSSCRC64	CRC-64	✓	✓	✓	✓
	OSSObjectType	Object type	✓	✓	✓	✓
	OSSStorageClass	Storage class	✓	✓	✓	✓
	OSSTagging.*	Object tagging	✓	✓	✓	✓
	OSSTaggingCount	Number of tags	✓	✓	✓	✓
	OSSUserMeta.*	User-defined metadata	✓	✓	✓	×
	OSSExpiration	Time-to-live (TTL)	✓	✓	✓	×
	AccessControlAllowOrigin	Allowed origins for cross-origin requests	✓	✓	✓	×
	AccessControlRequestMethod	Allowed methods for cross-origin requests	✓	✓	✓	×
	ServerSideDataEncryption	Object encryption algorithm	✓	✓	✓	×
	ServerSideEncryption	Object encryption method	✓	✓	✓	×
	ServerSideEncryptionCustomerAlgorithm	Customer-specified server-side encryption algorithm	✓	✓	✓	×
	ServerSideEncryptionKeyId	Server-side encryption key	✓	✓	✓	×
	CacheControl	HTTP cacheability	✓	✓	✓	×
	ContentDisposition	HTTP response handling	✓	✓	✓	×
	ContentEncoding	HTTP response encoding	✓	✓	✓	×
	ContentLanguage	HTTP response language	✓	✓	✓	×
Image information	ImageHeight	Image height	✓	✓	×	×
Image information	ImageWidth	Image width	✓	✓	×	×
Video information	VideoHeight	Video height	✓	✓	×	×
	VideoWidth	Video width	✓	✓	×	×
	VideoStreams.CodecName	Encoder name	✓	✓	×	×
	VideoStreams.Language	Language	✓	✓	×	×
	VideoStreams.Bitrate	Bitrate	×	✓	×	×
	VideoStreams.FrameRate	Frame rate	×	✓	×	×
	VideoStreams.StartTime	Start time	×	✓	×	×
	VideoStreams.Duration	Duration	×	✓	×	×
	VideoStreams.FrameCount	Frame count	×	✓	×	×
	VideoStreams.BitDepth	Pixel bit depth	×	✓	×	×
	VideoStreams.PixelFormat	Pixel format	×	✓	×	×
	VideoStreams.ColorSpace	Color space	×	✓	×	×
	VideoStreams.Height	Video resolution height	×	✓	×	×
	VideoStreams.Width	Video resolution width	×	✓	×	×
Audio information	AudioStreams.CodecName	Encoder name	✓	✓	×	×
	AudioStreams.Bitrate	Bitrate	×	✓	×	×
	AudioStreams.SampleRate	Sample rate	×	✓	×	×
	AudioStreams.StartTime	Start time	×	✓	×	×
	AudioStreams.Duration	Duration	×	✓	×	×
	AudioStreams.Channels	Number of sound channels	×	✓	×	×
	AudioStreams.Language	Language	✓	✓	×	×
Caption information	Subtitles.CodecName	Encoder name	✓	✓	×	×
	Subtitles.Language	Caption language	✓	✓	×	×
	Subtitles.StartTime	Start time	×	✓	×	×
	Subtitles.Duration	Duration	×	✓	×	×
Media information	Bitrate	Bitrate	✓	✓	×	×
	Artist	Artist	✓	✓	×	×
	AlbumArtist	Album artist	✓	✓	×	×
	Composer	Composer	✓	✓	×	×
	Performer	Performer	✓	✓	×	×
	Album	Album	✓	✓	×	×
	Duration	Media duration	✓	✓	×	×
Geographic information	Addresses.AddressLine	Detailed address	✓	✓	×	×
	Addresses.City	City	✓	✓	×	×
	Addresses.Country	Country	✓	✓	×	×
	Addresses.District	Administrative region	✓	✓	×	×
	Addresses.Language	Address language	✓	✓	×	×
	Addresses.Province	Province	✓	✓	×	×
	Addresses.Township	Township	✓	✓	×	×

Supported operators for fields

Supported query operators include eq (equal to), gt (greater than), gte (greater than or equal to), lt (less than), lte (less than or equal to), match-phrase (string match query), prefix (prefix query), nested (logical conditional query within the same object for array fields), and exist (existence query).
Supported aggregate operators include min (minimum), max (maximum), average, sum, count, distinct (distinct count), and group (group count).

Category

Field

Description

Query operators

Aggregate operators

Sort

gt,

gte, lt, lte

match-phrase

prefix

nested

exist

min, max,

sum, average

count

distinct

group

Basic information

URI

Object path

✓

FileModifiedTime

File modification time*

✓

Filename

File name*

✓

Size

File size*

✓

MediaType

Media type*

✓

ContentType

MIME type*

✓

ProduceTime

Creation time

✓

LatLong

Latitude and longitude

✓

Title

✓

OSS object information

ObjectACL

Object access control

✓

ETag

✓

OSSCRC64

CRC-64

✓

OSSObjectType

Object type

✓

OSSStorageClass

Storage class

✓

OSSTagging.*

Object tagging

✓

OSSTaggingCount

Number of tags

✓

OSSUserMeta.*

User-defined metadata

✓

OSSExpiration

Time-to-live (TTL)

✓

AccessControlAllowOrigin

Allowed origins for cross-origin requests

✓

AccessControlRequestMethod

Allowed methods for cross-origin requests

✓

ServerSideDataEncryption

Server-side data encryption

✓

ServerSideEncryption

Server-side encryption

✓

ServerSideEncryptionCustomerAlgorithm

Customer-specified server-side encryption algorithm

✓

ServerSideEncryptionKeyId

Server-side encryption key

✓

CacheControl

HTTP cacheability

✓

ContentDisposition

HTTP response handling

✓

ContentEncoding

HTTP response encoding

✓

ContentLanguage

HTTP response language

✓

Image information

ImageHeight

Image height

✓

ImageWidth

Image width

✓

Video information

VideoHeight

Video height

✓

VideoWidth

Video width

✓

VideoStreams.CodecName

Encoder name

✓

VideoStreams.Language

Language

✓

VideoStreams.Bitrate

Bitrate

VideoStreams.FrameRate

Frame rate

VideoStreams.StartTime

Start time

VideoStreams.Duration

Duration

VideoStreams.FrameCount

Frame count

VideoStreams.BitDepth

Pixel bit depth

VideoStreams.PixelFormat

Pixel format

VideoStreams.ColorSpace

Color space

VideoStreams.Height

Video resolution height

VideoStreams.Width

Video resolution width

Audio information

AudioStreams.CodecName

Encoder name

✓

AudioStreams.Bitrate

Bitrate

AudioStreams.SampleRate

Sample rate

AudioStreams.StartTime

Start time

AudioStreams.Duration

Duration

AudioStreams.Channels

Number of sound channels

AudioStreams.Language

Language

✓

Caption information

Subtitles.CodecName

Encoder name

✓

Subtitles.Language

Caption language

✓

Subtitles.StartTime

Start time

Subtitles.Duration

Duration

Media information

Bitrate

✓

Artist

✓

AlbumArtist

Album artist

✓

Composer

✓

Performer

✓

Album

✓

Duration

Media duration

✓

Geographic information

Addresses.AddressLine

Detailed address

✓

Addresses.City

City

✓

Addresses.Country

Country

✓

Addresses.District

Administrative region

✓

Addresses.Language

Address language

✓

Addresses.Province

Province

✓

Addresses.Township

Township

✓