Skip to content

vectordb / Exports / IvfPQIndexConfig

Interface: IvfPQIndexConfig

Table of contents

Properties

Properties

column

Optional column: string

The column to be indexed

Defined in

index.ts:1236


index_cache_size

Optional index_cache_size: number

Cache size of the index

Defined in

index.ts:1285


index_name

Optional index_name: string

A unique name for the index

Defined in

index.ts:1241


max_iters

Optional max_iters: number

The max number of iterations for kmeans training.

Defined in

index.ts:1256


max_opq_iters

Optional max_opq_iters: number

Max number of iterations to train OPQ, if use_opq is true.

Defined in

index.ts:1275


metric_type

Optional metric_type: MetricType

Metric type, L2 or Cosine

Defined in

index.ts:1246


num_bits

Optional num_bits: number

The number of bits to present one PQ centroid.

Defined in

index.ts:1270


num_partitions

Optional num_partitions: number

The number of partitions this index

Defined in

index.ts:1251


num_sub_vectors

Optional num_sub_vectors: number

Number of subvectors to build PQ code

Defined in

index.ts:1266


replace

Optional replace: boolean

Replace an existing index with the same name if it exists.

Defined in

index.ts:1280


type

type: "ivf_pq"

Defined in

index.ts:1287


use_opq

Optional use_opq: boolean

Train as optimized product quantization.

Defined in

index.ts:1261