Nutrient Java SDK/io.nutrient.sdk.settings/SearchSettings

SearchSettings

public final class SearchSettings

Settings for Search. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document's settings, otherwise the SDK globally when set on SdkSettings.

Functions

Link copied to clipboard
public final String getAlgorithm()
Ranking algorithm id; empty selects the default.
Link copied to clipboard
public final int getContextLines()
Context lines around each hit.
Link copied to clipboard
public final SearchDisplay getDisplay()
How the result is rendered to text.
Link copied to clipboard
public final String getEmitIndexPath()
Path to also write a reusable index to; empty disables.
Link copied to clipboard
public final SearchMode getMode()
How aggressively weak matches are filtered.
Link copied to clipboard
public final String getStemmingLanguage()
ISO 639-1 language whose stemmer to apply (e.g.
Link copied to clipboard
public final int getTopK()
Maximum number of windows to return.
Link copied to clipboard
public final void setAlgorithm(String value)
Ranking algorithm id; empty selects the default.
Link copied to clipboard
public final void setContextLines(int value)
Context lines around each hit.
Link copied to clipboard
public final void setDisplay(SearchDisplay value)
How the result is rendered to text.
Link copied to clipboard
public final void setEmitIndexPath(String value)
Path to also write a reusable index to; empty disables.
Link copied to clipboard
public final void setMode(SearchMode value)
How aggressively weak matches are filtered.
Link copied to clipboard
public final void setStemmingLanguage(String value)
ISO 639-1 language whose stemmer to apply (e.g.
Link copied to clipboard
public final void setTopK(int value)
Maximum number of windows to return.