Skip to content

SearchSnippet

Fields

FieldTypeAlways presentDescription
endintegernoWhere the snippet ends (exclusive), counted as start.
highlightsarray of array of integernoWhere the matched words are in text, as [start, end) character offsets.
startintegernoWhere 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.
textstringnoPlain text, never HTML.

Used by

Markdown version: /docs/reference/schemas/search-snippet.md