docs: clarify BM25 is keyword retrieval, not semantic search in unit 2.1 - #697
Open
UdayKiranJadi wants to merge 1 commit into
Open
Conversation
Author
|
Hi! I've submitted a PR to fix this — #697 . Please take a look when you get a chance!" |
yuka-with-data
left a comment
Contributor
There was a problem hiding this comment.
I noticed the PR went with Option 1 (from issue #319), and nice work on the update.
I was also curious how the maintainers would prefer this to evolve, since the surrounding section already starts leaning into vector databases. Option 2 could also fit that flow naturally, but I am fine with either direction depending on the intended framing.
Either way, this is a solid improvement. Thanks for working on it.
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
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.
What this fixes
Closes #319
The
PartyPlanningRetrieverToolexample usesBM25Retriever, which is alexical/keyword-based retrieval algorithm — not semantic search. The code
and surrounding prose incorrectly labeled it as "semantic search", which
confused learners (as noted in the issue thread).
Changes
BM25/keyword-based explanation, including a note on how it differs from
vector-based semantic search
"keyword-based retrieval and LLM reasoning"
descriptionstring: "Uses semantic search" →"Uses keyword-based retrieval (BM25)"