Operations Search - Using the Search Debugger

Setting Up The Debugger

Kodaris provides a tool to help determine why products are ranked the way they are when a user searches. When turned on and logged into the operations portal at the same time, you can see information like the score, fields matched, scoring method, etc.

Add the searchDebug role to your employee login

Open up a new tab and do a search on the customer side

Make sure the following parameters are added to the end of the search in the URL

Search Debugging

Once you are set up, make sure you stay logged into the Operations Portal while you search. The following tools should now be available to you.

Scoring

Under each product, you can see the actual relevancy score returned by the search engine. By default, the results are sorted by score. Using search rules, this can be changed, but when searching, it is best to sort by score so the user finds what they are looking for.

Inspect > Highlights

Highlights will show you the fields in the search document where the search engine found terms from the search phrase.

• Any part of the search phrase may match, not necessarily all terms depending on if minimum match is being used.
• The field names are the actual names of the fields in the search index. This is helpful to determine which fields you may want to set up in search rule fields. Inspect will show all matching fields no matter if the search rule is searching them or not for reference.
• The more fields matched that are being searched in search rules, the higher the score. By default, the search uses all fields. The search rules can be changed to only search specific fields and boost those fields higher (like code and name) which is recommended.

Inspect > Explain

The Explain tab has some complicated data on how each product was scored. Even though it is complex, some valuable information can be extracted from it.

• It can tell you which terms matched in which fields, which can be compared to the search rules you have set up.
• It includes the field boosting data which is set up in the search rule fields.
• By using this information, you may want to adjust which fields to boost and search in the search rule fields.

Search Rule Matched

Search Rule Fields and Boosts Matching the Scoring

Inspect > Debug

The Debug tab shows general information on the search along with boosting and filtering queries. This might be helpful to determine if your search rules are working the way you want them to.

Category Debugging

The same tool can be used on the category screens with the following limitations:

• Normally the score will be 1 on all products since there is no search
• The score may go up if category search rule configuration includes boosting queries
• The search term will usually be * for all
• There will be no highlighting