| Field | Type | Required | Description |
|---|---|---|---|
table |
string | ✔️ | Table name |
denseVectors |
number[][] | ✔️ | List of dense vectors to do similarity search with. |
sparseVectors |
components.SparseVectors[] | ✔️ | List of sparse vectors to do similarity search with. |
n |
number | ➖ | Number of results to return. |
alpha |
number | ➖ | Weight on searches, 0 is sparse, 1 is dense. |
denseIndexOptions |
components.DenseIndexOptions | ➖ | Index options |
sparseIndexOptions |
components.SparseIndexOptions | ➖ | Index options (k and/or b) |
distances |
string | ➖ | Name of the distance column to be added to the result table. If not set, __nn_distance will be used. |
filter |
string[][] | ➖ | List of triples describing the filter of the form comparison operator, column, values for comparison. |
groupBy |
string[] | ➖ | A list of column names to group by |
agg |
string[][] | ➖ | List of symbol tuples defining the aggregations to perform |
sortCols |
string[] | ➖ | Columns to be sorted ascending, post query execution |