Synonym handling in Elasticsearch

Introduction

Synonym handling helps search engines find results even if words are different but mean the same thing.

When users search with different words but expect the same results.

To improve search accuracy by including related terms automatically.

When you want to group similar words like 'car' and 'automobile' together.

To handle spelling variations or abbreviations in search queries.

When you want to expand search results without changing the original data.

Syntax

Elasticsearch

PUT /my_index
{
  "settings": {
    "analysis": {
      "filter": {
        "my_synonym_filter": {
          "type": "synonym",
          "synonyms": [
            "car, automobile",
            "quick, fast"
          ]
        }
      },
      "analyzer": {
        "my_synonym_analyzer": {
          "tokenizer": "standard",
          "filter": ["lowercase", "my_synonym_filter"]
        }
      }
    }
  },
  "mappings": {
    "properties": {
      "content": {
        "type": "text",
        "analyzer": "my_synonym_analyzer"
      }
    }
  }
}

The synonym filter lists words that mean the same.

The analyzer uses this filter to treat synonyms as equal during search.

Examples

This example groups 'happy', 'joyful', and 'glad' as synonyms for searching in a books index.

Elasticsearch

PUT /books
{
  "settings": {
    "analysis": {
      "filter": {
        "synonym_filter": {
          "type": "synonym",
          "synonyms": ["happy, joyful, glad"]
        }
      },
      "analyzer": {
        "synonym_analyzer": {
          "tokenizer": "standard",
          "filter": ["lowercase", "synonym_filter"]
        }
      }
    }
  },
  "mappings": {
    "properties": {
      "description": {
        "type": "text",
        "analyzer": "synonym_analyzer"
      }
    }
  }
}

This example loads synonyms from a file called synonyms.txt for a products index.

Elasticsearch

PUT /products
{
  "settings": {
    "analysis": {
      "filter": {
        "synonym_filter": {
          "type": "synonym",
          "synonyms_path": "analysis/synonyms.txt"
        }
      },
      "analyzer": {
        "synonym_analyzer": {
          "tokenizer": "standard",
          "filter": ["lowercase", "synonym_filter"]
        }
      }
    }
  },
  "mappings": {
    "properties": {
      "name": {
        "type": "text",
        "analyzer": "synonym_analyzer"
      }
    }
  }
}

Sample Program

This program creates an index where 'car', 'automobile', and 'auto' are synonyms. It adds a document with 'automobile' and searches using 'car'. The search will find the document because of synonym handling.

Elasticsearch

PUT /vehicles
{
  "settings": {
    "analysis": {
      "filter": {
        "vehicle_synonyms": {
          "type": "synonym",
          "synonyms": [
            "car, automobile, auto",
            "bike, bicycle"
          ]
        }
      },
      "analyzer": {
        "vehicle_analyzer": {
          "tokenizer": "standard",
          "filter": ["lowercase", "vehicle_synonyms"]
        }
      }
    }
  },
  "mappings": {
    "properties": {
      "description": {
        "type": "text",
        "analyzer": "vehicle_analyzer"
      }
    }
  }
}

POST /vehicles/_doc/1
{
  "description": "I love my automobile"
}

GET /vehicles/_search
{
  "query": {
    "match": {
      "description": "car"
    }
  }
}

Important Notes

Synonyms improve search but can make indexing slower.

Keep synonym lists simple to avoid confusing results.

Synonym filters work best when applied at index time or search time, but not both.

Summary

Synonym handling helps find results with different words that mean the same.

Define synonyms in filters and use them in analyzers.

Use synonyms to improve search experience without changing data.

Practice

1. What is the main purpose of synonym handling in Elasticsearch?

easy

A. To find search results that include different words with the same meaning

B. To speed up the indexing process

C. To store data in multiple languages automatically

D. To encrypt search queries for security

Solution

1. Step 1: Understand synonym handling concept

   Synonym handling allows Elasticsearch to match words that mean the same, improving search results.

2. Step 2: Identify the main goal

   The goal is to find results with different words but same meaning, not speed or encryption.

3. Final Answer:

   To find search results that include different words with the same meaning -> Option A

4. Quick Check:

   Synonym handling = find similar meaning words [OK]

Hint: Synonyms help find words with same meaning [OK]

Common Mistakes:

• Thinking synonyms speed up indexing
• Confusing synonyms with encryption
• Assuming synonyms translate languages automatically

2. Which of the following is the correct way to define a synonym filter in Elasticsearch settings?

