This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/python/enums/search-display.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. SearchDisplay

How a text-search result is rendered. The matches are the same across all of these — only the presentation differs.

from nutrient_sdk import SearchDisplay

Values

NameValueDescription
SearchDisplay.WINDOWS0Lines A-B header + the window text, blank-line separated. The default.
SearchDisplay.TEXT1The window text only — no line headers.
SearchDisplay.LINES2The 1-based line ranges only (e.g. 12-16), one per line.
SearchDisplay.MATCHES3Match #N header + text, with a horizontal-rule separator between matches. A compact, numbered format for listing several results.
SearchDisplay.FULL4Lines A-B (score S) header + text — scores included.
SearchDisplay.JSON5A JSON array of {line, start, end, score, text} objects.

Usage Example

from nutrient_sdk import SearchDisplay
# Access enum values
value = SearchDisplay.WINDOWS
print(f"Value: {value}") # Output: Value: SearchDisplay.WINDOWS
print(f"Integer value: {value.value}") # Output: Integer value: 0