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

Download Open API Spec

SimpleQueryStringQuery

org.sagebionetworks.repo.model.search.dsl.SimpleQueryStringQuery

A simple_query_string full-text clause — a compact mini-DSL (+, |, -, ", *, ()) parsed leniently across the listed columns.

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.
minimum_should_match OBJECT Optional. Minimum number of terms a document must match. An integer or a percentage / formula string.
query STRING Required. The simple-query-string expression.
fields ARRAY<OBJECT> Optional. The columns to search. Each entry may carry a ^boost suffix. Defaults to the index's default search fields.
default_operator STRING Optional. Boolean logic used between terms when no explicit operator is given: or (default) or and.
flags STRING Optional. Pipe-delimited list of enabled syntax features (e.g. AND|OR|PREFIX), or ALL / NONE.
analyzer STRING Optional. Analyzer used to tokenize the query text. Defaults to each field's search analyzer.
analyze_wildcard BOOLEAN Optional. Whether to analyze wildcard terms. Default false. A leading wildcard with this enabled is rejected (it forces a full index scan).
auto_generate_synonyms_phrase_query BOOLEAN Optional. Whether to auto-generate phrase queries for multi-term synonyms. Default true.
fuzzy_max_expansions INTEGER Optional. Maximum number of terms a fuzzy expansion will generate. Default 50.
fuzzy_prefix_length INTEGER Optional. Number of leading characters left unchanged when fuzzy matching.
fuzzy_transpositions BOOLEAN Optional. Whether to count transpositions (ab → ba) as a single edit. Default true.
lenient BOOLEAN Optional. When true, format-based errors are ignored.
quote_field_suffix STRING Optional. Suffix appended to field names for quoted (exact-phrase) portions of the query.