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

Download Open API Spec

FuzzyFieldOptions

org.sagebionetworks.repo.model.search.dsl.FuzzyFieldOptions

Per-field options for a fuzzy term-level clause. Carried as the value of the field-keyed fuzzy 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.
value OBJECT Required. The term to match within the allowed edit distance. A string (or scalar value on a non-text column).
fuzziness OBJECT Optional. Allowed edit distance: an integer or AUTO.
max_expansions INTEGER Optional. Maximum number of terms the fuzzy expansion will generate. Default 50.
prefix_length INTEGER Optional. Number of leading characters left unchanged when fuzzy matching.
transpositions BOOLEAN Optional. Whether to count transpositions (ab → ba) as a single edit. Default true.
rewrite STRING Optional. How the multi-term query is rewritten internally.