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

Download Open API Spec

KeyValues

org.sagebionetworks.repo.model.search.KeyValues

A multi-value IN-clause filter over a single column. A row matches when the column's value equals any entry in 'values' (or, with not=true, matches none of them). Values are compared exactly against the column's stored keyword tokens — for text columns this means matching the post-analysis form (typically lowercased). Runs in non-scoring context: a matching row is included unconditionally, without contributing to relevance. Useful for faceted navigation where the user has selected one or more bucket values.

Field Type Description
key STRING The column name to filter on. Must be a column present on the SearchIndex's schema.
values ARRAY<STRING> Values to match. Case-sensitive, compared against the stored keyword sub-field — for text columns analyzed with a lowercase filter, supply lowercased values here. Numeric and date columns accept their string representations (e.g. '42', '2026-05-09').
not BOOLEAN When true, inverts the filter semantics: rows matching any value are excluded (NOT IN). Default: false.