Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket


Elasticsearch in Optimizely <<product-name>> uses several settings for tuning and improving search performance. Below are a list of search settings commonly used in an Elasticsearch implementation.

## Common settings

Setting NameDescriptionTypeDefaultPossible Values
Search_UrlSets the Elasticsearch search url. Reindexing is required for changes to this setting to take effect.App`http://localhost:9200`url
Search_LogQueriesLog all queries sent to the search engineAppFalseBoolean
ProductSearchProvider AppElasticsearch 
Search_PriceSortMaximumMaximum number of items that can be sorted by price.App100 
Search_MaximumFacetsSets the maximum number of search facets that can be displayed.App1000 
Search_FilterOnSearchTrue to do filtering on searches, not just category queries. FalseTrue/False
Search_EnablePriceFiltersIf true and the current pricing model supports it, the search will include price filters. TrueTrue/False
Search_EnableAttributeFilters  TrueTrue/False

## Partial Match

Setting NameDescriptionTypeDefaultPossible Values
Search_MinimumMatchCountMinimum number of words which all must matchApp2-10 - 10 (integer)
Search_MinimumMatchPercentPercentage of all words that must match (rounded down)App75-100 - 100 (integer)

## Search suggestions

Internal NameDescriptionTypeDefaultPossible Values
Search_Suggestions_EnabledIf true, spelling suggestions will be retrieved with search and displayed to the user if foundAppTrueTrue/False
Search_Suggestions_MaxErrorsEnforces the maximum number of errors that can be corrected when generating suggestions. If a decimal between 0 and 1 is used it will use the fraction as a percentage of words that can be corrected. Whole numbers greater than 1 can also be used to specify the exact number of words that can be corrected.App0.30 - 1 (decimal), 1 - 5 (integer)
Search_Suggestions_MaxEditsNumber of characters that can be changed on a word to generate a new suggestion.App21 , 2
Search_DidYouMean_ThresholdUsed as the confidence level when retrieving suggestions. A value of 1 means a better suggestion than the original phrase. This should be lower than or equal to the Search_AutoCorrect_Threshold.App10 - 5 (decimal)
Search_AutoCorrect_ThresholdUsed as the confidence level when retrieving suggestions. Value of 1 means a better suggestion than the original phrase. This should be higher than or equal to the Search_DidYouMean_ThresoldApp20 - 5 (decimal)

## Misspellings/Fuzzy search

Internal NameDescriptionTypeDefaultPossible Values
Search_FuzzySearch_MaxEditsNumber of errors a word can have and still match.App11, 2
Search_FuzzySearch_PrefixLengthNumber of characters at start words which must matchApp21 - 10 (integer)
Search_FuzzySearch_EnabledFuzzy search is enabled or notAppTrueTrue/False

## Stopwords

Internal NameDescriptionTypeDefaultPossible Values
Search_StopwordModeNone would pass none for the stopwords, default would pass english and custom would pass the list from SQL.AppCustomNone | Default | Custom

## Sponsored search

Internal NameDescriptionTypeDefaultPossible Values
Search_SponsoredSearch_EnabledIf true, spelling suggestions are retrieved with search and displayed to the user if found.AppTrueTrue/False
Search_SponsoredSearch_LimitThe maximum number of sponsored results to display in search results. Valid settings are 1 - 5.App31 - 5

## Product boost

Setting NameDescriptionTypeDefaultPossible Values
Search_EnableProductBoostEnable product level boosting.AppTrueTrue/False

## Autocomplete

Setting NameDescriptionTypeDefaultPossible Values
Search_Autocomplete_EnabledIf true users will see the autocomplete drop-down as they type in the search boxWebsiteTrueTrue/False
Search_Autocomplete_Category_LimitThe maximum number of category autocomplete results that display. A number between 1 and 10.Website10Between 1-10
Search_Autocomplete_Content_EnabledIf true, content autocomplete results will show up as the user starts typing in the search box.WebsiteTrueTrue/False
Search_Autocomplete_Content_LimitThe maximum number of content autocomplete results that display. A number between 1 and 10.Website10Between 1-10
Search_Autocomplete_Product_EnabledIf true, product autocomplete results will show up as the user starts typing in the search box.WebsiteTrueTrue/False
Search_Autocomplete_Product_LimitIf true, product autocomplete results will show up as the user starts typing in the search box.Website10Between 1-10

## Search History

