Type parameters
Properties
vector
• vector:number[]
The query vector.
This must have the same length as the dimensions of the index.
This vector search will return the IDs of the documents most similar to
this vector.
limit
•Optional limit: number
The number of results to return. If specified, must be between 1 and 256
inclusive.
Default
filter
•Optional filter: (q: VectorFilterBuilder<DocumentByInfo<TableInfo>, NamedVectorIndex<TableInfo, IndexName>>) => FilterExpression<boolean>
Type declaration
▸ (q): FilterExpression<boolean>
Optional filter expression made up of q.or and q.eq operating
over the filter fields of the index.
e.g. filter: q => q.or(q.eq("genre", "comedy"), q.eq("genre", "drama"))
Parameters
Returns
FilterExpression<boolean>