Update docs so that most examples show enabling only chunk indexes #237
Open
iansrobinson wants to merge 1 commit intomainfrom
Open
Update docs so that most examples show enabling only chunk indexes #237iansrobinson wants to merge 1 commit intomainfrom
iansrobinson wants to merge 1 commit intomainfrom
Conversation
…overriding default of chunk+statement)
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
1 participant
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.
Issue #, if available:
Description of changes:
By default the
VectorStoreFactorycreates both chunk and statement indexes. Statement indexes can by 10x larger than chunk indexes. Chunk indexes are used by traversal-based search; statement indexes by semantic-guided search.Traversal-based search is the recommended query approach moving forwards. Applications that use only traversal-based search do not need to create statement indexes.
The documentation updates here show the
VectorStoreFactorycreating only a chunk index, thereby saving storage and embedding costs. The semantic-guided search documentation shows how to explicitly configure the VectorStoreFactory` to exhibit the current default behaviour (i.e. create both chunk and statement indexes), in anticipation that this default behaviour will change as semantic-guided search is retired.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.