Skip to main content

SnippetContext

Context information for a search result snippet.

typeType (string)required

Boundary type used for snippet extraction

Possible values: [sentence, paragraph, section, cropped]

section object

Markdown section heading path (e.g., 'Background > Methods')

anyOf
string
offsetOffset (integer)required

Character position of snippet start in full document

cropped_at object

How snippet was cropped: 'maxLength' if truncated, 'boundary' if natural boundary, null if complete

anyOf
string

Possible values: [maxLength, boundary]

SnippetContext
{
"type": "sentence",
"section": "string",
"offset": 0,
"cropped_at": "maxLength"
}