Analysis Dashboard (Analyze by Analyzer)
Overview The Analysis dashboard provides a dedicated Back-Office screen that allows you to test and troubleshoot Elasticsearch/OpenSearch analyzers directly from your Magento admin panel. This feature provides a convenient way to debug search engine relevance and see exactly how the engine processes text, saving you from having to connect directly to the server or run manual API requests.
By using this tool, you can see how different analyzers break down (tokenize) specific words, search queries, or product data.
How to Use
The interface is simple and requires you to fill out three main fields to simulate the text analysis:
- Index name: Select the specific Elasticsearch/OpenSearch index you want to run the analysis against (for example, your current catalog product index or category index).
- Analyzer name: Choose the specific analyzer you want to apply to your text. The dropdown provides access to all standard and custom Elasticsuite analyzers configured on your store, such as:
keywordphoneticreferenceshinglesortablestandardstandard_edge_ngramstandard_stopwhitespace
- text to analyze: Enter the exact search query, word, or phrase you want to test.
Why Use This Tool?
Understanding how text is analyzed is crucial for troubleshooting search relevance. If a product is not appearing for a specific search query (or if it is appearing when it shouldn’t), you can use this page to analyze both the search query and the product’s data using the relevant analyzers.
For instance, you can check how a product SKU is tokenized using the reference analyzer, or how multi-word queries are grouped using the shingle analyzer. This will show you the exact tokens generated by the search engine, helping you understand why a match did or did not occur so you can confidently adjust your settings.