Struct MetadataSearchFilters 

pub struct MetadataSearchFilters {

    pub original_file_name: Option<String>,
    pub description: Option<String>,
    pub ocr: Option<String>,
    pub asset_type: Option<String>,
    pub taken_after: Option<String>,
    pub taken_before: Option<String>,
    pub make: Option<String>,
    pub model: Option<String>,
    pub lens_model: Option<String>,
    pub country: Option<String>,
    pub state: Option<String>,
    pub city: Option<String>,
    pub is_favorite: Option<bool>,
    pub is_archived: Option<bool>,
    pub is_motion: Option<bool>,
    pub is_not_in_album: Option<bool>,
    pub with_exif: Option<bool>,
    pub with_deleted: Option<bool>,
    pub person_ids: Option<Vec<String>>,
    pub tag_ids: Option<Vec<String>>,
    pub order: Option<SortOrder>,
    pub rating: Option<u32>,
    pub album_ids: Option<Vec<String>>,
    pub is_encoded: Option<bool>,
    pub is_offline: Option<bool>,
    pub library_id: Option<String>,
    pub created_after: Option<String>,
    pub created_before: Option<String>,
    pub updated_after: Option<String>,
    pub updated_before: Option<String>,
    pub trashed_after: Option<String>,
    pub trashed_before: Option<String>,
    pub visibility: Option<String>,
    pub with_people: Option<bool>,
    pub with_stacked: Option<bool>,
}

Structured filters passed down search operations.

Fields

original_file_name: Option<String>

Inferred or original file name.

description: Option<String>

User description or caption search query.

ocr: Option<String>

Match against OCR-extracted text inside images. Distinct from description (user-set caption) — Immich indexes recognised text during ML processing and exposes it as its own filter dimension on both MetadataSearchDto and SmartSearchDto.

asset_type: Option<String>

"IMAGE" or "VIDEO"; None returns both.

taken_after: Option<String>

ISO 8601 inclusive lower bound on fileCreatedAt.

taken_before: Option<String>

ISO 8601 inclusive upper bound on fileCreatedAt.

make: Option<String>

Camera make.

model: Option<String>

Camera model.

lens_model: Option<String>

Camera lens model.

country: Option<String>

City location.

state: Option<String>

State location.

city: Option<String>

City location.

is_favorite: Option<bool>

True to only return favorited assets.

is_archived: Option<bool>

True to only return archived assets.

is_motion: Option<bool>

True to only return motion photos.

is_not_in_album: Option<bool>

True to only return assets not associated with any albums.

with_exif: Option<bool>

True to only return assets having valid EXIF.

with_deleted: Option<bool>

True to also return deleted assets.

person_ids: Option<Vec<String>>

List of person identifiers to match.

tag_ids: Option<Vec<String>>

List of tag identifiers to match.

order: Option<SortOrder>

Desired sorting order.

rating: Option<u32>

Star rating (1-5).

album_ids: Option<Vec<String>>

Restrict results to specific albums.

is_encoded: Option<bool>

True to only return encoded (transcoded) assets.

is_offline: Option<bool>

True to only return offline assets.

library_id: Option<String>

Restrict to a specific external library.

created_after: Option<String>

ISO 8601 lower bound on asset creation timestamp.

created_before: Option<String>

ISO 8601 upper bound on asset creation timestamp.

updated_after: Option<String>

ISO 8601 lower bound on asset update timestamp.

updated_before: Option<String>

ISO 8601 upper bound on asset update timestamp.

trashed_after: Option<String>

ISO 8601 lower bound on trashed timestamp.

trashed_before: Option<String>

ISO 8601 upper bound on trashed timestamp.

visibility: Option<String>

Visibility filter: “archive”, “timeline”, “hidden”, “locked”.

with_people: Option<bool>

True to include person face data in results.

with_stacked: Option<bool>

True to include stacked asset data in results.

Trait Implementations

impl Clone for MetadataSearchFilters

fn clone(&self) -> MetadataSearchFilters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetadataSearchFilters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetadataSearchFilters

fn default() -> MetadataSearchFilters

Returns the “default value” for a type.

impl Eq for MetadataSearchFilters

impl PartialEq for MetadataSearchFilters

fn eq(&self, other: &MetadataSearchFilters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MetadataSearchFilters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetadataSearchFilters