This page documents an earlier version of the API client. For the latest version, see Search for synonyms.
settings
Examples
Parameters
The search query to find synonyms.
Use an empty query to browse all the synonyms of an index.
The page to fetch when browsing through several pages of results.
This value is zero-based.
Restrict the search to a specific type of synonym.
Use an empty string to search all types (default behavior).
Multiple types can be specified using a comma-separated list or an array. The allowed types are:
synonymoneWaySynonymaltCorrection1oraltCorrection2placeholder
Response
A list of matching synonyms.
Each hit contains
the synonym object and a
_highlightResult attribute with the highlighted synonym.Response as JSON
This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use thegetLogs method.
Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON