Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Overview

When low number of autocomplete results are returned for a given search term, Did You Mean function suggests alternate search terms to the user that closely match the original search and that will yield a higher number of results. The configurations which define the threshold number of search results that will trigger Did You Mean, the maximum number of Did You Mean matches that should return when Did You Mean / Auto Correct is enabled, etc. can be controlled via dashboard settings:

Please review the documentation here that covers more details about https://hawksearch.atlassian.net/wiki/spaces/HSKB/pages/327815/Auto-Complete#Auto-complete-Configuration-Page

Retrieving autocomplete with Did You Mean (DYM) results

Autocomplete request

{
    "ClientGuid": "client_guid",
    "Keyword": "jcket",
    "IsInPreview": true
}

Response

In the autocomplete results response structure, there are four main keys which include the information about DYM suggestions:

  • “DymProductsSearch” indicates the list of possible keywords with urls that closely match the original product search term.

  • “DymContentSearch” indicates the list of possible keywords with urls that closely match the original content search term.

  • “DYMProductHeading“ Did You Mean Products search label (Dashboard settings: Workbench >> Keyword Search >> Auto-complete >> Did You Mean? in Auto-complete >> Layout)

  • “DYMContentHeading“ Did You Mean Content search label (Dashboard settings: Workbench >> Keyword Search >> Auto-complete >> Did You Mean? in Auto-complete >> Layout)

{
    "TopFacets": {},
    ...
    "DymProductsSearch": [
        {
            "Value": "jackets",
            "Url": "https://preview-dev.hawksearch.net/client_name?keyword=jackets&prv=1",
            "RawValue": "jackets"
        },
        {
            "Value": "jacket",
            "Url": "https://preview-dev.hawksearch.net/client_name?keyword=jacket&prv=1",
            "RawValue": "jacket"
        }
    ],
    "DymContentSearch": [],
    "DYMProductHeading": "Top Products Did You Mean?",
    "DYMContentHeading": "Top Content Did You Mean?"
}

  • No labels