Did you mean Search
- Akanksha Shukla (Unlicensed)
Owned by Akanksha Shukla (Unlicensed)
Mar 29, 2021
4 min read
Loading data...
Overview
When low number of search 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 Did You Mean.
Retrieving search with DidYouMean (DYM) results
{ "ClientGuid" : "SITE_GUID",
"Keyword" : "treste",
"ClientData":{
"VisitorId" : "2F87556F-AA2F-438E-A52C-AFF4B7E10EB5",
"Custom" : {"some key" : "some value"},
"HttpTrueClientIp" : "some IP address",
"UserAgent" : "some agent",
"Source" : ""
}
}
Response
In the search results response structure, there are 3 main keys which include the information about the actual keyword search and its DYM suggestions:
“Keyword” is the original keyword search which gave a low number of results.
“DidYouMean” indicates the list of possible keywords that closely match the original search term: "DidYouMean": [
"trestles",
"tested"
]“AdjustedKeyword” indicates the autocorrected keyword for which the search was performed and returned results. In example below, the 2 ‘NofResults’ are for the search term “trestle”. "AdjustedKeyword": "trestle"
{
"Facets": [
{
"FacetId": 25842,
"Name": "Price slider",
"Field": "saleprice",
"FieldType": "range",
"FacetType": "slider",
"DisplayType": "default",
"MaxCount": 0,
"MinHitCount": 0,
"ParamName": "priceslider",
"SortBy": "ScoreAndAlphaAndAlpha",
"ExpandSelection": false,
"IsNumeric": false,
"IsCurrency": false,
"CurrencySymbol": "$",
"IsSearch": false,
"ScrollHeight": 0,
"ScrollThreshold": 0,
"TruncateThreshold": 0,
"SearchThreshold": 0,
"AlwaysVisible": true,
"Tooltip": "",
"IsCollapsible": false,
"IsCollapsedDefault": false,
"SortOrder": 3,
"IsVisible": true,
"NofVisible": 0,
"Height": 0,
"SwatchData": [],
"FacetRangeDisplayType": 1,
"PreloadChildren": false,
"ShowSliderInputs": true,
"Ranges": [],
"Values": [
{
"Count": 7,
"Selected": false,
"RangeStart": "62.9700012207031",
"RangeEnd": "110.970001220703",
"RangeMin": "62.9700012207031",
"RangeMax": "110.970001220703"
}
],
"HiddenValues": []
},
{
"FacetId": 83285,
"Name": "Search within these results",
"Field": "searchWithin",
"FieldType": "search",
"FacetType": "search",
"DisplayType": "default",
"MaxCount": 0,
"MinHitCount": 0,
"ParamName": "searchWithin",
"SortBy": "ScoreAndAlphaAndAlpha",
"ExpandSelection": false,
"IsNumeric": false,
"IsCurrency": false,
"CurrencySymbol": "",
"IsSearch": false,
"ScrollHeight": 0,
"ScrollThreshold": 0,
"TruncateThreshold": 0,
"SearchThreshold": 0,
"AlwaysVisible": true,
"Tooltip": "",
"IsCollapsible": true,
"IsCollapsedDefault": false,
"SortOrder": 4,
"IsVisible": true,
"NofVisible": 0,
"Height": 0,
"SwatchData": [],
"FacetRangeDisplayType": 0,
"PreloadChildren": false,
"ShowSliderInputs": false,
"Ranges": [],
"Values": [],
"HiddenValues": []
}
],
"VisitorTargets": [
{
"Id": 1348,
"Name": "Illinois"
}
],
"TrackingId": "4125865c-b371-4b19-ae46-209a7bbe3044",
"Success": true,
"Pagination": {
"NofResults": 2,
"CurrentPage": 1,
"MaxPerPage": 12,
"NofPages": 1,
"Items": [
{
"Label": "12 Items Per Page",
"PageSize": 12,
"Selected": true,
"Default": true
},
{
"Label": "24 Items Per Page",
"PageSize": 24,
"Selected": false,
"Default": false
},
{
"Label": "36 Items Per Page",
"PageSize": 36,
"Selected": false,
"Default": false
}
],
"IsShowFirstLink": true,
"IsShowLastLink": true,
"NumberOfPageLinks": 5
},
"Keyword": "treste",
"Results": [
{
"DocId": "Item_106425",
"Score": 879.78326,
"Document": {
"brand": [
"Marmot"
],
"image": [
"http://test.hawksearch.net/assets/1/14/DimThumbnail/Grass-trestle-marmot(1).jpg"
],
"url": [
"/details?itemid=Item_106425"
],
"itemname": [
"Trestle 30"
],
"rating": [
"+0000000000000005.0000"
],
"itemtypeid": [
"3"
],
"saleprice": [
"+0000000000000078.9700"
],
"createdate": [
"2020-05-30T10:34:53"
],
"type": [
"Item"
],
"ratingrange": [
"+0000000000000005.0000"
],
"content": [
"trestle 30 <div class="descwrpr"><div class="descsubwrpr"><h2>product description</h2><br><p>the trestles 30 is a reliable all-purpose bag for everything from weekend camping to days on the trail.<br><br>spirafil high loft insulation, wave construction and 3d hood keep you warm and comfortable, while a long list of features gives you everything you’d expect from 40 years of crafting sleeping bags.</p></div></div> sale summer sale summer sale camp & hike summer sale camp & hike sleeping bags summer sale camp & hike sleeping bags adult sleeping bags specials sat dec 15th kids camp & hike sleeping bags adult sleeping bags camp & hike sleeping bags marmot reg right reg left long right long left green "
],
"id": [
"Item_106425"
],
"price": [
"+0000000000000099.0000"
],
"department_nest": [
"1|Camp & Hike",
"2|Camp & Hike/Sleeping Bags",
"3|Camp & Hike/Sleeping Bags/Adult Sleeping bags",
"1|Specials",
"2|Specials/Sat Dec 15th",
"3|Specials/Sat Dec 15th/Kids",
"1|Summer Sale",
"2|Summer Sale/Camp & Hike",
"3|Summer Sale/Camp & Hike/Sleeping Bags"
],
"imagealttag": [
"106425"
],
"location": [
{
"lon": -117.15726,
"lat": 32.71533
}
],
"sku": [
"\r\n "
],
"subdepartmentpath": [
"1|Sale",
"1|Summer Sale",
"1|Specials",
"1|Camp & Hike"
]
},
"BestFragments": {
"itemname": "<b>Trestle</b> 30"
},
"IsPin": false,
"IsVisible": true
},
{
"DocId": "Item_74594",
"Score": 856.13165,
"Document": {
"brand": [
"Marmot"
],
"image": [
"http://test.hawksearch.net/assets/1/14/DimThumbnail/marmot-trestle-01.jpg"
],
"url": [
"/details?itemid=Item_74594"
],
"itemname": [
"Trestle 0"
],
"rating": [
"+0000000000000003.0000"
],
"itemtypeid": [
"3"
],
"saleprice": [
"+0000000000000110.9700"
],
"_hawkadd2cartboost": [
4.1764708
],
"createdate": [
"2020-12-17T08:25:15"
],
"type": [
"Item"
],
"_hawksalesboost": [
5.263158
],
"ratingrange": [
"+0000000000000003.0000"
],
"content": [
"trestle 0 <div class="descwrpr"><div class="descsubwrpr"><h2>product description</h2><br><p>the full-featured trestles 0 is a reliable, all-purpose synthetic bag that insulates even in sustained cold and damp conditions. updated style lines and fabric liner keep you comfortable on backpacking, trekking and mountaineering trips.</p></div></div> sale specials sat dec 15th kids summer sale summer sale packs summer sale camp & hike summer sale packs backpacking packs summer sale camp & hike sleeping bags summer sale camp & hike sleeping bags adult sleeping bags camp & hike sleeping bags adult sleeping bags marmot right yellow "
],
"id": [
"Item_74594"
],
"price": [
"+0000000000000139.0000"
],
"department_nest": [
"1|Camp & Hike",
"2|Camp & Hike/Sleeping Bags",
"3|Camp & Hike/Sleeping Bags/Adult Sleeping bags",
"1|Summer Sale",
"2|Summer Sale/Camp & Hike",
"3|Summer Sale/Camp & Hike/Sleeping Bags",
"2|Summer Sale/Packs",
"3|Summer Sale/Packs/Backpacking Packs",
"1|Specials",
"2|Specials/Sat Dec 15th",
"3|Specials/Sat Dec 15th/Kids"
],
"imagealttag": [
"Marmot Trestle 0"
],
"location": [
{
"lon": 139.6917,
"lat": 35.689506
}
],
"sku": [
"\r\n "
],
"subdepartmentpath": [
"1|Sale",
"1|Specials",
"1|Summer Sale",
"1|Camp & Hike"
]
},
"BestFragments": {
"itemname": "<b>Trestle</b> 0"
},
"IsPin": false,
"IsVisible": true
}
],
"Selections": {},
"Sorting": {
"Items": [
{
"Label": "Best Match",
"Value": "score",
"IsDefault": false,
"Selected": true
},
{
"Label": "Title (A-Z)",
"Value": "titleasc",
"IsDefault": false,
"Selected": false
}
]
},
"QueryUsedAllKeywords": true,
"DidYouMean": [
"trestles",
"tested"
],
"AdjustedKeyword": "trestle",
"Redirect": {},
"Merchandising": {
"Items": []
},
"FeaturedItems": {
"Items": []
},
"SearchDuration": 17
}