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

Download Open API Spec

SearchIndexQuery

org.sagebionetworks.repo.model.search.table.SearchIndexQuery

A search query against a SearchIndex entity's OpenSearch index. Extends SearchQuery with searchIndexId to identify which index to query.

Field Type Description
searchIndexId STRING The ID of the SearchIndex entity to query.
queryType SearchQueryType The type of full-text query to execute against a search index.
queryText STRING The search text. Null or empty matches all documents.
queryFields ARRAY<STRING> Column names with optional boost (e.g., 'studyName^3'). Empty means all indexed fields.
termsFilters ARRAY<KeyValues> Multi-value filters (IN clause).
rangeFilters ARRAY<KeyRange> Range filters with min and max.
existsFilters ARRAY<STRING> Columns that must have a non-null value.
notExistsFilters ARRAY<STRING> Columns that must be null or missing.
fuzziness STRING Typo tolerance: 'AUTO', '0', '1', or '2'.
facetRequests ARRAY<FacetRequest> Columns to aggregate as facets.
returnFields ARRAY<STRING> Columns to include in results. Empty means all columns.
sort ARRAY<SortField> Sort order. Default: relevance descending.
highlight BOOLEAN Whether to return highlighted snippets. Default: false.
offset INTEGER Zero-based pagination offset. Default: 0.
limit INTEGER Results per page. Default: 25. Max: 100.