Locality-sensitive hash based vector index for approximate nearest-neighbor retrieval.
VectorFieldIndex
Locality-sensitive hash based vector index for approximate nearest-neighbor retrieval.
Declaration
class VectorFieldIndex
Constructors
constructor
```ts
constructor(params: VectorFieldIndexParams): VectorFieldIndex
```
Parameters:
- `params: VectorFieldIndexParams`
```ts
constructor(numHashTables: number, dimensions: number, random?: RandomSource, initialRandomVectors?: Vector[][], options?: VectorFieldIndexOptions): VectorFieldIndex
```
Parameters:
- `numHashTables: number`
- `dimensions: number`
- `random?: RandomSource`
- `initialRandomVectors?: Vector[][]`
- `options?: VectorFieldIndexOptions`Members
indexState
```ts
get indexState(): VectorFieldIndexState
```loadState
```ts
loadState(fieldIndexState: IndexState): FieldIndex
```
Parameters:
- `fieldIndexState: IndexState`insert
```ts
insert(id: string, embeddings: Vector[]): void
```
Parameters:
- `id: string`
- `embeddings: Vector[]`query
```ts
query(vector: Vector, k: number, filterIds?: string[]): Hits
```
Parameters:
- `vector: Vector`
- `k: number`
- `filterIds?: string[]`queryAsync
```ts
queryAsync(vector: Vector, k: number, filterIds?: string[]): Promise
```
Parameters:
- `vector: Vector`
- `k: number`
- `filterIds?: string[]`rerank
```ts
rerank(vector: Vector, candidateIds: string[], k: number): Hits
```
Parameters:
- `vector: Vector`
- `candidateIds: string[]`
- `k: number`rerankAsync
```ts
rerankAsync(vector: Vector, candidateIds: string[], k: number): Promise
```
Parameters:
- `vector: Vector`
- `candidateIds: string[]`
- `k: number`