Adding synonyms to the thesaurus - Bloomreach Experience - Open Source CMS

Adding synonyms to the thesaurus

Bloomreach continually monitors which terms your customers enter into search boxes and which products they click following the search. When traffic between a search term and a clicked product reaches a threshold, then Bloomreach Personalization automatically generates the appropriate synonym rule, adding it to the Bloomreach Generated Synonyms list on the Thesaurus page.

You can supplement Personalization's synonyms by adding some yourself.

 

How do I add synonyms?

You can add synonyms through individual rules or you can upload them in bulk. If you have just a few rules to add, then creating them individually through the Bloomreach Dashboard works well. But if you have more than 10, it's usually faster and easier to put them in a text file and upload them in bulk.

 

Add individual synonyms directly in the Dashboard

Do you want to create a one-way or a two-way synonym rule?

The thesaurus is in the Dashboard under the Configurations tool. Look for Configurations at the top of the Dashboard.

Configuration Thesaurus

 

One-way synonym rule

Start at Configurations > SETTINGS > Thesaurus

  1. Click the ADD NEW button to create a new synonym rule or hover your mouse over an existing rule and click the pen icon to edit it.
    The Add New Synonym box opens with the 1-way synonyms option selected by default.

  2. Enter a term in the User Entered Term text box on the left.
    This term is a term that your customers might enter, such as  hat .

  3. Enter one or more synonyms in the Synonym(s) text box on the right.
    This term identifies terms to match items that you want to display in search results, such as fascinator.

  4. Click the SAVE button to save the rule, close it, and enable it.

Two-way synonym rule

Start at Configurations > SETTINGS > Thesaurus 

  1. Click the ADD NEW button to create a new synonym rule or hover your mouse over an existing rule and click the pen icon to edit it.
    The Add New Synonym box opens.

  2. Select the 2-way Synonyms option for your mode.

  3. Enter a comma-separated list of terms in the Enter Interchangeable Terms text box.
    These terms are synonymous terms that your customers might enter, such as kid and children.

  4. Click the SAVE button to save the rule, close it, and enable it.

Note: in order to reduce latency impact, synonyms rules with only less than 4 words is supported for both one-way and two-way synonyms. As an example, "audio" → "over the ear headphones" will not work since it has 4 words. In such cases, we'd suggest dropping any common works like "the", "of", "in", "with" when adding a synonym. So you might add "audio" → "over ear headphones" (3 words) which would work.

 

Upload synonym rules in bulk

Start by creating a plain text (.txt) file. Enter your list of synonyms in this pattern:

customer term => your term, your other term

 For example:

jeans => denim, trouser-style, boyfriend, skinny, straight-leg, bootcut, wide-leg

swimsuit => swim suit, bathing suit, bikini, tankini, maillot

sneakers => athletic shoes, tennis shoes, Converse

Don't forget that the term on the left is the term that your customers might enter. Terms on the right are the terms that your organization calls the items that you want to be displayed in response to customer terms.

  1. Click the ADD NEW button.
    The Add New Synonym box opens.

  2. Click the Choose File button and select the synonym file.

  3. Click the UPLOAD FILE AND IMPORT button to finish.

 

What's the correct format for an imported synonym file?

The thesaurus accepts plain text (.txt) files. Use the following format to create a list of synonyms in the file:

customer term => your term, your other term

 For example:

 jeans => denim, trouser-style, boyfriend, skinny, straight-leg, bootcut, wide-leg

 swimsuit => swim suit, bathing suit, bikini, tankini, maillot

 sneakers => athletic shoes, tennis shoes, Converse

Don't forget that the term on the left is the term that your customers might enter. Terms on the right are the terms that your organization calls the items that you want to be displayed in response to customer terms.

 

How do I enable and disable synonyms?

Each synonym rule has an On/Off toggle switch in the Enable column. Click that switch to change the rule's status.

If you disable an automatically generated rule, then Bloomreach changes its toggle to Off and moves the rule to the Rejected Synonyms list. If you disable a manually created rule, then Bloomreach changes the toggle to Off and leaves the rule in the Synonyms list at the top of the page.

Bloomreach automatically enables a synonym rule as soon as you create and save it. To enable a disabled a synonym, click its On/Off toggle switch in the Enable column. Automatically generated rules move from the Rejected Synonyms list back to the Auto-Generated Synonyms list. Manually created rules stay in place in the Synonyms list.

Only synonym rules that Bloomreach automatically created can ever be in the Rejected Synonyms list. Manually created synonyms always stay in the Synonyms list.

 

Best practices

Prevent search performance issues

Only disable an automatically generated synonym rule if there's a clear issue directly tied to it. Disabling automatically generated synonyms reduces the types of products that match the terms, which can cause issues with search performance.

 

Upload synonym rules in bulk

If you have more than a few synonyms to add to the thesaurus, then use the import feature to upload a file of them in bulk. You can enter as many synonyms as you want with the Add Term A and Add Term B text boxes, but it's generally faster and more accurate to import synonyms in bulk.

 

Don't use quotes

Even if a synonym is a phrase, don't wrap it synonyms in quotes.

 dress
 copper pipe
 "copper pipe"

 

Capitalization is irrelevant

Bloomreach doesn't consider capitalization when triggering synonym rules. You don't need to create synonym rules for lowercase, capital, nor title capital versions of the same synonyms. For example, all of the following rules work exactly the same:

sofa => couch

Sofa => couch

soFa => COUCH

Just use one version of the rule.

 

Synchronising Synonyms

While synchronising synonyms for merchants with multi-view (with multiple view_IDs) accounts, following should be taken care of:

  • Always create the synonyms at the account level. 
  • Always view the sync status at the view_ID level. 
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?