v2.5.0

Semantic search

This release adds semantic search powered by vector embeddings, in addition to the existing full-text search. This leads to the following API changes:

• A new configuration option VECTOR_EMBEDDING_MODEL
• The search CLI command gets an optional --semantic switch to manage the semantic search index (which is separate from the full-text search index, but stored in the same database)
• The /api/search endpoint gets an optional boolean parameter ?semantic
• The /api/metadata endpoint reports whether semantic search is enabled via the server.semantic_search key and the number of objects in the semantic search index via the search.sifts.count_semantic key

AI chat endpoint

Powered by the semantic search, this release adds an AI chat endpoint using the retrieval-augmented generation (RAG) technique (#539).

For setup and usage documentation, see

• https://www.grampsweb.org/install_setup/chat/
• https://www.grampsweb.org/user-guide/chat/

Note that semantic search and AI chat are not supported on the armv7 platform (e.g. Raspberry Pi 32-bit) since they depend on PyTorch. Without these features enabled, Gramps Web continues to support armv7 and we continue to provide images for this platform. The arm64 platform (e.g. Raspberry Pi 64-bit) is fully supported.

Object Query Language

A Python-like query language has been added as an alternative to the "Gramps Query Language" (GQL) by @dsblank #553. See https://github.com/dsblank/object-ql for detais.

Other changes

• Generate app/secret only if SECRET_KEY is unset by @pwalkr in #538
• silence warning gtk version by @JohnRDOrazio in #542
• Fix issue #545: migrate to pyproject.toml by @JohnRDOrazio in #547
• Replace Haar Cascade by YuNet for face detection by @DavidMStraub in #546
• Added Object Query Language by @dsblank in #553
• Provide more insights in emails to admin and self-registered user by @hgohel in #557
• python.linting settings are deprecated by @JohnRDOrazio in #541

New Contributors

• @pwalkr made their first contribution in #538
• @JohnRDOrazio made their first contribution in #542
• @dsblank made their first contribution in #553
• @hgohel made their first contribution in #557

Thank you to all contributors and translators! 🎉

Full Changelog: v2.4.2...v2.5.0