HighlightFieldOption

October 23, 2025 ยท View on GitHub

Options for controlling the behavior of highlighting on a per-field basis

Properties

NameTypeDescriptionNotes
fragment_sizeintMaximum size of the text fragments in highlighted snippets per field[optional]
limitintMaximum size of snippets per field[optional]
limit_snippetsintMaximum number of snippets per field[optional]
limit_wordsintMaximum number of words per field[optional]
number_of_fragmentsintTotal number of highlighted fragments per field[optional]

Example

from manticoresearch.models.highlight_field_option import HighlightFieldOption

# TODO update the JSON string below
json = "{}"
# create an instance of HighlightFieldOption from a JSON string
highlight_field_option_instance = HighlightFieldOption.from_json(json)
# print the JSON string representation of the object
print(HighlightFieldOption.to_json())

# convert the object into a dict
highlight_field_option_dict = highlight_field_option_instance.to_dict()
# create an instance of HighlightFieldOption from a dict
highlight_field_option_from_dict = HighlightFieldOption.from_dict(highlight_field_option_dict)

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