Skip to content

Highlight.md

Latest commit

 

History

History
executable file
·
32 lines (28 loc) · 2.83 KB

Highlight.md

File metadata and controls

executable file
·
32 lines (28 loc) · 2.83 KB
Raw

ManticoreSearch.Model.Highlight

Properties

Name Type Description Notes
FragmentSize int Maximum size of the text fragments in highlighted snippets per field [optional]
Limit int Maximum size of snippets per field [optional]
LimitSnippets int Maximum number of snippets per field [optional]
LimitWords int Maximum number of words per field [optional]
NumberOfFragments int Total number of highlighted fragments per field [optional]
AfterMatch string Text inserted after the matched term, typically used for HTML formatting [optional] [default to ""]
AllowEmpty bool Permits an empty string to be returned as the highlighting result. Otherwise, the beginning of the original text would be returned [optional]
Around int 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] [default to ""]
EmitZones bool Emits an HTML tag with the enclosing zone name before each highlighted snippet [optional]
Encoder string If set to 'html', retains HTML markup when highlighting [optional]
Fields HighlightFields [optional]
ForceAllWords bool Ignores the length limit until the result includes all keywords [optional]
ForceSnippets bool Forces snippet generation even if limits allow highlighting the entire text [optional]
HighlightQuery QueryFilter Optional query object to customize highlighting behavior [optional]
HtmlStripMode string Defines the mode for handling HTML markup in the highlight [optional]
LimitsPerField bool Determines whether the 'limit', 'limit_words', and 'limit_snippets' options operate as individual limits in each field of the document [optional]
NoMatchSize int If set to 1, allows an empty string to be returned as a highlighting result [optional]
Order string Sets the sorting order of highlighted snippets [optional]
PreTags string Text inserted before each highlighted snippet [optional] [default to ""]
PostTags string Text inserted after each highlighted snippet [optional] [default to ""]
StartSnippetId int Sets the starting value of the %SNIPPET_ID% macro [optional]
UseBoundaries bool Defines whether to additionally break snippets by phrase boundary characters [optional]

[Back to Model list] [Back to API list] [Back to README]