search

wagtail / wagtail-vector-index

Store Wagtail pages & Django models as embeddings in vector databases
https://wagtail-vector-index.readthedocs.io/en/latest/
MIT License
20 stars 13 forks source link

Docs examples for custom indexes should mention registration #68

Open emilytoppm opened 5 months ago

emilytoppm commented 5 months ago

Currently, uses of .query or similar methods on custom indexes, created following the examples at https://github.com/wagtail/wagtail-vector-index/blob/main/docs/vector-indexes.md fail with a KeyError unless registered like https://github.com/wagtail/wagtail-vector-index/blob/main/tests/testapp/models.py#L40. We should document this and make sure the examples contain the decorator so they work out of the box.