Synonym

A synonym is represented by a synonym object. A synonym object consists of its query and its attached synonyms. The synonyms can be either directed or bi-directional (synonym).

Attribute

Type

Required

Content

query

str

Required

The query which should have synonyms

directed_synonyms

str

Optional

Directed synonyms, are synonyms that will appear when you type the query, but the query will not appear as synonym for the directed synonyms.

synonyms

str

Optional

Bi directional synonoms, go both ways, meaning if you have query A with bi-directional synonym B, you will also get A as a synonym when searching for B

{
  "query": "pants",
  "synonyms": ["trousers","legwear"],
  "directed_synonyms": ["leggings"]
}