Synonyms map customer vocabulary to your catalog vocabulary. Searching
pastile frana and placute frana should both return brake pads even though
your titles only contain one of those words.
Synonyms are configured per index and applied automatically during search.
# Types
| Type | Behaviour | Example |
|---|---|---|
multi_way |
Every word in the set is interchangeable. | [phone, smartphone, mobile] |
one_way |
The "root" matches all the alternates, but not vice versa. | root iphone → alternates iphone 14, iphone 15, iphone pro |
# Endpoints
# List synonyms
GET /v1/indexes/{name}/synonyms
Returns every synonym group on the index, with enabled flags so you can
disable a group without deleting it.
# Create a synonym
POST /v1/indexes/{name}/synonyms
Body:
{
"type": "multi_way",
"synonyms": ["placute frana", "pastile frana"],
"enabled": true
}
# Update a synonym
PATCH /v1/indexes/{name}/synonyms/{id}
Patch any field — type, synonyms, enabled.
# Delete a synonym
DELETE /v1/indexes/{name}/synonyms/{id}
# How it works
When a query is parsed, Skryx expands each token through the synonym map
before scoring. A search for placute frana is internally rewritten to
(placute|pastile) frana and matched against your titles.