Releases: Smile-SA/elasticsuite
2.11.9.2
🏆 Main features
💎 Allowing to extend cross sell recommendations to all products in the cart
Up to now, the Elasticsuite cross-sell recommendation block only showed recommendations for the last product added to the cart.
It is now possible to show recommendations for all the products in the cart :
- either still prioritizing the last product added to the cart but, if there are slots left, filling the block with recommendations from the other products in the cart
- or out right reserving, statically or dynamically, slots for every products in the cart
🚀 Performances oriented features
Ability to enable/disable the error requests body logging
Last release introduced an error logging mechanism that would systematically log into Magento logging system the error message and the body of requests failing on your OpenSearch/Elasticsearch server when the Elasticsuite debug mode was disabled to help with issues in production environment.
That was probably an oversight not to add a configuration switch since some type of errors can be caused by "request is too big" causes, hence adding strain to the logging system by pushing several megabytes requests bodies.
A new setting "Enable logging of request that produce errors" is available in Stores > Configuration > Elasticsuite > Base Settings just above the legacy "Enable Debug Mode" :
The feature can now behaves as "light debug mode" for production environments as intended.
Thesaurus: ability to limit the amount of alternative queries effectively sent to the search engine
While the Thesaurus system "Max Allowed Rewrites" setting available in Elasticsuite > Search Relevance > Thesaurus Configuration > General Configuration limits the number of substitutions in the original visitor search query, there can be situations when you have a lot (and we mean a lot) of thesaurus rules with long lists of alternative terms or when the same word is present in multiple rules.
In those situations, the "Max Allowed Rewrites" will not be enough to prevent generating several tenths or even hundreds of alternative search queries leading to a huge single search request that will end up failing on the server by hitting the ceiling of the "maximum number of clauses" allowed by your cluster configuration and/or memory available.
The new setting "Max Alternative Search Queries" available in Elasticsuite > Search Relevance > Thesaurus Configuration > General Configuration allows you to put a cap on the total number of alternative, rewritten search queries to effectively take into account for a given original visitor search query (defaults to 0, no limitation).
Since there is no unified mechanism available in Elasticsearch or OpenSearch for us to detect the ideal value to put there from a technical stand point, it will be up to you to determine the value you deem "sufficient" functionally.
You can also use that setting preventively in periods of high traffic (holiday season, sale events) to limit the strain on your cluster if you know that your merchandisers have been "thesaurus happy".
📦 Features
- [Core] Error request body logging tied to new setting by @rbayet in #3424
- [Core] Adding i18n placeholders for nl_NL and de_DE (new setting) by @rbayet in #3425
- [Thesaurus] Ability to cut-off the amount of alternative queries by @rbayet in #3426
- 💎 [Explain] Display thesaurus alternative queries cut-off by @rbayet
- 💎 [Recommender] Allow to extend cross sell recommendations with configuration by @romainruaud
- 💎[Recommender] Re-organizing system.xml section with groups by @rbayet
- [Tracker] Prevent tracker to open sessions when registering events. by @romainruaud in #3414
🐛 Fixes
- 💎 [BehavioralData] Handle search.max_buckets set to -1 (ES 6.8) by @rbayet
- 💎 [Explain] Removing last trace of 'type' in optimizers index by @rbayet
- 💎 [Merchandiser] Prevent fatal error on Widgets/Hyva widgets config by @rbayet
- [VirtualCategories][PageBuilder] Ensure proper order for plugin appliance. Fix #3401 by @romainruaud in #3422
Full Changelog: 2.11.9.1...2.11.9.2
Contributors
Assets 2
2.10.23.2
🏆 Main new features
💎 Allowing to extend cross sell recommendations to all products in the cart
Up to now, the Elasticsuite cross-sell recommendation block only showed recommendations for the last product added to the cart.
It is now possible to show recommendations for all the products in the cart :
- either still prioritizing the last product added to the cart but, if there are slots left, filling the block with recommendations from the other products in the cart
- or out right reserving, statically or dynamically, slots for every products in the cart
🚀 Performances oriented features
Ability to enable/disable the error requests body logging
Last release introduced an error logging mechanism that would systematically log into Magento logging system the error message and the body of requests failing on your OpenSearch/Elasticsearch server when the Elasticsuite debug mode was disabled to help with issues in production environment.
That was probably an oversight not to add a configuration switch since some type of errors can be caused by "request is too big" causes, hence adding strain to the logging system by pushing several megabytes requests bodies.
A new setting "Enable logging of request that produce errors" is available in Stores > Configuration > Elasticsuite > Base Settings just above the legacy "Enable Debug Mode" :
The feature can now behaves as "light debug mode" for production environments as intended.
Thesaurus: ability to limit the amount of alternative queries effectively sent to the search engine
While the Thesaurus system "Max Allowed Rewrites" setting available in Elasticsuite > Search Relevance > Thesaurus Configuration > General Configuration limits the number of substitutions in the original visitor search query, there can be situations when you have a lot (and we mean a lot) of thesaurus rules with long lists of alternative terms or when the same word is present in multiple rules.
In those situations, the "Max Allowed Rewrites" will not be enough to prevent generating several tenths or even hundreds of alternative search queries leading to a huge single search request that will end up failing on the server by hitting the ceiling of the "maximum number of clauses" allowed by your cluster configuration and/or memory available.
The new setting "Max Alternative Search Queries" available in Elasticsuite > Search Relevance > Thesaurus Configuration > General Configuration allows you to put a cap on the total number of alternative, rewritten search queries to effectively take into account for a given original visitor search query (defaults to 0, no limitation).
Since there is no unified mechanism available in Elasticsearch or OpenSearch for us to detect the ideal value to put there from a technical stand point, it will be up to you to determine the value you deem "sufficient" functionally.
You can also use that setting preventively in periods of high traffic (holiday season, sale events) to limit the strain on your cluster if you know that your merchandisers have been "thesaurus happy".
📦 Features
- [Core] Error request body logging tied to new setting by @rbayet in #3424
- [Core] Adding i18n placeholders for nl_NL and de_DE (new setting) by @rbayet in #3425
- [Thesaurus] Ability to cut-off the amount of alternative queries by @rbayet in #3426
- 💎 [Explain] Display thesaurus alternative queries cut-off by @rbayet
- 💎 [Recommender] Allow to extend cross sell recommendations with configuration by @romainruaud
- 💎[Recommender] Re-organizing system.xml section with groups by @rbayet
- [Tracker] Prevent tracker to open sessions when registering events. by @romainruaud in #3414
🐛 Fixes
- 💎 [BehavioralData] Handle search.max_buckets set to -1 (ES 6.8) by @rbayet
- 💎 [Explain] Removing last trace of 'type' in optimizers index by @rbayet
- 💎 [Merchandiser] Prevent fatal error on Widgets/Hyva widgets config by @rbayet
Full Changelog: 2.10.23.1...2.10.23.2
Contributors
Assets 2
2.11.9.1
🏆 Main features
Ability to search in/refine the explained results
It is now possible to search inside the list of products displayed in the explain results screen, in a similar way that it is possible in the category preview screen.
Since that does not alter the score of the products found through this "mini-search", it is now easier to look at the score details of a given product in the explained context.
The default explain results screen when simulating a full text search for "gear" on a Luma :
When reducing the displayed products to those also matching "duffle" :
💎 Accentuated form of popular search terms can now be shown in the autocomplete
If your store is in a language featuring accents and diacritics, you might want to show popular search terms exactly as typed by your users instead of the "ASCII folded" version of those search terms as it is now.
For instance, in French, if "boîte à thé" (tea box) is a popular search, by default the Behavioral Autocomplete module would show it as "boite a the".
The new settings available in Stores > Configuration > Elasticsuite > Behavioral Autocomplete > Tweaks > Show raw search terms will allow you to make sure that "boîte a thé" could be shown as is when a user searches for "boite" in the autocomplete.
🐛 Fixes
- [Catalog] Feature #3333, add fallback to use system config value for Sort Direction by @vahonc in #3372
- [Catalog] Fix #3405, returning the translation of the variable for Dutch language by @vahonc in #3408
- [Core] Fixing alternative stemmers list (Italian, Spanish) by @rbayet in #3396
- [Core] Forced logging of error request body+message w/o debug mode by @rbayet in #3417
- [Core] Adding support for simple regexp queries by @rbayet in #3400
- [Core] No edge ngram decomposition in termVectors by @rbayet in #3406
- 💎 [Explain] Fix plugin conflict with smile/module-elasticsuite-targetrule
- [Indices] Fix #3403 DateTime constructor in IndexStatusProvider by @romainruaud in #3418
- [Optimizer] Fix display of boost value/weight grid column by @rbayet in #3413
- 💎 [Recommender] Fix facet recommender display on mobile
- [Tracker] Avoid deprecation warnings by @rbayet in #3398
- [Tracker] Remove CDATA tags in tracker JS. by @romainruaud in #3411
- [VirtualCategories] Improve sortOrder direction fallback in case of empty string by @frank-bokdam in #3399
- [VirtualCategories] Adding fallback when default sort by is unset by @romainruaud in #3419
Full Changelog: 2.11.9...2.11.9.1
Contributors
Assets 2
2.10.23.1
🏆 Main features
💎 Ability to search in/refine the explained results
It is now possible to search inside the list of products displayed in the explain results screen, in a similar way that it is possible in the category preview screen.
Since that does not alter the score of the products found through this "mini-search", it is now easier to look at the score details of a given product in the explained context.
The default explain results screen when simulating a full text search for "gear" on a Luma :
When reducing the displayed products to those also matching "duffle" :
💎 Accentuated form of popular search terms can now be shown in the autocomplete
If your store is in a language featuring accents and diacritics, you might want to show popular search terms exactly as typed by your users instead of the "ASCII folded" version of those search terms as it is now.
For instance, in French, if "boîte à thé" (tea box) is a popular search, by default the Behavioral Autocomplete module would show it as "boite a the".
The new settings available in Stores > Configuration > Elasticsuite > Behavioral Autocomplete > Tweaks > Show raw search terms will allow you to make sure that "boîte a thé" could be shown as is when a user searches for "boite" in the autocomplete.
🐛 Fixes
- [Catalog] Feature #3333, add fallback to use system config value for Sort Direction by @vahonc in #3372
- [Catalog] Fix #3405, returning the translation of the variable for Dutch language by @vahonc in #3408
- [Core] Adding support for simple regexp queries by @rbayet in #3400
- [Core] No edge ngram decomposition in termVectors by @rbayet in #3406
- [Core] Fixing alternative stemmers list (Italian, Spanish) by @rbayet in #3396
- [Core] Forced logging of error request body+message w/o debug mode by @rbayet in #3417
- 💎 [Explain] Fix plugin conflict with smile/module-elasticsuite-targetrule
- [Optimizer] Fix display of boost value/weight grid column by @rbayet in #3413
- 💎 [Recommender] Fix facet recommender display on mobile
- [Tracker] Avoid deprecation warnings by @rbayet in #3398
- [Tracker] Remove CDATA tags in tracker JS. by @romainruaud in #3411
- [VirtualCategories] Improve sortOrder direction fallback in case of empty string by @frank-bokdam in #3399
- [VirtualCategories] Adding fallback when default sort by is unset by @romainruaud in #3419
Full Changelog: 2.10.23...2.10.23.1
Contributors
Assets 2
2.11.9
🏆 Main features
Translation improved and added for German 🇩🇪 and Dutch 🇳🇱 !
As the Elasticsuite only consists of people of variable fluency in French and English, we have pretty much relied on the community for additional language translations.
A huge shout-out to @lewisvoncken who provided a huge contribution which not only improved and expanded the German translation but also added a brand new Dutch translation !
We'll try to get the ball rolling and address the gap between Elasticsuite Open Source and Elasticsuite Premium in that regard.
Changing your store language stemmer
Over the years, we've noticed some issues with the default language stemmers used in Elasticsuite where, sometimes, the stemmers would not recognize properly the plural form of a word (for instance irregular french plural or some legitimate italian plurals) or would provide the same stem for quite different words (collection and collectivité in french).
That led to the introduction of the stemmer_override analyzer step which allows a developer to add some stemming rules to address those issues.
But since another approach sometimes used by Elasticsuite end users was simply to test and switch to another available language stemmers, we've decided to make it possible from the Magento Admin.
In the Stores > Configuration, at the store view level, it will be now possible for you to select a different stemmer than the one Elasticsuite uses if ElasticSearch/OpenSearch provides several for your language, that is for: Dutch, English, Finish, French, Galician, German, Hungarian, Italian, Norwegian (Bokmal and Nynorsk), Portugueuse, Russian, Spanish and Swedish.
The configuration is available, at the store view level only, at Stores > Configuration > Elasticsuite > Analyzers settings > Language stemmer configuration (don't forget to perform a full re-index after changing the setting).
Slightly better UX on the indices grid
On a UAT or Staging environment where the Elasticsearch/OpenSearch cluster is shared by many Magento instances, it can be cumbersome to locate and inspect your live indices in the Elasticsuite > System > Indices grid if you have to scroll down 5 screens to reach them.
This release includes two small improvements
- the ability to filter indices by their name (and not only their alias)
- the ability to hide all the external indices
Detailed changelog
📦 Features
- [Core] Allow changing language stemmer when possible by @rbayet in #3361
- [Core] Added dutch (and german) translations with Crowdin (rebase) by @lewisvoncken in #3363
- [Indices] Allow filtering indices grid on indices names by @rbayet in #3381
- [Indices] Allow hiding external indices by @rbayet in #3383
💻 Technical
- [BehavioralData] ( 💎 Elasticsuite Premium) Collect data according to search.max_buckets by @rbayet
- [Catalog] Default sort direction system config settings 2.10 feature by @romainruaud in #3369
- [Catalog] Feature #3333, add system config settings for Default Sort Direction by @vahonc in #3367
- [CatalogOptimizer] Allow category limitation for third party containers by @rbayet in #3352
- [CatalogOptimizer] Category preview for third party containers by @rbayet in #3356
- [Core] Fixing some extra quotes in i18n files by @rbayet in #3365
- [Core] Elasticsuite client exposes cluster info/settings by @rbayet in #3377
- [Recommender] Allow optimizer category preview for recommender containers even when they are the only containers selected for an optimizer by @rbayet
- [Tracker] Prevent events with empty or null tracker visitor/session identifiers to be indexed by @rbayet in #3373
🐛 Fixes
- [Analytics][Tracker] Handle rare case where tracker indices are empty by @rbayet in #3374
- [Catalog] Fix #2948 fallback to the last known valid product positions by @vahonc in #3386
- [Catalog] Show the 'is_filterable_in_search' independently of 'is_searchable' in product attribute edit screen by @rbayet in #3354
- [Core] Fix #3334, adding support currency condition by @vahonc in #3362
- [Core] Fixes #3359 Query name set error if fuzziness and phonetic disabled by @rbayet in #3366
- [Indices] Status 'unknown' when stats fails + logging failures by @rbayet in #3382
- [Optimizers] Fallback to root category for category preview if not root category is selected for a virtual category by @rbayet in #3355
- [Recommender] ( 💎 Elasticsuite Premium) Fix optimizer preview recommender by @rbayet
- [Recommender] ( 💎 Elasticsuite Premium) Make optimizer filter compatible with native by @rbayet
- [Tracking] Add query id in GraphQL search response to make Autocomplete optimizers work properly by @PierreGauthier in #3380
Full Changelog: 2.11.8.3...2.11.9
2.10.23
🏆 Main features
Translation improved and added for German 🇩🇪 and Dutch 🇳🇱 !
As the Elasticsuite only consists of people of variable fluency in French and English, we have pretty much relied on the community for additional language translations.
A huge shout-out to @lewisvoncken who provided a huge contribution which not only improved and expanded the German translation but also added a brand new Dutch translation !
We'll try to get the ball rolling and address the gap between Elasticsuite Open Source and Elasticsuite Premium in that regard.
Changing your store language stemmer
Over the years, we've noticed some issues with the default language stemmers used in Elasticsuite where, sometimes, the stemmers would not recognize properly the plural form of a word (for instance irregular french plural or some legitimate italian plurals) or would provide the same stem for quite different words (collection and collectivité in french).
That led to the introduction of the stemmer_override analyzer step which allows a developer to add some stemming rules to address those issues.
But since another approach sometimes used by Elasticsuite end users was simply to test and switch to another available language stemmers, we've decided to make it possible from the Magento Admin.
In the Stores > Configuration, at the store view level, it will be now possible for you to select a different stemmer than the one Elasticsuite uses if ElasticSearch/OpenSearch provides several for your language, that is for: Dutch, English, Finish, French, Galician, German, Hungarian, Italian, Norwegian (Bokmal and Nynorsk), Portugueuse, Russian, Spanish and Swedish.
The configuration is available, at the store view level only, at Stores > Configuration > Elasticsuite > Analyzers settings > Language stemmer configuration (don't forget to perform a full re-index after changing the setting).
Slightly better UX on the indices grid
On a UAT or Staging environment where the Elasticsearch/OpenSearch cluster is shared by many Magento instances, it can be cumbersome to locate and inspect your live indices in the Elasticsuite > System > Indices grid if you have to scroll down 5 screens to reach them.
This release includes two small improvements
- the ability to filter indices by their name (and not only their alias)
- the ability to hide all the external indices
Detailed changelog
📦 Features
- [Core] Allow changing language stemmer when possible by @rbayet in #3361
- [Core] New translations for German and Dutch (de_DE.csv and nl_NL.csv) (2.10.x) by @lewisvoncken in #3364
- [Indices] Allow filtering indices grid on indices names by @rbayet in #3381
- [Indices] Allow hiding external indices by @rbayet in #3383
💻 Technical
- [BehavioralData] ( 💎 Elasticsuite Premium) Collect data according to search.max_buckets (2.10.x) by @rbayet
- [Catalog] Default sort direction system config settings 2.10 feature by @romainruaud in #3369
- [Catalog] Feature #3333, add system config settings for Default Sort Direction by @vahonc in #3367
- [Core] Fixing some extra quotes in i18n files by @rbayet in #3365
- [Core] Elasticsuite client exposes cluster info/settings (2.10.x) by @rbayet in #3378
- [Tracker] Ignore events with empty/null visitor/session identifiers (2.10.x) by @rbayet in #3375
🐛 Fixes
- [Analytics][Tracker] Handle rare case where tracker indices are empty (2.10.x) by @rbayet in #3376
- [Catalog] Fix #2948 fallback to the last known valid product positions by @vahonc in #3386
- [Core] Fix #3334, adding support currency condition in Advanced Search by @vahonc in #3362
- [Core] Fixes #3359 Query name set error if fuzziness and phonetic disabled by @rbayet in #3366
- [Indices] Status 'unknown' when stats fails + logging failures by @rbayet in #3382
- [Optimizers] Fallback to root category for category preview if not root category is selected for a virtual category by @rbayet in #3355
- [Tracking] Add query id in GraphQL search response to make Autocomplete optimizers work properly by @PierreGauthier in #3380
Full Changelog: 2.10.22.3...2.10.23
Contributors
Assets 2
2.11.8.3
💻 Technical
- [VirtualCategories] Option to force empty category if virtual category root disabled by @rbayet in #3286
A new setting, enabled by default, is available at Store Configuration > Elasticsuite > Catalog Search > Catalog Search Configuration > Force zero results for disabled categories.
When set to Yes, it will make sure that
- any disabled category used as a "virtual category root" by a virtual category will lead to that virtual category not displaying any products
- any disabled category used in a rule of the rules engine (whether in a virtual category or in an optimizer) will result in a clause not matching any products either
- if that disabled category rule is in "If ALL of these conditions are TRUE" condition, it will make that condition fail
- if that disabled category rule is in "If ANY of these conditions are TRUE" condition, it will be as this that category rule was not in the condition
While it was at some point planned to hardcode that new (in our eyes) correct behaviour, we introduced the setting Store Configuration > Elasticsuite > Catalog Search > Catalog Search Configuration > Force zero results for disabled categories so you can decide to go back how things were by switching the setting to No.
- [Core] Add Support for OpenSearch Settings in Setup ConfigOptions List by @macoaure in #3327
- [Stemmer] Add compas execption by @PierreGauthier in #3339
🐛 Fixes
- [Core] Prevent type error on php8 if attribut label is a phrase object by @PierreGauthier in #3338
- [Indices] Avoid warning when filtering on index alias by @rbayet in #3348
🔧 CI/CD
- [Tools] Speed chmods in CI workflows by @rbayet in #3344
- [Tools] CI: prevent composer cache cross-versions contamination by @rbayet in #3349
New Contributors
Full Changelog: 2.11.8.2...2.11.8.3
2.10.22.3
💻 Technical
- [VirtualCategories] Option to force empty category if virtual category root disabled by @rbayet in #3286
A new setting, enabled by default, is available at Store Configuration > Elasticsuite > Catalog Search > Catalog Search Configuration > Force zero results for disabled categories.
When set to Yes, it will make sure that
- any disabled category used as a "virtual category root" by a virtual category will lead to that virtual category not displaying any products
- any disabled category used in a rule of the rules engine (whether in a virtual category or in an optimizer) will result in a clause not matching any products either
- if that disabled category rule is in "If ALL of these conditions are TRUE" condition, it will make that condition fail
- if that disabled category rule is in "If ANY of these conditions are TRUE" condition, it will be as this that category rule was not in the condition
While it was at some point planned to hardcode that new (in our eyes) correct behaviour, we introduced the setting Store Configuration > Elasticsuite > Catalog Search > Catalog Search Configuration > Force zero results for disabled categories so you can decide to go back how things were by switching the setting to No.
- [Stemmer] Add compas execption by @PierreGauthier in #3339
🐛 Fixes
- [Core] Prevent type error on php8 if attribut label is a phrase object by @PierreGauthier in #3338
- [Indices] Avoid warning when filtering on index alias by @rbayet in #3348
🔧 CI/CD
- [Tools] Speed chmods in CI workflows by @rbayet in #3344
- [Tools] CI: prevent composer cache cross-versions contamination by @rbayet in #3349
Full Changelog: 2.10.22.2...2.10.22.3
Contributors
Assets 2
2.11.8.2
🐛 Fixes
- [Virtual Category] Fix php8.3 deprecation when root category don't have path by @PierreGauthier in #3336
Full Changelog: 2.11.8.1...2.11.8.2
Contributors
Assets 2
2.10.22.2
🐛 Fixes
- [Virtual Category] Fix php8.3 deprecation when root category don't have path by @PierreGauthier in #3336
Full Changelog: 2.10.22.1...2.10.22.2