Term Suggest API

The Dovetail Seeker Term Suggest API will look for misspelled terms in the match text given and return search suggestions for correctly spelled terms which exist in the search index.

This API performs spell checking on the given text. It them searches the index for each suggested spelling correction to see which corrected spellings exist in the index and the frequency of their occurrence. Results are returned in descending frequency order.

The Frequency result is the number of documents in the index containing the search term.

Note: This is currently an expensive API. Please be sure
to do performance testing for your desired load.

Usage

This API allows your search clients to have behavior to many search engines where search terms can be suggested to the user when the search query contains misspelled words.

Input

URL:

/seeker/terms/suggest?match={text}&limit={number}

Format:

JSON

HTTP Method(s):

Parameters

Parameter Required Default Description
match Yes N/A
limit No 10 The number of results to return

Response:

[{
  Term: "out",
  Frequency: 229
}{
  Term: "put",
  Frequency: 212
}{
  Term: "cut",
  Frequency: 190
}]
Examples

Request:

GET /seeker/terms/suggest?match=cse&limit=10

Response:

[{
  Term: "case",
  Frequency: 267
  }{
  Term: "cue",
  Frequency: 192
  }{
  Term: "chase",
  Frequency: 168
}]