immich/docs/docs/features/search.md
Steven Carter d4146e3e6d
feat(server): provide the ability to search archived photos (#6332)
* Feat: provide the ability to search archived photos

Adds a query parameter (`searchArchived`) to the search URL parameters
to allow the results to contain archived photos.

* chore: rename includeArchived => withArchived

* chore: open api

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-18 02:08:00 +00:00

792 B

Search

Immich uses Postgres as its search database for both metadata and smart search.

Smart search is powered by the pgvecto.rs extension, utilizing machine learning models like CLIP to provide relevant search results. This allows for freeform searches without requiring specific keywords in the image or video metadata.

Metadata search (prefixed with m:) can search specifically by text without the use of a model.

Archived photos are not included in search results by default. To include them, add the query parameter withArchived=true to the url.

Some search examples: <img src={require('./img/search-ex-2.webp').default} title='Search Example 1' />

<img src={require('./img/search-ex-3.webp').default} title='Search Example 2' />