search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso

Spelling

Spell check search request.

The language used in your spelling correction will match the language of your indexed documents.

There are 3 different spelling options:

Spelling Options Description
strict Returns a spelling correction value when there are no results matching the submitted query
always Returns a possible spelling correction even if there are query matched results
retry Automatically retries the search request with the spelling corrected value if there are no results, but there is a spelling correction. Note that retry can lead to a slight decline in performance as a result of running 2 queries.
q
required
The query used within your search.
engine_key
required
The Engine Key associated with your Engine. Found within your dashboard.
spelling
optional
Values can be strict, always, or try.
Example - Returns suggestions for the query "spprt" using the always parameter. The correct query, "support", returns in the spelling_suggestion object.
curl -XGET 'https://search-api.swiftype.com/api/v1/public/engines/search.json' \
  -H 'Content-Type: application/json' \
  -d '{
        "engine_key": "5jZG1gmmCTFYbSSDjpqq",
        "q":"spport",
        "spelling": "always"
      }'
  {
    "record_count": 0,
    "records": {
      "page": []
    },
    "info": {
      "page": {
        "query": "spport",
        "current_page": 1,
        "num_pages": 0,
        "per_page": 20,
        "total_result_count": 0,
        "facets": {},
        "spelling_suggestion": {
          "text": "support",
          "score": 0.036801625
        }
      }
    },
    "errors": {}
  }

Stuck? Looking for help? Contact support or check out the Site Search community forum!