Releases · wagtail/wagtail-vector-index

What's Changed

Add LiteLLM support by @tomusher in #64
Refactor vector indexes in to single type by @tomusher in #65
Docs: Update 'Indexing across models' example to include all necessary steps by @ababic in #70
Resolved bug in index.query() that prevented content from similar documents to be included i then LLM query by @berry in #69

Upgrade Considerations

While this package is pre-1.0 we will not be following a deprecation schedule for API changes. This means there's a few things you'll need to tweak to continue using this package after upgrading:

Thewagtail_vector_index.index and wagtail_vector_index.backends modules have been merged and renamed to wagtail_vector_index.storage.
'Vector Backends' have been renamed to 'Storage Providers' to be clearer about what they do and reduce confusion with the use of the word 'backend'. The setting WAGTAIL_VECTOR_INDEX_VECTOR_BACKENDS has been renamed to WAGTAIL_VECTOR_INDEX_STORAGE_PROVIDERS to match.
The similar method on vector indexes has been renamed to find_similar.

To update:

Update any imports as necessary, e.g. wagtail_vector_index.index.models becomes wagtail_vector_index.storage.models
Update your backend configurations, e.g. wagtail_vector_index.backends.pgvector.backend.PgvectorBackend becomes wagtail_vector_index.storage.pgvector.PgvectorStorageProvider
Replace any uses of the similar method with find_similar
Replace your WAGTAIL_VECTOR_INDEX_VECTOR_BACKENDS config, e.g.:

WAGTAIL_VECTOR_INDEX_STORAGE_PROVIDERS = {
    "default": {
        "STORAGE_PROVIDER": "wagtail_vector_index.storage.pgvector.backend.PgvectorStorageProvider",
    }
}