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

Download Open API Spec

PrefixFieldOptions

org.sagebionetworks.repo.model.search.dsl.PrefixFieldOptions

Per-field options for a prefix term-level clause. Carried as the value of the field-keyed prefix map (the map key is the column name). A leading * or ? in value is rejected (it forces a full index scan).

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 prefix the indexed term must start with. A string (or scalar value on a non-text column).
case_insensitive BOOLEAN Optional. When true, matches the prefix regardless of case. Default false.
rewrite STRING Optional. How the multi-term query is rewritten internally.