SearchSnippet
Fields
| Field | Type | Always present | Description |
|---|---|---|---|
end | integer | no | Where the snippet ends (exclusive), counted as start. |
highlights | array of array of integer | no | Where the matched words are in text, as [start, end) character offsets. |
start | integer | no | Where the snippet starts, in characters of the text from /v3/filings/{accession}/documents/{document}/text. Offsets apply to the extractor named in index.extractor and can move when it changes. |
text | string | no | Plain text, never HTML. |
Used by
- Part of SearchDocument and SearchHit.
Markdown version: /docs/reference/schemas/search-snippet.md