| Name | Type | Description | Notes |
|---|---|---|---|
| fragmentSize | Object | Maximum size of the text fragments in highlighted snippets per field | [optional] |
| limit | Object | Maximum size of snippets per field | [optional] |
| limitSnippets | Object | Maximum number of snippets per field | [optional] |
| limitWords | Object | Maximum number of words per field | [optional] |
| numberOfFragments | Object | Total number of highlighted fragments per field | [optional] |
| afterMatch | String | Text inserted after the matched term, typically used for HTML formatting | [optional] |
| allowEmpty | Boolean | Permits an empty string to be returned as the highlighting result. Otherwise, the beginning of the original text would be returned | [optional] |
| around | Integer | Number of words around the match to include in the highlight | [optional] |
| beforeMatch | String | Text inserted before the match, typically used for HTML formatting | [optional] |
| emitZones | Boolean | Emits an HTML tag with the enclosing zone name before each highlighted snippet | [optional] |
| encoder | EncoderEnum | If set to 'html', retains HTML markup when highlighting | [optional] |
| fields | Object | [optional] | |
| forceAllWords | Boolean | Ignores the length limit until the result includes all keywords | [optional] |
| forceSnippets | Boolean | Forces snippet generation even if limits allow highlighting the entire text | [optional] |
| highlightQuery | QueryFilter | [optional] | |
| htmlStripMode | HtmlStripModeEnum | Defines the mode for handling HTML markup in the highlight | [optional] |
| limitsPerField | Boolean | Determines whether the 'limit', 'limit_words', and 'limit_snippets' options operate as individual limits in each field of the document | [optional] |
| noMatchSize | NoMatchSizeEnum | If set to 1, allows an empty string to be returned as a highlighting result | [optional] |
| order | OrderEnum | Sets the sorting order of highlighted snippets | [optional] |
| preTags | String | Text inserted before each highlighted snippet | [optional] |
| postTags | String | Text inserted after each highlighted snippet | [optional] |
| startSnippetId | Integer | Sets the starting value of the %SNIPPET_ID% macro | [optional] |
| useBoundaries | Boolean | Defines whether to additionally break snippets by phrase boundary characters | [optional] |
| Name | Value |
|---|---|
| DEFAULT | "default" |
| HTML | "html" |
| Name | Value |
|---|---|
| NONE | "none" |
| STRIP | "strip" |
| INDEX | "index" |
| RETAIN | "retain" |
| Name | Value |
|---|---|
| NUMBER_0 | 0 |
| NUMBER_1 | 1 |
| Name | Value |
|---|---|
| ASC | "asc" |
| DESC | "desc" |
| SCORE | "score" |