{"section":"tutorials","requestedLocale":"en","requestedSlug":"creating-synonyms","locale":"en","slug":"creating-synonyms","path":"docs/en/tutorials/intelligent-search/synonyms/creating-synonyms.md","branch":"main","content":"> ℹ️ We recommend using [Synonyms](/en/docs/tutorials/synonyms) instead of [Substitute Words](https://help.vtex.com/en/docs/tutorials/how-to-optimize-searches-with-substitute-words) to associate words with products, as synonyms allow you to manage terms per product in a more scalable way. Contact our [Support team](https://support.vtex.com/hc/pt-br/requests) for more information.\n\nThere are two ways to set up synonyms in VTEX Admin: [individually](#creating-synonyms-individually) or by [importing a spreadsheet in CSV format](#importing-csv-spreadsheet). If you need to register synonyms in bulk, we recommend using the spreadsheet. See the instructions for each configuration form in the following sections.\n\nThe configuration of synonyms works recursively. This means that when you add a second synonym to an existing one, it will also become a synonym for the first one.\n\n> ℹ️ Synonyms should not be used to resolve misspellings, plural and singular errors, or even pronouns, articles, and propositions in the search terms. On all these points, VTEX Intelligent Search is able to interpret, learn and solve them automatically through algorithms.\n\n## Creating synonyms individually\n\nFollow the step-by-step procedure to configure synonyms individually in the VTEX Admin:\n\n1. In the VTEX Admin, go to __Storefront__, or type __Storefront__ in the search bar at the top of the page.\n2. Under **Intelligent Search**, click **Synonyms**. \n3. Click on `Create Synonym`.\n4. Fill in the fields that correspond to the synonym:\n   - __Type:__ defines the type of synonym. Check [Types of synonyms](/en/docs/tutorials/synonyms#types-of-synonyms) for more information.\n   - __Terms:__ words or expressions to be defined as synonyms. You must press `Enter` after each term to insert another term.\n   - **Locales:** Languages to which the synonym will apply. The field is only available for stores using [Multilanguage settings](/en/docs/tutorials/vtex-intelligent-search-multilanguage-settings).\n   - __Status:__ defines whether the synonym will be active or inactive.\n5. To finish, click on `Save`.\n\nChanges can take up to two hours to take effect.\n\n> ℹ️  This feature is available on VTEX Intelligent Search Multilanguage. Read our article [VTEX Intelligent Search: Multilanguage settings](/en/docs/tutorials/vtex-intelligent-search-multilanguage-settings#synonyms) to learn more.\n\n### Synonym conflict detection\n\nWhen you complete the **Terms** field in the previous step, Intelligent Search verifies whether the terms you entered are already covered by another existing synonym rule in the store. This verification helps avoid duplicates and relevance conflicts, especially in stores with a large number of configured synonyms.\n\nIf a term is already covered by another synonym, a warning appears in the form indicating how many synonyms share the same terms. Click `View conflicting rules` to open the **Conflicting synonyms** page in another tab, which lists the overlapping rules with the following information:\n\n| Column | Description |\n|---|---|\n| Terms | Terms defined in the conflicting synonym. |\n| Created on | Creation date of the conflicting synonym. |\n| Status | Condition of the conflicting synonym, which can be Active or Inactive. |\n\nFrom this page, you can review each conflicting synonym individually and [edit it](https://help.vtex.com/en/docs/tutorials/synonyms-list#editing-a-synonym) or [delete it](https://help.vtex.com/en/docs/tutorials/synonyms-list#deleting-a-synonym) as needed.\n\nWhen you click `Save`, if there's a conflict, a confirmation window appears asking you to confirm the registration or edit even with the identified overlap.\n\n> ℹ️ Conflict detection doesn't prevent the synonym from being registered. It only alerts you about existing overlaps in the database, allowing you to decide whether to adjust the registered rules.\n\n## Importing CSV spreadsheet\n\nIn case there are many synonyms to be added, you can make a .csv file and import it in the Admin.\n\n> ⚠️ The CSV file used in the import must be up to 20 KB. Larger files will not be accepted by the system. To request the import of a larger file, please contact [Support](https://support.vtex.com/hc/en-us/requests).\n\nTo import the file, follow the steps below:\n\n1. Create a CSV file in the format described on [Synonyms spreadsheet template](#synonyms-spreadsheet-template).\n2. In the VTEX Admin, go to __Storefront__, or type __Storefront__ in the search bar at the top of the page.\n3. Under **Intelligent Search**, click **Synonyms**. \n4. Click on <i class=\"fas fa-download\"></i> `Import`.\n5. Drag the CSV file into the bounded area or click on `choose a file` to select the file on your device.\n6. Click on `Import`.\n\n### Synonyms spreadsheet template\n\nEach row in the spreadsheet is a synonym. Rows should follow the format that corresponds to the selected [synonym type](/en/docs/tutorials/synonyms#types-of-synonyms):\n\n - __Unidirectional:__ `{terms separated by comma};{equivalent term};{status}`\n\n   __Examples:__\n\n    - `smartphone;iphone;true`: When searching for `smartphone`, `iphone` results will be returned. However, when searching for `iphone`, `smartphone` results will not be returned.\n    - `tablet;ipad;true`: When searching for `tablet`, `ipad` results will be returned. However, when searching for `ipad`, `tablet` results will not be returned.\n\n - __Bidirectional:__ `{terms separated by comma};{status}`\n\n   __Examples:__\n\n    - `tv,television,television set;true`: When searching for any of these terms, the products containing any of them will be returned.\n    - `monitor,screen,display;true`: When searching for any of these terms, the products containing any of them will be returned.\n\nBelow are some value examples for completing the spreadsheet, including different synonym types and the import result in the VTEX Admin. Each row in the example represents a row in the spreadsheet.\n\nSpreadsheet example:\n\n```\nflower;blossom;true\nlittle,mini;small;true\ndog;animal;false\nbeauty,blush,powder;true\n```\n\nResult in the VTEX Admin:\n\n![sinonimos-en](https://cdn.statically.io/gh/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/intelligent-search/synonyms/creating-synonyms_1.png)\n\n#### Multilanguage stores\n\nStores using  [Multilanguage settings](/en/docs/tutorials/vtex-intelligent-search-multilanguage-settings) must follow the template below to import synonyms for specific locales.\n\n- __Unidirectional__: `{terms separated by comma};{equivalent term};{status};{locales separated by comma}`\n\n   __Example:__\n   - `smartphone;iPhone;true;en-GB`: When searching for smartphone in the English language store (`locale en-GB`), the website will return results for `iphone`. However, when searching for `iphone`, the website will not return results for `smartphone`.\n\n- __Bidirectional__: `{terms separated by comma};{status};{locales separated by comma}`\n\n    __Example:__\n    - `tv,smart tv;true;en-GB`: When searching for one of these terms in the store in English (`locale en-GB`), the search results will return any product that contains one of these terms.\n\n> ⚠️ If the imported .csv file does not have the `locale`, the synonym will be valid for all languages available in the store."}