Dashboard Controls

This guide illustrates how you can configure algorithms using the Dashboard Controls feature.

📘

This is an Early Preview launch of the Dashboard Controls feature. The feature isn't Generally Available.

💡Prerequisites


Knowledge
We recommend that you review the following guide to understand the algorithms discussed in this guide:

Permissions
Make sure that you have the AlgoControl User permission. Your IAM admin can assign this role to any user who wants to create or edit an algorithm setting.

What are Dashboard Controls


Dashboard Controls are one of the routes you can use to configure the Algorithm Controls feature. This functionality empowers you to preview, edit and save the algorithm settings directly from the Discovery dashboard.

How to configure algorithm settings with Dashboard Controls


Navigation: Go to Algorithm Customizations > Recall Algorithms section in the Bloomreach dashboard.

19991999

On the Recall Algorithms homepage, you’ll see the following tabs:

  1. Global Rules: Use this section to turn on/off, edit or preview Global Algorithm Controls settings for your site. For example, you can use the Global Rules section to turn on precision mode for your entire site.
  2. Query Overrides: Use this section to change algorithm controls at a per query level. Here you can view, add, edit or delete Query Overrides rules for specific queries. For example, you can use the Query Overrides section to remove precision mode for specific queries where maybe the default algorithm provided a better experience.
    Note: When you enter the Recall Algorithms homepage at the account level, you can only apply settings on the account or language-specific catalog level based on your account setup. If you enter at the site level, you can only apply settings at the site level.

Global Rules


19991999

Under the Global Rules tab, you can view the current settings enabled for all your language-specific catalogs and different sites in the account. Under the Global Rules tab, there are three columns:

  • Influence: This section specifies the site scope of algorithm settings. At the account level, you can see the algorithm settings of all sites. However, if a user has access to only one site in the account, then they can only update the settings of that site only. Rules with a different site influence are indicated with a Read-only tag.
  • Settings: This section lists the current algorithm settings for the site.
  • Last edited by: This section specifies the date and time the configurations were last edited. It also mentions the editor.

Recall Algorithms Configurations


To view and edit the Global algorithm rules, hover on the Settings column. This reveals an edit icon. Click this edit icon.

34523452

This opens up a configuration screen with 2 elements:

  1. Algorithm controls panel: This section provides dropdown controls to choose the settings of the following Algorithms:
  • Search Recall Precision
  • Query Relaxation
  • Facet Precision
  • Spell Correct
19991999
  1. External AB Test URL panel:

This section provides the URL that you can use for AB testing the search results. If you would like to test the configurations for a particular query, you must replace "QUERY_PLACEHOLDER" text with that query.

19991999

Notes:

  • In the case of multi-site accounts, you’ll see an Influence section at the top that mentions the site scope of algorithm settings.
14281428
  • There are some algorithm settings that are only available to English sites and not applicable to non-English sites. If an algorithm is not supported for a particular language, it will not show up in the dropdown options.
    For example, Homeoasis.com has both English and French catalogs. The values for its English catalog (Homeoasis_EN) and French catalog (Homeoasis_FR) for Search Recall Precision will differ since we don't support "Product Type Precision" for French language catalogs.
11031103

Previewing Algorithm Controls settings


  • Select the desired algorithm setting using the dropdown controls provided.
28742874
  • To test if the newly selected Algorithm settings are suitable for your use case, click the Preview button and explore the results with the new Algorithm settings.
19991999
  • Enter the query in the search box and hit enter/return to see the results after the new algorithm configurations.
19991999
  • For further exploration, go to the Side-by-Side Preview tab. Click the Show Changes checkbox to view the excluded products (noise) and compare the results with the current state. This can help you determine if the new algorithm settings are suitable for your use case or not.
600600

Editing existing Algorithm Controls settings


  • Select the desired algorithm setting using the dropdown controls provided.