<table class="TableStyle-Borders" style="width: 100%; margin-left: 0; margin-right: auto;" data-cellspacing="0"> <colgroup> <col style="width: 50%" /> <col style="width: 50%" /> </colgroup> <tbody> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Autocomplete</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Autocomplete</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, users will see the autocomplete drop-down as they type in the search box.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Category Limit</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of category autocomplete results that display. Maximum value: 10</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Product Limit</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of product autocomplete results that display. Maximum value: 10</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Show Categories</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, category autocomplete results will show up as the user starts typing in the search box.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Show Products</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, product autocomplete results will show up as the user starts typing in the search box.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Show Website Pages</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, CMS pages will show up as autocomplete results as the user is typing in the search box.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Website Pages Limit</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of CMS page autocomplete results that display. Maximum value: 10</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Fuzzy Search</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Fuzzy Search</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, fuzzy search is enabled on the site.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Max Edits</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of character edits that can be made to a search string to return a match. This can be either a character swapped for a different character or a character being added or removed.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Prefix Length</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The number of initial characters that must match and will not be fuzzified. A value below 2 will result in performance issues.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>General Settings</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Attribute Filters</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, attributes (attribute values grouped by attribute type) will be facted on the left nav of the product list to be used as filters. This does not control category or price faceting. Reindexing is required for changes to this setting to take effect.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Elasticsearch URL</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><p>The Elasticsearch search URL.</p> <div class="note"> <p>This setting has been removed and is now configured in the appSettings.config file of the project.</p> </div></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Log Product Search Queries</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If Yes, product search queries will be included in the Application Logs. This should only be used by developers and will result in a lot of data if enabled.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Maximum Facets</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of attribute values or category check boxes that will display for each section in the left nav of the product list.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Price Sort Maximum</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If less than this number of products are returned in search results, users will be able to sort by price. If more than this number are returned price sorting will not be presented in the product list sort drop-down.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Product Boosting</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, specific products can be boosted to display higher or lower in search results. If No, product boosting values are ignored.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Search History</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, users will see their previous searches when they click the search box and nothing is in it.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Search History Limit</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The number of previous searches that will display to the user when they click the search box and nothing is in it.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Show Attributes On Search</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If Yes, attribute facets will appear for search results, not just category pages.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Stopword Mode</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">Determines what list of common words to exclude from search queries. If Custom, the list from Search - Stopwords in the Admin Console is used. If default, the internal list of English Lucene stopwords is used. If None, no stop words will be used. Reindexing is required for changes to this setting to take effect.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Website Specific Attributes</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, website and category attribute faceting is enabled.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Partial Matching</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Minimum Match Count</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The minimum number of words that must match to return a result. Negative numbers indicate the number of optional words. Works in conjunction with Minimum Match Percent. Default is 2.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Minimum Match Percent</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The percentage of all words that must match to return a result (rounded down). Negative numbers indicate the percent of optional words that can be missing. This works in conjunction with Minimum Match Count. Deafult is 75.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Product Search Index</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Batch Size for Product Indexing</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The number of products to send to Elasticsearch in each request during indexing. Reindexing is required for changes to this setting to take effect.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Concurrent Requests for Product Indexing</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The number of concurrent requests to make to Elasticsearch during product indexing. Reindexing is required for changes to this setting to take effect.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Search Suggestions</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">AutoCorrect Threshold</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">Autocorrect is used to return corrected results for mistyped search queries automatically and this value is the threshold to determine what will be automatically fixed. The lower the number the more errors will be tolerated without autocorrect being used. This should be higher than or equal to the DidYouMean Threshold.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">DidYouMean Threshold</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">DidYouMean is used to suggest alternate terms for mistyped search queries and this value is the threshold at which a suggestion is made. With 1 meaning a better suggestion than the original phrase. This should be lower than or equal to the AutoCorrect Threshold</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Enable Search Suggestions</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, autocorrect and DidYouMean will be active on the site.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Max Edits</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of characters that can be changed on a word to be considered as a suggestion.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Max Errors</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">The maximum number of errors that can be corrected when generating suggestions. If a decimal between 0 and 1 this indicates a percentage of words that can be corrected. Whole numbers greater than or equal to 1 can be used to specify the exact number of words that can be corrected. Numbers higher than 2 may have a negative impact on performance.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" colspan="2" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Sponsored Search</strong></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1"><strong>Setting Name</strong></td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1"><strong>Description</strong></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyE-Regular-Row1">Sponsored Search</td> <td style="text-align: center;" class="TableStyle-Borders-BodyD-Regular-Row1">If On, specific products can be flagged as sponsored and boosted to the top of search results. Sponsored flag is set for individual products in the product boosting screen.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td style="text-align: center;" class="TableStyle-Borders-BodyB-Regular-Row1">Sponsored Search Limit</td> <td style="text-align: center;" class="TableStyle-Borders-BodyA-Regular-Row1">The maximum number of sponsored products matching the search query that will be displayed at the top of search results.</td> </tr> </tbody> </table>

## Hide