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

Download Open API Spec

SuggestionQuery

org.sagebionetworks.repo.model.search.query.SuggestionQuery

JSON schema for a suggestion query.

Field Type Description
searchTerm ARRAY<STRING> The free text search terms. The suggestion will be provided for these terms.
maxEdit INTEGER The maximum number of single-character edits (insertions, deletions, or substitutions) allowed between the input query and a suggested term. Must be 1 or 2. Default is 2.
size INTEGER The maximum number of suggestions to return for each term in the input text. The default is 5.
sort SuggestedTermSort Specifies how suggestions should be sorted in the response.