Inverted-index sparse vector retrieval using exact inner-product scoring.
SparseVectorFieldIndex
Inverted-index sparse vector retrieval using exact inner-product scoring.
Declaration
class SparseVectorFieldIndex
Constructors
constructor
```ts
constructor(params: SparseVectorFieldIndexParams): SparseVectorFieldIndex
```
Parameters:
- `params: SparseVectorFieldIndexParams`Members
indexState
```ts
get indexState(): SparseVectorFieldIndexState
```loadState
```ts
loadState(fieldIndexState: IndexState): SparseVectorFieldIndex
```
Parameters:
- `fieldIndexState: IndexState`insert
```ts
insert(id: string, embeddings: SparseVector[]): void
```
Parameters:
- `id: string`
- `embeddings: SparseVector[]`query
```ts
query(vector: SparseVector, k: number, filterIds?: string[]): Hits
```
Parameters:
- `vector: SparseVector`
- `k: number`
- `filterIds?: string[]`rerank
```ts
rerank(vector: SparseVector, candidateIds: string[], k: number): Hits
```
Parameters:
- `vector: SparseVector`
- `candidateIds: string[]`
- `k: number`documentVectors
```ts
documentVectors(id: string): SparseVector[]
```
Parameters:
- `id: string`