feat(core): add opt-in OR search fallback - #144
Open
kongtou20070406 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The change is opt-in, preserves existing default behavior, and is covered by targeted tests and updated documentation.
Pull request overview
This PR adds an opt-in fallback: 'or' mode to the Core search() helper so that multi-token semantic-history searches can broaden recall only when the initial FTS query returns zero hits, while preserving current exact/FTS5 semantics as the default behavior.
Changes:
- Add
opts.fallback: 'or'tosearch()to retry a safe-token OR query only after a zero-hit primary search. - Add unit coverage to ensure broadening is opt-in, activates only on empty results, and retains visibility filters.
- Document the new option in the shipped skill and API reference, including guidance on when not to use it.
File summaries
| File | Description |
|---|---|
| tests/query.test.mjs | Adds regression coverage for opt-in OR fallback behavior and filter preservation. |
| skill-doc/SKILL.md | Updates the recommended semantic-history retrieval pattern to opt into fallback: 'or' and documents intended usage. |
| skill-doc/references/api-reference.md | Extends the search() API reference to include and explain opts.fallback. |
| packages/core/src/query.ts | Implements fallback: 'or' by retrying safe-token OR only when the primary search yields zero rows. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Summary
fallback: 'or'retry when the existing FTS query returns zero rowsCloses #143.
Evidence
npm test -- tests/query.test.mjs: 32/32 passedThe external test split remains sealed and is not used to tune this change.