Search synonyms

Get all synonyms that match a query.

This page documents an earlier version of the API client. For the latest version, see Search for synonyms.

Required ACL: settings

Examples

C#

// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page

var result = index.SearchSynonyms(
  new SynonymQuery ("street")
  {
    Type = "synonym, oneWaySynonym"
    Page = 1,
    HitsPerPage = 10
  }
);

Parameters

query · string · required

The search query to find synonyms. Use an empty query to browse all the synonyms of an index.

hitsPerPage · string · default: 20

The number of synonyms to return for each call.

page · integer · default: 0

The page to fetch when browsing through several pages of results. This value is zero-based.

type · string | string[]

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:

• synonym
• oneWaySynonym
• altCorrection1 or altCorrection2
• placeholder

Response

hits · list

A list of matching synonyms. Each hit contains the synonym object and a _highlightResult attribute with the highlighted synonym.

Show child attributes

corrections · string[]

List of corrections. (For synonym types altCorrection1 or altCorrection2).

input · string

A word used as the basis for synonyms. (For synonym type oneWaySynonym).

objectID · string

Object ID of the matched synonym.

placeholder · string

A word used as the basis for replacements. (For synonym type placeholder).

replacements · string[]

List of replacements for the placeholder. (For synonym type placeholder).

synonyms · string[]

List of synonyms. (For synonym types synonym or oneWaySynonym).

type · string

Synonym type. One of:

• synonym
• oneWaySynonym
• altCorrection1
• altCorrection2
• placeholder

word · string

A word used as the basis for corrections. (For synonym types altCorrection1 or altCorrection2).

_highlightResult · object

Highlighted synonym object.

Show child attributes

fullyHighlighted · boolean

Whether the entire attribute value is highlighted.

matchedWords · string[]

List of query words that matched the object.

matchLevel · string

Indicates how well the attribute matched the search query. Can be:

• none (0)
• partial some)
• full (all)

The matching relates to the words in the query string not in the searched text of the records.

value · string

Markup text with occurrences highlighted. The tags used for highlighting are specified via highlightPreTag and highlightPostTag.

nbHits · integer

Number of hits.

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 the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "hits":[
    {
      "type":"synonym",
      "synonyms": [
        "car",
        "vehicle"
      ],
      "objectID":"1513249039298",
      "_highlightResult":{
        "type":{
          "value":"synonym",
          "matchLevel":"none",
          "matchedWords": []
        },
        "synonyms":[
          {
            "value":"<b>c<\/b>ar",
            "matchLevel":"full",
            "fullyHighlighted":false,
            "matchedWords": [
              "c"
            ]
          },
          {
            "value":"vehicle",
            "matchLevel":"none",
            "matchedWords": []
          }
        ]
      }
    }
  ],
  "nbHits":1
}