docs: correct MMR expansion and stale client-support claims - #528
Merged
Conversation
MMR expands to Maximal Marginal Relevance. Three Database pages said Maximum while the Query Agent pages said Maximal. boost.md and hybrid.md said boost and diversity selection were Python-only. Both ship in TypeScript, Java and C# as well, so the pages were sending four client audiences away from features they already have.
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
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.
Two defects found while reviewing the 1.39 release blog post.
MMR expansion. Three Database pages said "Maximum Marginal Relevance" while the Query Agent pages said "Maximal". Standardized on Maximal.
Client support.
boost.mdandhybrid.mdboth said the feature was Python-only and not yet in TypeScript, Go, Java or C#. Checked against released tags: boost ships in Pythonv4.22.0, TypeScriptv3.14.0, Java6.3.0and C#1.2.0; diversity selection on hybrid ships in Pythonv4.23.0, Java6.3.1and C#1.2.0. Go has neither, and hybrid MMR in TypeScript is genuinely unreleased. Both pages now name real versions.Follow-ups not in this PR: the Python-only examples on those pages now under-serve the clients that do support these features, and TypeScript exports a
Boostfactory class that is unreachable from the package entry point.