Synonyms

Synonyms are words or phrases that convey the same meaning.

In the Sparque Center, synonyms help improve search accuracy, product discovery, and overall user experience in your online shop by linking related terms.

This section provides an overview of common use cases and examples, as well as step-by-step instructions for importing and exporting synonyms.

Types of Synonyms

The Sparque Center features two types of synonyms, two-way and one-way synonyms.

Two-Way Synonyms

Two-way synonyms link terms to each other through a bidirectional connection, meaning a search for any linked term will return results for all associated terms.

For example, searching for "bicycle" will also display results for "bike," and searching for "bike" will return results for "bicycle" if configured as two-way synonyms.

In the list of synonyms, two-way synonyms are connected by Arrow pointing left and right.

Common use cases for two-way synonyms include:

  1. Alternative spellings and variants

    Customers may use different spellings for the same product:

    • "T-shirt" ↔ "Shirt"
    • "Headphone" ↔ "Headset"

  2. Common misspellings

    Accounting for typos ensures that users still find what they are looking for:

    • "Laptop" ↔ "Lapotp"
    • "Sneakers" ↔ "Sneekers"

  3. Brand names vs. generic terms

    Users may search using either the brand name or a general category:

    • "Nike" ↔ "Running Shoes"
    • "Apple iPhone" ↔ "Smartphone"

  4. Regional language differences

    Different terms might be used in different regions:

    • "Trainers" (UK) ↔ "Sneakers" (US)
    • "Chips" (UK) ↔ "Fries" (US)

  5. Abbreviations and shortened forms

    Customers might use abbreviations while searching:

    • "TV" ↔ "Television"
    • "SSD" ↔ "Solid State Drive"

One-Way Synonyms

One-way synonyms link one term to another (or several others), with the relationship being strictly one-directional. This means that searching for a term will include results for its synonym(s), while searching for a synonym will not return results for the original term.

For example, a search for "smartphone" will also show results for "iPhone" if configured as synonym. However, searching for "iPhone" will not display results for "smartphone".

In the list of synonyms, one-way synonyms are connected by Arrow pointing right.

Common use cases for one-way synonyms include:

  1. Product search expansion

    A broader search term yields more specific results, but a specific search term does not broaden the search:

    • "Shoe" → "Sandal"

  2. Brand-specific searches

    A search for a brand should yield results for the general product category. However, a search for the category should not yield specific brand results:

    • "Nike" → "Running Shoes"

  3. Avoiding irrelevant results

    A search for one term should not yield irrelevant results for the other term in the pair:

    • "Tablet" → "Microsoft Surface Book"

Synonym Import and Export

In the Sparque Center, you can upload or download a list of synonyms via CSV import/export. Uploading a new list will replace the existing one.

When working with synonyms, consider the following:

  • Relevance: Avoid overly broad synonyms that might lead to irrelevant results. For example, mapping "laptop" to "computer" might return broader results than the user intended.
  • Performance: Large synonym lists can impact search performance; prioritize frequently searched terms.
  • Regular Updates: Periodically review and update synonyms based on user search behavior.
  • Testing: After changes, test searches to confirm the desired behavior.
By carefully configuring synonyms, you can enhance search accuracy and provide a better shopping experience for your customers.

CSV Formatting

The Sparque Center allows you to import and export synonym lists in CSV format. The table must have the following structure:
Figure 1. Synonym List CSV Formatting
Synonym List CSV Formatting

Example Code: 

"TWO_WAY","en_US",,"laptop","notebook","portable computer"
"ONE_WAY","de_DE","2-in-1 laptop","surface book"
Please note the following:
  • The file must use the CSV format with commas or semicolons as field separators. Intershop recommends using Google Spreadsheet to create the CSV file, as Excel may use different separators depending on regional settings.
  • Each line in the file should represent a single set of synonyms.
  • The file must not have a header row.
  • For TWO_WAY synonyms, no base term is specified and the column must remain empty.
  • Synonyms are case-insensitive. All inputs are displayed in lower case.
  • You can set a language with a region using either an underscore or a hyphen (e.g., en_US or en-US).
  • When exporting synonyms, the language and region are always specified with a hyphen (e.g., en_US).

Importing Synonyms

To import synonyms, follow these steps:

  1. Prepare a synonym list in CSV format.
    Be sure to format the data correctly, see CSV Formatting for details.
    Note:
    When importing synonyms, keep the following in mind:
    • The system uses "REPLACE" mode for the import, meaning all existing synonyms will be deleted and replaced with the new synonyms from the uploaded file.
    • The maximum supported file size is 50 MB.
    • All locales must be included in a single file.
  2. Go to the Synonyms module of the Sparque Center and click Import.
    The Import synonyms dialog opens.
  3. Browse for your CSV file (or drag and drop it) and click Import.
    The list of synonyms, along with their associated locales, is displayed.
  4. Test the search functionality by searching with different terms to verify that the synonym mappings work as expected.

Exporting Synonyms

The Sparque Center allows you to export the list of synonyms, for example to take a snapshot of your synonyms or to create a backup.

To export the current list of synonyms, follow these steps:

  1. Go to the Synonyms module of the Sparque Center.
  2. Click Export.
    The synonyms are downloaded as a CSV file. This process may take a few moments, depending on the size of the data.

Searching Synonyms

The search allows you to search for a synonym by (parts of) the term, the type of synonym, and the language. To do so, follow these steps:

  1. Navigate to the Synonyms module.
  2. Enter the search term, choose a language, and optionally filter for the synonym type (One-way, Two-way).
    The results will be displayed in the list of synonyms.

Creating Synonyms

To create a synonym, follow these steps:

  1. Navigate to the Synonyms module.
  2. Click Create.
    The Create new synonym dialog opens.
  3. Choose whether you want to create a one-way or two-way synonym.
    For details, see Types of Synonyms.
  4. Depending on the chosen synonym type, provide a search term and its related terms or synonyms.
    Note:
    For Related terms and Synonyms, multiple terms can be separated by pressing ENTER or entering a comma.
  5. Select the language for which the synonyms should apply.
  6. Click Create.
    The synonym appears as a new line in the list of synonyms.

Editing Synonyms

To update existing synonyms, for example to change individual terms, follow these steps:

  1. Navigate to the Synonyms module.
  2. Click the Edit icon (Edit icon) of the synonym in question.
    The Edit redirect to URL ... dialogue opens.
  3. Make your desired adjustments and click Save Changes.
    The changes to the synonym are saved, and the updated synonym is displayed in the list.

Deleting Synonyms

To delete an existing synonym, follow these steps:

  1. Navigate to the Synonyms module.
  2. Click the Delete icon (Delete icon) of the synonym in question.
    The Delete synonym dialogue opens.
  3. Click Delete.
    The synonym is deleted and removed from the list.