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

Download Open API Spec

MultiMatchQuery

org.sagebionetworks.repo.model.search.dsl.MultiMatchQuery

A multi_match full-text clause — a match run across several columns at once.

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 to match across the listed columns. A string.
fields ARRAY<OBJECT> Required. The columns to search. Each entry may carry a ^boost suffix (e.g. title^2).
type STRING Optional. How the per-field matches are combined: best_fields (default), most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.
operator STRING Optional. Boolean logic used to combine the analyzed terms: or (default) or and.
tie_breaker NUMBER Optional. Weight (0–1) applied to non-best field scores in best_fields / cross_fields.
analyzer STRING Optional. Analyzer used to tokenize the query text. Defaults to each field's search analyzer.
max_expansions INTEGER Optional. Maximum number of terms a fuzzy / prefix expansion will generate. Default 50.
slop INTEGER Optional. Number of positions allowed between matching terms for the phrase types.
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 are ignored.