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

Download Open API Spec

MatchPhraseFieldOptions

org.sagebionetworks.repo.model.search.dsl.MatchPhraseFieldOptions

Per-field options for a match_phrase clause. Carried as the value of the field-keyed match_phrase 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.
zero_terms_query STRING Optional. Behavior when the analyzer removes all tokens: none (default) or all.
query OBJECT Required. The phrase to match. A string (or scalar value on a non-text column).
analyzer STRING Optional. Analyzer used to tokenize the phrase. Defaults to the field's search analyzer.
slop INTEGER Optional. Number of positions allowed between matching terms. Default 0 (exact phrase).