Fuzzy Term - ParadeDB

Legacy Docs: This page describes our legacy API. It will be deprecated in a future version. Please use the v2 API where possible.

Highlighting is not supported for paradedb.fuzzy_term.

Basic Usage

fuzzy_term finds results that approximately match the query term, allowing for minor typos in the input.

value is treated as a raw token and is not processed further. Use match to process and fuzzy match a query string.

SELECT description, rating, category
FROM mock_items
WHERE id @@@ paradedb.fuzzy_term('description', 'shoez')
LIMIT 5;

SELECT description, rating, category
FROM mock_items
WHERE id @@@
'{
    "fuzzy_term": {
        "field": "description",
        "value": "shoez"
    }
}'::jsonb
LIMIT 5;

required

Specifies the field within the document to search for the term.

required

Defines the term you are searching for within the specified field, using fuzzy logic based on Levenshtein distance to find similar terms.

default:2

The maximum Levenshtein distance (i.e. single character edits) allowed to consider a term in the index as a match for the query term. Maximum value is 2.

default:true

When set to true, transpositions (swapping two adjacent characters) as a single edit in the Levenshtein distance calculation, while false considers it two separate edits (a deletion and an insertion).

default:false

When set to true, the initial substring (prefix) of the query term is exempted from the fuzzy edit distance calculation, while false includes the entire string in the calculation.

​Basic Usage

Basic Usage