Skip to content
vectorstores Documentation

VectorStoreQuery

Defined in: packages/core/src/vector-store/index.ts:89

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T = unknown

Properties

Section titled “Properties”

queryEmbedding?

Section titled “queryEmbedding?”

optional queryEmbedding: number[]

Defined in: packages/core/src/vector-store/index.ts:90

similarityTopK

Section titled “similarityTopK”

similarityTopK: number

Defined in: packages/core/src/vector-store/index.ts:91

docIds?

Section titled “docIds?”

optional docIds: string[]

Defined in: packages/core/src/vector-store/index.ts:92

queryStr?

Section titled “queryStr?”

optional queryStr: string

Defined in: packages/core/src/vector-store/index.ts:93

mode

Section titled “mode”

mode: VectorStoreQueryMode

Defined in: packages/core/src/vector-store/index.ts:94

alpha?

Section titled “alpha?”

optional alpha: number

Defined in: packages/core/src/vector-store/index.ts:95

filters?

Section titled “filters?”

optional filters: MetadataFilters

Defined in: packages/core/src/vector-store/index.ts:96

mmrThreshold?

Section titled “mmrThreshold?”

optional mmrThreshold: number

Defined in: packages/core/src/vector-store/index.ts:97

customParams?

Section titled “customParams?”

optional customParams: T

Defined in: packages/core/src/vector-store/index.ts:98

hybridPrefetch?

Section titled “hybridPrefetch?”

optional hybridPrefetch: number

Defined in: packages/core/src/vector-store/index.ts:104

Number of results to fetch from each sub-search (vector/BM25) before combining in hybrid mode. Higher values find more candidates but are slower. Default: 5 × similarityTopK