Add your content to vector indexes for fast search and similarity matching.
Project description
Wagtail Vector Index
Wagtail Vector Index provides a way to turn Django models, Wagtail pages, and anything else in to embeddings which are stored in a one of multiple vector database backends.
This provides the backbone for features including:
- Natural language search
- Similarity search
- Content recommendations
Links
Supported Versions
- Wagtail 5.2
- Django 4.2
- Python 3.11, 3.12
Contributing
Install
To make changes to this project, first clone this repository:
git clone https://github.com/wagtail/wagtail-vector-index.git
cd wagtail-vector-index
With your preferred virtualenv activated, install testing dependencies:
Using pip
python -m pip install --upgrade pip>=21.3
python -m pip install -e .'[testing,llm,numpy,pgvector,qdrant,weaviate]' -U
Using flit
python -m pip install flit
python -m flit install -s
pre-commit
Note that this project uses pre-commit. It is included in the project testing requirements. To set up locally:
# go to the project directory
$ cd wagtail-vector-index
# initialize pre-commit
$ pre-commit install
# Optional, run all checks once for this, then the checks will run only on the changed files
$ git ls-files --others --cached --exclude-standard | xargs pre-commit run --files
How to run tests
Now you can run tests as shown below:
tox
or, you can run them for a specific environment tox -e py3.11-django4.2-wagtail5.2
or specific test
tox -e py3.11-django4.2-wagtail5.2 -- tests.test_file.TestClass.test_method
Sometimes tox contains cached dependencies, so if you want to run tests with the latest dependencies, you can use tox -r
or run rm -rf .tox
to delete the whole tox environment.
To run the test app interactively, use tox -e interactive
, visit http://127.0.0.1:8020/admin/
and log in with admin
/changeme
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtail_vector_index-0.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b0c1d9ce434e23e3d4dcd0dcaf78b5d9ab9f64abda6e8e6ef451c3030ab5edf |
|
MD5 | b17c95c0b73b48766b603e1103e81cbc |
|
BLAKE2b-256 | 0e4918a57f671869bca99a5fec7f11131b695edceb295684300e065c0463ed11 |
Hashes for wagtail_vector_index-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4be6e0fa0092279a4c1c5c368fc842e923e5833fb3de6d4fe3d4665775589b6c |
|
MD5 | d5ebcfb153ad171b3d4d5e86a88207c7 |
|
BLAKE2b-256 | 57f4c19b2540b7a541e5a87656e2f2deaa2788c3ef224abce7feeb0b7d1923c8 |