×

Working with Synonyms¶

Synonym is one of the main data entity types in Apptus eSales Enterprise. Synonyms are used to extend searches of a phrase to include similar search phrases. Typical use cases include managing common misspellings, dialects, and slang words.

Synonym basics¶

A synonym includes a locale, one search phrase, and one synonym phrase that will be used together with the search phrase. Synonyms can be set for individual locales or to be used world-wide, e.g. on all locales, and are primarily managed in the Synonyms tab in the Experience app.

A retailer must use eSales search functions to be able to use synonyms with their search phrases. To use synonym evaluation and auto generated synonyms, notifications for adding-to-cart and payment, such as the Adding to cart notification and the Secure payment notification, must be implemented.

Searching with synonyms¶

A search phrase goes through several stages of evaluation, where synonyms are applied early and is the third stage after tokenisation and stemming. The synonyms are matched with both the loose and the strict version of the search word. If matching with a synonym with a loose hit, only the loose synonym will be used. Multi word synonyms are stemmed by each word but will be matched as one phrase.

For example, the search phrase Womens dress is tokenised and normalised as two words, womens and dress. Stemming will return womens as a strict match and women as a loose match for the first word, and dress as a strict match for the second word. These words will then be matched with the synonyms available in eSales.

In this example, the synonyms found are female (loose match) and femal (loose match) based on womens and women, and skirt for dress (loose match). All combinations of strict, loose, and synonyms of the original phrase are then matched with product search attributes in the next stage of the search phrase evaluation.

Did-you-mean is commonly used with the eSales search functions, but it does not take synonyms in consideration.

Managing synonyms¶

Management of synonyms are primarily performed in the Synonyms tab in the Experience app. The Synonyms tab allows for adding, editing, and removing synonyms for individual locales and also for worldwide synonyms (synonyms used with all locales), as well as approving or rejecting auto generated synonyms and disable or activate. Synonyms can be filtered based on their creation type, active or disabled status, and evaluated impact.

Adding synonyms¶

Apptus eSales Enterprise allows for the addition of synonyms in several different ways, including automatically generated synonyms.

Upload Excel-files¶

Excel-files with synonyms can be uploaded in the Synonyms tab in the Experience app. For more information, see Working with Imports.

Import the Synonym data entity type¶

The synonym data entity type can be imported via the Web API v2. For more information, see Working with Imports.

Create individual synonyms¶

Individual synonyms can be created directly in the Synonyms tab in the Experience app by clicking the prominent plus icon in the top left hand corner. This will bring up a dialogue where the user can enter locale, search phrase, and synonym.

Create from Search phrase report¶

A synonym can be created directly from a search phrase in the Search phrase report in the Experience app. When clicking the plus icon on the right hand side of the search phrase row, a dialogue will appear where the user can enter locale, search phrase, and synonym. The search phrase is automatically filled in with the selected phrase.

Auto generated synonyms¶

Synonyms are automatically generated by eSales based on behavioural data, previous searches, and product attributes. Each synonym is evaluated before it is suggested as a synonym candidate. Before any suggested auto generated synonyms can be used they must be approved by a user in the Synonyms tab in the Experience app. Each auto generated synonym is denoted by a robot icon next to the synonym, and all auto generated synonyms are active once approved.

A retailer must have notifications for adding-to-cart and payment implemented to use auto generated synonyms.

Synonym status¶

The status of a synonym is either active or inactive, and a synonym must be active to be used in the search phrase evaluation. Setting synonyms as inactive is useful for occasions such as when seasonally used synonyms are out of season, or when the synonym evaluation has deemed a synonym to have a negative impact. Instead of removing them and re-adding them, they can temporarily be set as inactive instead. Changing the status of a synonym can be done per phrase, or in bulk when importing the synonym data type.

Synonym evaluation¶

Synonyms are automatically evaluated by eSales on their impact in relation to purchases. Impact is either positive, negative, uncertain, or untested. An uncertain impact means that the synonym can not be considered to have an explicit positive or negative impact. Clicking a synonym will show a more detailed chart of the impact. A synonym must be present in 20 search queries that relate to purchases via an add-to-cart action before its impact is tested.

A retailer must have notifications for adding-to-cart and payment implemented to use synonym evaluation.

Panels supporting synonyms¶

The following predefined search panels utilise synonyms when evaluating search phrases.

• Autocomplete panel
• Search hits panel
• Search hits with count zone
• Search zone