fix: add missing snippets and indices fields to Highlight types#138
Open
santichausis wants to merge 1 commit into
Open
fix: add missing snippets and indices fields to Highlight types#138santichausis wants to merge 1 commit into
santichausis wants to merge 1 commit into
Conversation
The Typesense API returns different highlight shapes for singular vs array fields. For array fields (e.g. string[]), the response includes snippets (list of strings), indices (list of matched array positions), and matched_tokens as a list of lists. These fields were missing from the Highlight and HighlightExtended TypedDicts. Changed Highlight to total=False since not all fields are present in every response (singular fields have snippet/value, array fields have snippets/indices). Closes typesense#129
tharropoulos
approved these changes
Jun 29, 2026
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.
Summary
Closes #129
Test plan