Skip to main content
topk-js / query_fn

​
Functions

​
bm25Score()

function bm25Score(): FunctionExpression;
Computes the BM25 score for a keyword search. Returns FunctionExpression

​
semanticSimilarity()

function semanticSimilarity(field: string, query: string): FunctionExpression;
Computes the semantic similarity between a field and a query string. Parameters
ParameterType
fieldstring
querystring
Returns FunctionExpression

​
vectorDistance()

function vectorDistance(
   field: string, 
   query: 
  | number[]
  | List
  | SparseVector
  | Record<number, number>, 
   options?: VectorDistanceOptions): FunctionExpression;
Computes the vector distance between a field and a query vector. Parameters
ParameterType
fieldstring
query| number[] | List | SparseVector | Record<number, number>
options?VectorDistanceOptions
Returns FunctionExpression

​
Interfaces

​
VectorDistanceOptions

Properties
PropertyType
skipRefine?boolean