docs(sdk): document silent truncation at recall() default limit#278
Open
DCSteve96 wants to merge 2 commits into
Open
docs(sdk): document silent truncation at recall() default limit#278DCSteve96 wants to merge 2 commits into
DCSteve96 wants to merge 2 commits into
Conversation
Collaborator
Style Guide AuditAll 1 file(s) pass the style guide audit. |
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
2 participants
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.
Addresses #271 (docs side).
recall()defaults tolimit: 10and truncates silently — the response carries no flag, andtotalcan't serve as one (after the client-sidemaxDistancefilter it mirrorsresults.length). Until the API can signal truncation, this labels the foot-gun where developers meet it: JSDoc onRecallOptions.limitand a warning callout in the SDK API reference.Real-world impact: our Session 4 agent (Kairos · World Cup) computed wrong accuracy stats because a prediction-history recall was capped at 10 with no indication.
Happy to mirror the note in the Python SDK docs if useful.