Interface IndexConfig

Whether to create indexes for all distance metrics. If false, only creates index for the specified distanceMetric.

Default

false
Copy

Number of dimensions in the embedding vectors.

Distance metric for vector similarity.

Default

'cosine'
Copy

Embedding function to generate embeddings from text. Can be a LangChain Embeddings instance or a function.

Fields to extract text from for embedding generation. Uses JSON path syntax. Defaults to ["$"] (entire document).

HNSW-specific configuration parameters. Only used when indexType is 'hnsw'.

Vector index type to use.

• 'hnsw': Hierarchical Navigable Small World (best for most use cases)
• 'ivfflat': Inverted File with Flat compression (good for large datasets)

Default

'hnsw'
Copy

IVFFlat-specific configuration parameters. Only used when indexType is 'ivfflat'.