Segment

A location inside a file where a full-text search match occurred, allowing clients to deep-link the user to the match. Part of the segments extension.

Each segment is one of the registered segment types, discriminated by type. New segment types are added by revision of this specification; clients MUST skip segments with a type value they do not recognise rather than fail.

type stringrequired

A location inside a file where a full-text search match occurred, allowing clients to deep-link the user to the match. Part of the segments extension.

Each segment is one of the registered segment types, discriminated by type. New segment types are added by revision of this specification; clients MUST skip segments with a type value they do not recognise rather than fail.

Possible values: [page, time-aligned-annotation]

page

A search match located on a page of a paginated document, such as a PDF.

pageintegerrequired

The 1-based page number the match occurred on.

Possible values: >= 1

Example: 3

highlightstring[]required

Matched text fragments from this page, using the same marking convention as searchExtra.highlight.

time-aligned-annotation

A search match located in a time-aligned annotation, such as an ELAN annotation tier.

tierstringrequired

The identifier of the annotation tier the match occurred in (for ELAN, the TIER_ID).

Example: A_phrase-segnum-en

startMsintegerrequired

The start of the matching annotation, in milliseconds from the beginning of the media.

Possible values: >= 0

Example: 83000

endMsintegerrequired

The end of the matching annotation, in milliseconds from the beginning of the media.

Possible values: >= 0

Example: 87500

highlightstring[]required

Matched text fragments from this annotation, using the same marking convention as searchExtra.highlight.

Segment

{
  "type": "page",
  "page": 3,
  "highlight": [
    "string"
  ]
}