Fuzzy query

Fuzzy query

Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

An edit distance is the number of one-character changes needed to turn one term into another. These changes can include:

  • Changing a character (box → fox)
  • Removing a character (black → lack)
  • Inserting a character (sic → sick)
  • Transposing two adjacent characters (act → cat)

To find similar terms, the fuzzy query creates a set of all possible variations, or expansions, of the search term within a specified edit distance. The query then returns exact matches for each expansion.

Example requests

Simple example

  1. resp = client.search(
  2.     query={
  3.         "fuzzy": {
  4.             "user.id": {
  5.                 "value": "ki"
  6.             }
  7.         }
  8.     },
  9. )
  10. print(resp)
  1. response = client.search(
  2.   body: {
  3.     query: {
  4.       fuzzy: {
  5.         'user.id' => {
  6.           value: 'ki'
  7.         }
  8.       }
  9.     }
  10.   }
  11. )
  12. puts response
  1. const response = await client.search({
  2.   query: {
  3.     fuzzy: {
  4.       "user.id": {
  5.         value: "ki",
  6.       },
  7.     },
  8.   },
  9. });
  10. console.log(response);
  1. GET /_search
  2. {
  3.   "query": {
  4.     "fuzzy": {
  5.       "user.id": {
  6.         "value": "ki"
  7.       }
  8.     }
  9.   }
  10. }

Example using advanced parameters

  1. resp = client.search(
  2.     query={
  3.         "fuzzy": {
  4.             "user.id": {
  5.                 "value": "ki",
  6.                 "fuzziness": "AUTO",
  7.                 "max_expansions": 50,
  8.                 "prefix_length": 0,
  9.                 "transpositions": True,
  10.                 "rewrite": "constant_score_blended"
  11.             }
  12.         }
  13.     },
  14. )
  15. print(resp)
  1. response = client.search(
  2.   body: {
  3.     query: {
  4.       fuzzy: {
  5.         'user.id' => {
  6.           value: 'ki',
  7.           fuzziness: 'AUTO',
  8.           max_expansions: 50,
  9.           prefix_length: 0,
  10.           transpositions: true,
  11.           rewrite: 'constant_score_blended'
  12.         }
  13.       }
  14.     }
  15.   }
  16. )
  17. puts response
  1. const response = await client.search({
  2.   query: {
  3.     fuzzy: {
  4.       "user.id": {
  5.         value: "ki",
  6.         fuzziness: "AUTO",
  7.         max_expansions: 50,
  8.         prefix_length: 0,
  9.         transpositions: true,
  10.         rewrite: "constant_score_blended",
  11.       },
  12.     },
  13.   },
  14. });
  15. console.log(response);
  1. GET /_search
  2. {
  3.   "query": {
  4.     "fuzzy": {
  5.       "user.id": {
  6.         "value": "ki",
  7.         "fuzziness": "AUTO",
  8.         "max_expansions": 50,
  9.         "prefix_length": 0,
  10.         "transpositions": true,
  11.         "rewrite": "constant_score_blended"
  12.       }
  13.     }
  14.   }
  15. }

Top-level parameters for fuzzy

<field>

(Required, object) Field you wish to search.

Parameters for <field>

value

(Required, string) Term you wish to find in the provided <field>.

fuzziness

(Optional, string) Maximum edit distance allowed for matching. See Fuzziness for valid values and more information.

max_expansions

(Optional, integer) Maximum number of variations created. Defaults to 50.

Avoid using a high value in the max_expansions parameter, especially if the prefix_length parameter value is 0. High values in the max_expansions parameter can cause poor performance due to the high number of variations examined.

prefix_length

(Optional, integer) Number of beginning characters left unchanged when creating expansions. Defaults to 0.

transpositions

(Optional, Boolean) Indicates whether edits include transpositions of two adjacent characters (ab → ba). Defaults to true.

rewrite

(Optional, string) Method used to rewrite the query. For valid values and more information, see the rewrite parameter.

Notes

Fuzzy queries will not be executed if search.allow_expensive_queries is set to false.