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

Download Open API Spec

MatchFieldOptions

org.sagebionetworks.repo.model.search.dsl.MatchFieldOptions

Per-field options for a match full-text clause. Carried as the value of the field-keyed match 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.
zero_terms_query STRING Optional. Behavior when the analyzer removes all tokens: none (default) or all.
query OBJECT Required. The text (or scalar value on a non-text column) to match. A string, number, or boolean depending on the target column type.
operator STRING Optional. Boolean logic used to combine the analyzed query 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 fuzzy expansion will generate.
cutoff_frequency NUMBER Optional. Term-frequency threshold above which terms are treated as low-importance.
auto_generate_synonyms_phrase_query BOOLEAN Optional. Whether to auto-generate phrase queries for multi-term synonyms. Default true.
lenient BOOLEAN Optional. When true, format-based errors (e.g. a text value against a numeric field) are ignored.