Skip to content

[FIX]: Update Highlight type definition to support array fields and optional attributes #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nikhiladiga wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[FIX]: Update Highlight type definition to support array fields and optional attributes #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/typesense/types/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,14 +727,18 @@ class Highlight(typing.TypedDict):
Schema for highlighting search results.

Attributes:
matched_tokens (list[str]): List of matched tokens.
matched_tokens (list[str] | list[list[str]]): List of matched tokens.
snippet (str): Snippet of the matched tokens.
snippets (list[str]): Snippets of the matched tokens (for array fields).
indices (list[int]): Indices of the matched tokens (for array fields).
value (str): Value of the matched tokens.
"""

matched_tokens: typing.List[str]
snippet: str
value: str
matched_tokens: typing.Union[typing.List[str], typing.List[typing.List[str]]]
snippet: typing.NotRequired[str]
snippets: typing.NotRequired[typing.List[str]]
indices: typing.NotRequired[typing.List[int]]
value: typing.NotRequired[str]


class HighlightExtended(Highlight):
Expand Down