feat: add maxCharacters param for highlights, deprecate numSentences/highlightsPerUrl#118
Open
feat: add maxCharacters param for highlights, deprecate numSentences/highlightsPerUrl#118
Conversation
…highlightsPerUrl - Add maxCharacters parameter to HighlightsContentsOptions type - Mark numSentences and highlightsPerUrl as deprecated with JSDoc annotations - Default is 2000 characters distributed across multiple highlights Co-Authored-By: liam@exa.ai <liam.hinzman@gmail.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Summary
Adds the new
maxCharactersparameter toHighlightsContentsOptionstype and marksnumSentencesandhighlightsPerUrlas deprecated with JSDoc annotations. This aligns the TypeScript SDK with the API changes inclaude/update-highlights-params-Rj1d8.The new parameter controls the maximum total characters across all highlights per URL (default: 2000), replacing the sentence-based approach.
Review & Testing Checklist for Human
claude/update-highlights-params-Rj1d8being deployed. SDK release should not happen before the API supportsmaxCharactersexa.searchAndContents("test", { highlights: { maxCharacters: 1000 } })against the updated backend to confirm it worksNotes
This is a type-only change with no runtime logic modifications. Backward compatibility is maintained - existing code using
numSentencesorhighlightsPerUrlwill continue to work.Requested by @LiamHz
Link to Devin run: https://app.devin.ai/sessions/f82de373837142da8261ab1462c223eb