Using Snippeting in Record Searches

About snippeting
The snippeting feature provides the ability to return an excerpt from a record — called a snippet — to an application user who performs a record search query.

Snippet formatting and size
A snippet consists of search terms, surrounding context words, and ellipses.

Enabling snippeting
You enable snippeting globally for the Oracle Endeca Server via the RECSEARCH_CONFIG configuration document.

Tuning tips for snippeting
Enabling snippeting affects query runtime performance.

Request examples for retrieving snippets
To request snippets with the Conversation Web Service, use the SearchFilter with the specified search interface. The Conversation Web Service returns snippets as part of the RecordListEntry element (which also returns the records themselves).

Enabling snippets per query with the API
You can enable snippets for a particular attribute on a per query basis using the SearchFilter element in the Conversation Web Service.