lancedb/docs/src/javascript/interfaces/IvfPQIndexConfig.md

vectordb / Exports / IvfPQIndexConfig

Interface: IvfPQIndexConfig

Table of contents

Properties

• column
• index_cache_size
• index_name
• max_iters
• max_opq_iters
• metric_type
• num_bits
• num_partitions
• num_sub_vectors
• replace
• type
• use_opq

Properties

column

• Optional column: string

The column to be indexed

Defined in

index.ts:968

---

index_cache_size

• Optional index_cache_size: number

Cache size of the index

Defined in

index.ts:1042

---

index_name

• Optional index_name: string

Note: this parameter is not supported on LanceDB Cloud

Defined in

index.ts:976

---

max_iters

• Optional max_iters: number

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:997

---

max_opq_iters

• Optional max_opq_iters: number

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:1029

---

metric_type

• Optional metric_type: MetricType

Metric type, L2 or Cosine

Defined in

index.ts:981

---

num_bits

• Optional num_bits: number

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:1021

---

num_partitions

• Optional num_partitions: number

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:989

---

num_sub_vectors

• Optional num_sub_vectors: number

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:1013

---

replace

• Optional replace: boolean

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:1037

---

type

• type: "ivf_pq"

Defined in

index.ts:1044

---

use_opq

• Optional use_opq: boolean

Note: this parameter is not yet supported on LanceDB Cloud

Defined in

index.ts:1005