SearchFunction uses FunctionCallTrait
ArangoSearch-specific AQL functions: context (analyzer/boost), filtering, scoring and search highlighting. These functions are meant to be used inside a `SEARCH` operation against a View (or a `FILTER` backed by an inverted index).
Functions that also exist outside of SEARCH keep their original enum:
MIN_MATCH and IN_RANGE live in MiscFunction, STARTS_WITH,
TOKENS and LIKE in StringFunction.
Tags
Table of Contents
Constants
- ANALYZER : string = 'ANALYZER'
- Set the Analyzer for the wrapped search expression (and its nested functions).
- BM25 : string = 'BM25'
- Score documents with the Best Matching 25 algorithm (Okapi BM25).
- BOOST : string = 'BOOST'
- Override the boost value of the wrapped search expression for scorer functions.
- EXISTS : string = 'EXISTS'
- Match documents where an attribute is present (optionally of a given type, indexed by a given Analyzer, or indexed as a nested field).
- LEVENSHTEIN_MATCH : string = 'LEVENSHTEIN_MATCH'
- Match documents within a (Damerau-)Levenshtein distance of a target string.
- MINHASH_MATCH : string = 'MINHASH_MATCH'
- Match documents with an approximate Jaccard similarity (MinHash Analyzer).
- NGRAM_MATCH : string = 'NGRAM_MATCH'
- Match documents whose attribute has an n-gram similarity above a threshold.
- OFFSET_INFO : string = 'OFFSET_INFO'
- Return match offsets for search highlighting (requires the `offset` Analyzer feature).
- PHRASE : string = 'PHRASE'
- Match documents containing a phrase (tokens in the given order, with optional wildcards).
- TFIDF : string = 'TFIDF'
- Score documents with the term frequency–inverse document frequency algorithm (TF-IDF).
Constants
ANALYZER
Set the Analyzer for the wrapped search expression (and its nested functions).
public
string
ANALYZER
= 'ANALYZER'
Tags
BM25
Score documents with the Best Matching 25 algorithm (Okapi BM25).
public
string
BM25
= 'BM25'
Tags
BOOST
Override the boost value of the wrapped search expression for scorer functions.
public
string
BOOST
= 'BOOST'
Tags
EXISTS
Match documents where an attribute is present (optionally of a given type, indexed by a given Analyzer, or indexed as a nested field).
public
string
EXISTS
= 'EXISTS'
Tags
LEVENSHTEIN_MATCH
Match documents within a (Damerau-)Levenshtein distance of a target string.
public
string
LEVENSHTEIN_MATCH
= 'LEVENSHTEIN_MATCH'
Tags
MINHASH_MATCH
Match documents with an approximate Jaccard similarity (MinHash Analyzer).
public
string
MINHASH_MATCH
= 'MINHASH_MATCH'
Tags
NGRAM_MATCH
Match documents whose attribute has an n-gram similarity above a threshold.
public
string
NGRAM_MATCH
= 'NGRAM_MATCH'
Tags
OFFSET_INFO
Return match offsets for search highlighting (requires the `offset` Analyzer feature).
public
string
OFFSET_INFO
= 'OFFSET_INFO'
Tags
PHRASE
Match documents containing a phrase (tokens in the given order, with optional wildcards).
public
string
PHRASE
= 'PHRASE'
Tags
TFIDF
Score documents with the term frequency–inverse document frequency algorithm (TF-IDF).
public
string
TFIDF
= 'TFIDF'