easy

A. "filter": { "synonym_filter": { "type": "keyword", "synonyms": ["quick,fast"] } }

B. "filter": { "synonym_filter": { "type": "stop", "synonyms": ["quick,fast"] } }

C. "filter": { "synonym_filter": { "type": "synonym", "synonyms": ["quick,fast"] } }

D. "filter": { "synonym_filter": { "type": "stemmer", "synonyms": ["quick,fast"] } }

Solution

1. Step 1: Identify correct filter type for synonyms

   The filter type for synonyms must be "synonym" to handle synonym lists.

2. Step 2: Check the filter definition syntax

   "filter": { "synonym_filter": { "type": "synonym", "synonyms": ["quick,fast"] } } correctly uses "type": "synonym" and defines synonyms as a list.

3. Final Answer:

   "filter": { "synonym_filter": { "type": "synonym", "synonyms": ["quick,fast"] } } -> Option C

4. Quick Check:

   Synonym filter type = "synonym" [OK]

Hint: Synonym filters use type "synonym" [OK]

Common Mistakes:

• Using wrong filter types like stop or stemmer
• Not defining synonyms as a list
• Misspelling "synonym" type

3. Given this analyzer configuration, what will be the tokens produced for the text "fast car"?

{
  "analysis": {
    "filter": {
      "synonym_filter": {
        "type": "synonym",
        "synonyms": ["fast,quick"]
      }
    },
    "analyzer": {
      "synonym_analyzer": {
        "tokenizer": "standard",
        "filter": ["lowercase", "synonym_filter"]
      }
    }
  }
}

medium

A. ["fast", "quick", "car", "car"]

B. ["fast", "quick", "car"]

C. ["quick", "car"]

D. ["fast", "car"]

Solution

1. Step 1: Analyze the text with the synonym filter

   The synonym filter maps "fast" to "quick", so both tokens appear for "fast".

2. Step 2: List all tokens after analysis

   Tokens are "fast", "quick" (synonym), and "car" (unchanged).

3. Final Answer:

   ["fast", "quick", "car"] -> Option B

4. Quick Check:

   Synonym adds "quick" token for "fast" [OK]

Hint: Synonym filter adds synonyms as extra tokens [OK]

Common Mistakes:

• Ignoring synonym addition and listing only original tokens
• Replacing original token instead of adding synonym
• Duplicating tokens unnecessarily

4. You defined a synonym filter but your search results do not include synonyms. What is the most likely mistake?

medium

A. You used the synonym filter in the index but not in the search analyzer

B. You forgot to add the synonym filter to the analyzer's filter list

C. You defined synonyms as a string instead of a list

D. You used the synonym filter with the wrong tokenizer

Solution

1. Step 1: Understand how synonym filters affect search

   Synonyms must be applied in the analyzer used during search to affect results.

2. Step 2: Identify common setup mistake

   Often synonyms are applied only at index time, missing search analyzer usage.

3. Final Answer:

   You used the synonym filter in the index but not in the search analyzer -> Option A

4. Quick Check:

   Synonyms must be in search analyzer too [OK]

Hint: Apply synonym filter in both index and search analyzers [OK]

Common Mistakes:

• Adding synonym filter only at index time
• Not including synonym filter in search analyzer
• Misconfiguring synonyms as string instead of list

5. You want to improve search for a product catalog where users may search for "tv", "television", or "smart tv". How should you configure synonyms to handle these terms effectively?

hard

A. Apply synonyms only at search time to avoid changing indexed data

B. Define synonyms only for "tv" and "television" but exclude "smart tv" because it has two words

C. Use a stop filter to remove "smart" and then define synonyms for "tv" and "television"

D. Define synonyms as: "tv, television, smart tv" in a synonym filter and apply it in both index and search analyzers

Solution

1. Step 1: Define all related terms as synonyms

   Include "tv", "television", and "smart tv" together to cover all user queries.

2. Step 2: Apply synonym filter in both index and search analyzers

   This ensures synonyms work during indexing and searching for best results.

3. Final Answer:

   Define synonyms as: "tv, television, smart tv" in a synonym filter and apply it in both index and search analyzers -> Option D

4. Quick Check:

   Synonyms cover all terms and apply at both stages [OK]

Hint: Include all terms and apply synonyms at index and search [OK]

Common Mistakes:

• Ignoring multi-word synonyms like "smart tv"
• Applying synonyms only at search time
• Using stop filter incorrectly to remove words