docs: omit vector-index properties from results - #1730
Merged
Conversation
Document the --storage-omit-vector-index-properties-on-return flag (setting storage.omit_vector_index_properties_on_return): a new "Omit vector properties from results" section on the vector search page, plus entries in the runtime-settings table and the Storage flags list on the configuration page. Covers the runtime toggle, the explicit-access escape hatch, index-membership semantics, and that dump/WAL/replication are unaffected.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release note
Document the
--storage-omit-vector-index-properties-on-returnflag (runtime settingstorage.omit_vector_index_properties_on_return, Community, defaultfalse). When enabled, properties backed by a vector index (embeddings) are omitted from whole nodes/relationships returned to the client, cutting payload/token bloat for LLM agents and Lab; the value stays accessible via explicit access (n.embedding,properties(n)) and dump/WAL/replication are unaffected.Related product PRs
PRs from product repo this doc page is related to:
memgraph/memgraph#4556
Checklist:
bugfixorfeaturelabel, based on the product PR type you're documentingDocumented in three places: a new "Omit vector properties from results" section on the vector search page, plus rows in the runtime-settings table and the Storage flags list on the configuration page.
Every example was verified against a live instance built from the feature branch: default off (
RETURN nincludes the embedding); afterSET DATABASE SETTING ... TO 'true',RETURN nomits the embedding but keeps a non-indexed float list (plainvec) and other properties, whilen.embeddingandproperties(n)still return it - confirming the decision is by index membership, not name/type. Community feature, so the Enterprise/ME-page checklist item is not applicable; remaining unchecked items (milestone, label, Grammarly, local build) are follow-ups.