Docs/fix distance threshold documentation issue 407 #451
Conversation
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
- Update SemanticCache.__init__ docstring to specify [0-2] range instead of [0-1] - Update SemanticCache.set_threshold docstring to specify [0-2] range - Enhance distance_threshold parameter docs to clarify Redis COSINE units - Fixes inconsistency between docstrings and actual validation logic Relates to #407
- Fix notebook documentation stating 1.0 as max threshold - Update to correctly state 2.0 as maximum for Redis COSINE distance - Add clarification that Redis COSINE distance range is [0-2] Relates to #407
- Add inline comments to README.md explaining Redis COSINE distance scale - Enhance llmcache notebook with distance scale explanation - Add semantic router notebook clarification about distance units - Improves user understanding of threshold values in examples Relates to #407
justin-cechmanek
approved these changes
Dec 15, 2025
Collaborator
justin-cechmanek
left a comment
There was a problem hiding this comment.
Thanks for making these changes
vishal-bala
approved these changes
Dec 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix distance threshold documentation inconsistencies (Part of issue #407)
Summary
Corrects documentation to accurately reflect that Redis COSINE distance thresholds use the range [0-2], not [0-1]. The code validation was already correct, but docstrings and examples were misleading.
Changes
__init__andset_thresholddocstrings to specify [0-2] range