The Open API specification for Synapse is now available for download!

Download Open API Spec

MatchBoolPrefixFieldOptions

org.sagebionetworks.repo.model.search.dsl.MatchBoolPrefixFieldOptions

Per-field options for a match_bool_prefix clause. Carried as the value of the field-keyed match_bool_prefix map (the map key is the column name).

Field Type Description
boost NUMBER Optional. Multiplier for the relevance score of this clause. Default 1.0.
_name STRING Optional. Label echoed back in matched-queries metadata.
fuzziness OBJECT Optional. Allowed edit distance: an integer or AUTO.
fuzzy_rewrite STRING Optional. How the fuzzy query is rewritten internally.
fuzzy_transpositions BOOLEAN Optional. Whether to count transpositions (ab → ba) as a single edit. Default true.
prefix_length INTEGER Optional. Number of leading characters left unchanged when fuzzy matching.
minimum_should_match OBJECT Optional. Minimum number of terms a document must match. An integer or a percentage / formula string.
query OBJECT Required. The text whose terms are matched, with the final term treated as a prefix. A string.
operator STRING Optional. Boolean logic used to combine the analyzed terms: or (default) or and.
analyzer STRING Optional. Analyzer used to tokenize the query text. Defaults to the field's search analyzer.
max_expansions INTEGER Optional. Maximum number of terms the final (prefix) term expands into. Default 50.