Override index settings

Learn how you can override the index settings either from the Magento admin panel or programmatically.

The Magento extension writes various configuration settings to your Algolia indices. That’s why the extension may overwrite changes you make directly in the Algolia dashboard.

Settings managed by Magento

For each entity (data type) and store managed in Magento there is typically at least one associated index.

Magento manages these configurations for the following entities:

Products

• searchableAttributes
• customRanking
• unretrievableAttributes
• attributesForFaceting
• renderingContent
• maxValuesPerFacet
• removeWordsIfNoResults

Categories

• searchableAttributes
• customRanking
• unretrievableAttributes

Pages

• searchableAttributes: unordered(slug), unordered(name), unordered(content)
• attributesToSnippet: content:7

Query Suggestions

• searchableAttributes: unordered(query)
• customRanking: desc(popularity), desc(number_of_results)
• typoTolerance: false
• attributesToRetrieve: query
• removeWordsIfNoResults: lastWords

Additional sections

• searchableAttributes: unordered(value)

Any settings not in this list can be managed independently.

Settings in the Algolia dashboard

You can configure settings that aren’t managed by Magento in the Algolia dashboard.

Example

The index setting typoTolerance is set to true by default on any new index unless you explicitly set it to false. Since the Magento extension doesn’t manage this setting for product indices, it’s initially set to true.

However, the value of typoTolerance for product indices can be configured from the Algolia dashboard. Subsequent indexing operations from the Magento extension shouldn’t alter this value unless you explicitly configure Magento to do so.

Customize Magento index settings

You can customize how Magento writes index settings to Algolia:

1. Advanced Algolia indices settings
2. Backend events

Advanced Algolia indices settings

To have Magento enforce an index setting value other than the default, specify that value in the Magento admin panel under: Stores > Configuration > Algolia Search > Advanced Algolia indices settings

This configuration page features a section for each entity that Magento manages. Specify your desired configuration using JSON syntax.

Example

To specify an alternate value for the typoTolerance setting, add the following JSON configuration under “Products’ indices settings”:

JSON

{ "typoTolerance": false }

Backend events

For more programmatic control over how the Magento extension writes settings to the Algolia indices, create an observer class to handle one or more entity-specific index setting events.