Ranking Studio API Controls

API controls to apply newly created ranking algorithm

To use this, you must have access to the Ranking Studio feature.

Apply New Algorithm to rank results [Algorithm should be in Available state]

In the front-end API call, pass the parameter br_ranking.algo with the copied algorithm ID. br_ranking.algo=<algorithm-id> Replace <algorithm-id> with the algorithm ID from Ranking Studio. Follow the steps below to get it: - Go to AI Studio > Ranking studio > Site search ranking algorithm (or Category ranking algorithm). - Go to Actions under the Algorithms tab of Ranking Studio dashboard. Click the dropdown next to View button. Now, select the option to view the ranking algorithm ID. - Copy the algorithm ID.

Error handling when incorrect values are passed

If you send an algorithm ID that is invalid or is still in the training phase, the system uses the default algorithm as a fallback. Please note that this doesn’t throw any error, so ensure to send the correct value with the “br-” prefix.

AB testing the new algorithm experience

• When the algorithm training is complete, the algorithm status changes to Available. You can choose to AB test the experience on your external AB testing platform to validate if the algorithm delivers the desired lift and is ready to power all queries.
  
  
• Test the new ranking algorithm vs the default ranking algorithm by passing the above parameter in the Frontend API call. Here, br-cCzeJcvG is the ID of the new algorithm, and br-standard is the ID of the default ranking algorithm.

Test variant: Enable new algorithm to rank the results

https://core.dxpapi.com/api/v1/core/?
q=dress
&br_ranking.algo=br-cCzeJcvG
&account_id=6092
&domain_key=homeoasis_bloomreach
&url=www.bloomique.com
&ref_url=www.bloomique.com
&request_type=search
&rows=10
&start=0
&fl=pid%2Ctitle%2Cbrand%2Cprice%2Csale_price
&search_type=keyword

Control variant: Apply default ranking algorithm to rank the results

https://core.dxpapi.com/api/v1/core/?
q=dress
&br_ranking.algo=br-standard
&account_id=6092
&domain_key=homeoasis_bloomreach
&url=www.bloomique.com
&ref_url=www.bloomique.com
&request_type=search
&rows=10
&start=0
&fl=pid%2Ctitle%2Cbrand%2Cprice%2Csale_price
&search_type=keyword

Conflict resolution

1. If two or more algorithms overlap, which one applies? For instance, two algorithms are applied for all queries.
   If multiple algorithms are applied for all queries, then we choose the one that was most recently applied.
2. What happens when there are existing overrides on the API?
   The values passed in API will decide the ranking behavior.

• If you have disabled relevance attributes (br_ranking.relevance = off), the algorithm's performance and custom signals will be used, but the text relevance scoring will be ignored and set to zero.
• If you have disabled performance attributes (br_ranking.performance = off), then the text relevance portions of the algorithm will be used, but the performance and custom signals scores will be ignored and set to zero.
• If you have disabled both performance and ranking attributes (br_ranking = off), the ranking algorithm will not be used. Instead, it will be entirely based on your ranking rules.

3. Suppose a setting is passed at various levels on the API and Dashboard. How are these handled?
   Conflict resolution order works as follows:

1. API parameters passed directly on front-end API call
2. Query Override on the Dashboard
3. Site-level rules on Dashboard
4. Site group-level rules on the Dashboard
5. Account-level rules on the Dashboard