product-example 1 linked patterns checked
Elasticsearch Search API highlighting
Documents retrieving highlighted snippets from one or more fields so users can see where a query matches, including fragments, field configuration, highlighter types, and cautions for complex boolean queries.
Read with a purpose
What this source can teach
Use this source to inspect a concrete implementation and the decisions visible in its context.
- Start with the original. Open the source and find the guidance or example relevant to your task.
- Trace the connection. Use the claim notes below to see how this site applies the source to specific patterns.
- Check the setting. Compare the source's platform, people, and constraints with your own decision.
Pattern Decisions This Source Supports
| Pattern | Supported decision | Required contract | Claim note |
|---|---|---|---|
| Search result highlighting | Choose search result highlighting when returned results need visible evidence of where the submitted query matched. | A highlight represents the submitted query or configured highlight query, not a decorative emphasis chosen independently from search matching. | Elastic documents highlighted fragments per search hit and cautions that complex query logic may produce highlights that do not map exactly to all query conditions. |
Comparisons supported by this source
- Search result highlighting vs basic search vs search suggestions vs no-results recovery
Elastic documents highlighted fragments per search hit and warns that highlighters may not reflect all boolean query logic in complex cases.
Evidence Role
This source is treated as product-example evidence. Its value comes from the specific claims and setting described above.
Publisher: Elastic. Last checked: .