Manage synonyms in the dashboard

Learn how to manage synonyms in the Algolia dashboard

To add, delete, or edit synonyms in the Algolia dashboard, follow these steps:

1. Go to the Algolia dashboard and select your Algolia application.
2. On the left sidebar, select Search.
3. Select your Algolia index.
4. On the Configuration tab, click Synonyms.

Add synonyms

To add a new synonym, click Add Synonyms and choose the type:

• Regular synonyms
• One-way synonyms
• Alternative corrections
• Placeholders

Synonyms (regular synonyms)

In the Synonyms field, enter your regular synonyms: a comma-separated list of words or expressions that should be considered equivalent.

One-way synonyms

In the Search term field, enter your one-way synonym: the text used in a query that should be substituted by the comma-separated list of terms in the Alternatives field (“top” and “hoodie”/“sweater” in the example).

Placeholders

In the Placeholder field, enter your placeholder synonym: the text, enclosed in angle brackets, used by any query matching one of the Replacements (<street> for street and st, in the example).

Alternative corrections

In the Search term field, enter your alternative corrections synonym: the text used in the query that should be substituted by the comma-separated list of alternative words or expressions in the Corrections field (“tablet” for “ipad” in the example).

In the Typo field, choose the number of typos allowed (1 or 2) when the search term matches one of the corrections.

Copy synonyms to other indices

To copy a synonym you created to other indices, select the Copy this expansion to other indices option and choose your indices.

Import synonyms from a file

To import synonyms from a file, click the arrow next to Add Synonyms and then click Upload.

JSON and CSV are the two supported data formats, but CSV is limited to regular synonyms.

Import synonyms from JSON icon=“braces”

The file must contain an array of newline-delimited JSON objects. Each object must include:

• A unique object ID value that identifies the synonym record. Object ID aren’t automatically generated if they’re missing.

• A type value, which must be one of these options:

  • synonym
  • oneWaySynonym
  • altCorrection1
  • altCorrection2
  • placeholder

• Other fields required by the selected type.

Import synonyms from CSV

You can only use CSV files to import regular synonyms (synonym). The file must contain one set of comma-separated synonyms per line.

Algolia accepts CSV files which must use commas as field separators.

Export synonyms to a file

To back up or take a snapshot of your synonyms, click the arrow next to Add Synonyms and click Export as JSON or Export as CSV. CSV export is limited to regular synonyms.

Delete one synonym

To delete a specific synonym, click Delete synonym.

Delete all synonyms

To remove all synonyms from an index, open the More Options menu and select Delete All.

You can’t undo this operation.

Check Delete all these expansions on other indices to propagate the deletion to all chosen indices.

Edit synonyms

Click Edit synonym.