Update vector index documention for the GA of HFQ and the updated default configuration value#1599
Update vector index documention for the GA of HFQ and the updated default configuration value#1599neo-walker wants to merge 8 commits into
Conversation
…ault configuration value
The bigfix was backported to 2026.06 in time, so it's not actually a bug anymore, but we forgot to update this note
|
I do not believe the test failure is due to this docs change, but rather the new index provider being bumped. Though I do find it had to read these test outputs 😅 |
|
I've made a remark more generic (but equally informative) so we have fewer version numbers to keep up to date, and I've fixed the failing tests. As @parnmatt assumed, it was the provider version having been bumped, while the example results that contained a version had not been updated accordingly.
The assertion error is "Expected property value Does this help demistify the log? On a separate note, in the I then did ctrl-f for The linked section however doesn't contain any info on such feature. Is there something else we need to update beside the content of this PR? |
|
TODO: Remember to cherry-pick to cypher 5. |
stefano-ottolenghi
added
the
cherry-pick-this-to-5.x
|
I'm sure there will be a blog post about it at some point 😅 and @neo-walker will be giving a Nodes talk. It may be worth having a small section about quantisation and the rescoring at some point, along with the other "details you might find interesting". I'm not sure. |
|
Well, as a reader of this page, I am left wondering how I would enable "High-Fidelity Quantization" via configuration settings. Can we link to a specific setting, or clarify how it's enabled? Otherwise we should remove that remark entirely. |
| Instead, Neo4j selects the most feature-rich provider (`vector-2026.07` for vector indexes as of Neo4j 2026.07). | ||
| Previously created `vector-1.0`, `vector-2.0`, `vector-3.0`, and `vector-2026.06` indexes will continue to function. | ||
| It is not possible to specify an index provider when creating indexes in Cypher 25: Neo4j automatically selects the latest provider. | ||
| Indexes created with older providers will continue to function. |
There was a problem hiding this comment.
I think that is fine. I think going forward with CalVer provider names, this becomes a bit more clear anyway.
We also made this change so we could bump more often, so it really does make a difference.
It probably wouldn't hurt to ensure that the "latest" is recorded somewhere.
Obviously vector-2026.07 is the latest as of Neo4j 2026.07 (and hopefully the other indexes will fall instride when we need to update them)
But somewhere noting that the latest is vector-2026.07 will be useful.
People on versions less than that will at least know that there is a newer version available if they upgrade.
People on newer versions will know that despite being on Neo4j 2026.10 that they are still using the newest and don't need to rebuild.
There was a problem hiding this comment.
It probably wouldn't hurt to ensure that the "latest" is recorded somewhere.
Oh yeah fair. I've added it beside the collapsible for 2026.07, so we'll just need to remember to move that tag as new versions come.
|
it's a combination, setting the quantization to scalar (current default) or binary, and having the expansion factor setting be greater than 1.0 (which it is be default with those quantizations) |
|
This PR includes documentation updates Updated pages: |
|
@neo-walker Is there something else you'd like to add to this, or is it good to merge? :) |
|
@stefano-ottolenghi I'm happy. Are you doing the cherry pick or should I open another PR? |
4 participants
No description provided.