Did You Mean Suggestions Response Field

The didYouMeanSuggestions field will be populated if the query is eligible for did you mean suggestions, and the primary query contains terms which drop the response document count below a certain threshold, and there are likely alternatives to the limiting terms. Each suggestion contains the following three fields:

  • originalQuery - the query that would be replaced by applying the did you mean suggestion
  • suggestedQuery - the query that would replace the originalQuery if the suggestion was applied
  • newSearchCommand - a command that can be appended to the existing query string to apply the did you mean suggestion.

Example - A didYouMeanSuggestions element in XML format

<didYouMeanSuggestions>
  <suggestion
   originalQuery="franknestein"
   suggestedQuery="frankenstein"
   newSearchCommand="setTextQuery(frankenstein)"/>
</didYouMeanSuggestions>

Example - A didYouMeanSuggestions object in JSON format

"didYouMeanSuggestions":[
  {
    "originalQuery":"franknestein",
    "suggestedQuery":"frankenstein",
    "newSearchCommand":"setTextQuery(frankenstein)"
  }
]