28742874
  • If the newly selected algorithm settings work well for your use case and you are satisfied with the results, then click the “Save” button to save the new algorithm settings.

Query Overrides


There can be use cases when you want certain queries to fall back to a different algorithm than the default Global algorithm. For instance, at the Global level, you have Category precision mode, but you want the query “tops” to use the Text Match precision mode.

Query override rules can be used for accomplishing such use cases. Query overrides take precedence over Global algorithm rules.

19991999

These rules are listed under the Query Overrides tab. This section shows 4 columns:

  • Queries: This section specifies the query corresponding to the query override rule.
  • Influence: This section specifies the site scope of query override settings. At the account level, you can see the query override settings of all sites.
  • Settings: This section lists the corresponding algorithm settings for the query override rule.
  • Last edited by: This section specifies the date and time the rules were last edited. It also mentions the editor.

Configuring Query Qverrides


This section illustrates the process of previewing, adding, editing, and deleting query override rules.** **

Preview Query overrides for one or more search queries


  • Click on the “Add” button to open the “Configure query overrides” section.
19991999
  • Specify the query for which overrides need to be previewed by passing the search query in the “Queries” textbox.
14191419
  • Select the site influence of the override rule from the dropdown menu. If you have multiple catalogs, you need to specify the catalog that is being targeted by the current rule you’re creating. The demo here has two catalogs - Homeoasis EN (English)and Homeoasis_fr (French). The user has to decide whether the rule settings for query "chair" should be applied to Homeoasis EN or Homoasis_fr site.
14301430
  • Select the appropriate algorithm setting from the dropdown.
19991999
  • Click the “Preview” button to view the product search results for this query override rule.
19991999

Add Query overrides for one or more search queries


  • Click on the “Add” button to open the “Configure query overrides” section.
  • Specify the queries for which overrides need to be added by passing the search query in the “Queries” textbox. To specify multiple queries, hit enter/return after typing each query.
14241424
  • Select the appropriate algorithm control setting from the dropdown.
19991999
  • Click the “Save” button.

Edit Query override for one or more search queries


  • Hover on the “Settings” column to reveal the edit icon.
19991999
  • Select the appropriate algorithm control setting from the dropdown.
19991999
  • Click the “Save” button.

Delete an existing Query override rule


  • Hover on the “Settings” column to reveal the delete icon.
19991999
  • Click the “Delete” button in the Delete Confirmation pop-up window.

Dashboard Controls FAQs


  1. How is conflict resolution managed i.e. when a setting is passed through API vs Global rule vs Query Override vs any live AB test?
    Priority order works as follows:
    a. Query Override on Dashboard
    b. API parameters passed directly on front-end API call
    c. CMS setting for any live AB test
    d. Global Rules on Dashboard

    Example: Let’s say a customer has Global rules set up on the dashboard for Search Recall Precision as Text Match.
    Case 1: If the customer is running a live AB test for 50-50 traffic for text match and category precision. In this case, since CMS setting has higher priority than Global rules, CMS setting triumphs global rules, and 50% traffic will have text match precision, whereas the other 50% will have category precision.

    Case 2: On top of case 1, if the customer is also controlling the feature for a few search queries on their end by passing search recall precision as Product Type precision. In this case, for the queries that are controlled by the customer on their end, product type precision will be applied. For all other queries, CMS settings(live A/B test) will be respected.

    Case 3: On top of case 1 and case 2, if the customer has a query override set up of Search recall precision as “Product Type” for a few queries. In this case, since query overrides have higher priority, the search queries that have overrides set up will have category precision. For the queries that are controlled by the customer on their end, product-type precision will be applied. For all other queries, CMS settings(live A/B test) will be respected.

  2. Do all 4 settings need to be updated together on the dashboard?
    No, if you wish to update/preview one setting at a time, you can achieve this by selecting the relevant dropdown value of the setting and leaving all other settings as is.


What´s next?

Learn to configure algorithm settings using