The Open API specification for Synapse is now available for download!

Download Open API Spec

SearchHighlight

org.sagebionetworks.repo.model.search.SearchHighlight

Per-field highlight payload on a SearchHit. Populated when SearchQuery.highlight was supplied; absent otherwise. Field references are reported as the caller's bare column name — the server strips any .keyword suffix it auto-appended on the request side.

Field Type Description
name STRING The column name.
snippets ARRAY<STRING> Highlighted snippet fragments for this field, in AOSS-returned order. Each element is the original field text with matched terms wrapped in the configured pre/post tags (default: <em> / </em>).