Class PgVectorEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.pgvector.PgVectorEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class PgVectorEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

PGVector EmbeddingStore Implementation

Only cosine similarity is used. Only ivfflat index is used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PgVectorEmbeddingStore.DatasourceBuilder
static class	PgVectorEmbeddingStore.PgVectorEmbeddingStoreBuilder
static enum	PgVectorEmbeddingStore.SearchMode	Search modes for the embedding store.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DataSource	datasource	Datasource used to create the store
protected final String	table	Embeddings table name

Constructor Summary

Constructors

Modifier	Constructor	Description
	PgVectorEmbeddingStore()
protected	PgVectorEmbeddingStore(PgVectorEmbeddingStore.DatasourceBuilder builder)	New constructor that takes the DatasourceBuilder.
protected	PgVectorEmbeddingStore(PgVectorEmbeddingStore.PgVectorEmbeddingStoreBuilder builder)	New constructor that takes the builder itself.
protected	PgVectorEmbeddingStore(String host, Integer port, String user, String password, String database, String table, Integer dimension, Boolean useIndex, Integer indexListSize, Boolean createTable, Boolean dropTableFirst, MetadataStorageConfig metadataStorageConfig)	Constructor for PgVectorEmbeddingStore Class Use this builder when you don't have datasource management.
protected	PgVectorEmbeddingStore(DataSource datasource, String table, Integer dimension, Boolean useIndex, Integer indexListSize, Boolean createTable, Boolean dropTableFirst, MetadataStorageConfig metadataStorageConfig)	Constructor for PgVectorEmbeddingStore Class
protected	PgVectorEmbeddingStore(DataSource datasource, String table, Integer dimension, Boolean useIndex, Integer indexListSize, Boolean createTable, Boolean dropTableFirst, MetadataStorageConfig metadataStorageConfig, PgVectorEmbeddingStore.SearchMode searchMode, String textSearchConfig, Integer rrfK)	Constructor for PgVectorEmbeddingStore Class

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)	Adds a given embedding to the store.
String	add(Embedding embedding, TextSegment textSegment)	Adds a given embedding and the corresponding content that has been embedded to the store.
void	add(String id, Embedding embedding)	Adds a given embedding to the store.
List<String>	addAll(List<Embedding> embeddings)	Adds multiple embeddings to the store.
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> embedded)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
static PgVectorEmbeddingStore.PgVectorEmbeddingStoreBuilder	builder()
static PgVectorEmbeddingStore.DatasourceBuilder	datasourceBuilder()
protected Connection	getConnection()	Datasource connection Creates the vector extension and add the vector type if it does not exist.
protected void	initTable(Boolean dropTableFirst, Boolean createTable, Boolean useIndex, Integer dimension, Integer indexListSize)	Initialize metadata table following configuration
void	removeAll()	Removes all embeddings from the store.
void	removeAll(Filter filter)	Removes all embeddings that match the specified Filter from the store.
void	removeAll(Collection<String> ids)	Removes all embeddings that match the specified IDs from the store.
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)	Searches for the most similar (closest in the embedding space) Embeddings.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface EmbeddingStore

addAll, addListener, addListeners, generateIds, remove, searchAsync

Field Details

datasource

protected final DataSource datasource

Datasource used to create the store

table

protected final String table

Embeddings table name

Constructor Details

PgVectorEmbeddingStore

protected PgVectorEmbeddingStore(DataSource datasource,
 String table,
 Integer dimension,
 Boolean useIndex,
 Integer indexListSize,
 Boolean createTable,
 Boolean dropTableFirst,
 MetadataStorageConfig metadataStorageConfig,
 PgVectorEmbeddingStore.SearchMode searchMode,
 String textSearchConfig,
 Integer rrfK)

Constructor for PgVectorEmbeddingStore Class

Parameters:

datasource - The datasource to use

table - The database table

dimension - The vector dimension

useIndex - Should use IVFFlat index

indexListSize - The IVFFlat number of lists

createTable - Should create table automatically

dropTableFirst - Should drop table first, usually for testing

metadataStorageConfig - The MetadataStorageConfig config.

searchMode - The search mode to use (null for default)

textSearchConfig - PostgreSQL text search configuration (null for default)

rrfK - RRF k parameter (null for default)

PgVectorEmbeddingStore

protected PgVectorEmbeddingStore(DataSource datasource,
 String table,
 Integer dimension,
 Boolean useIndex,
 Integer indexListSize,
 Boolean createTable,
 Boolean dropTableFirst,
 MetadataStorageConfig metadataStorageConfig)

Constructor for PgVectorEmbeddingStore Class

Parameters:

datasource - The datasource to use

table - The database table

dimension - The vector dimension

useIndex - Should use IVFFlat index

indexListSize - The IVFFlat number of lists

createTable - Should create table automatically

dropTableFirst - Should drop table first, usually for testing

metadataStorageConfig - The MetadataStorageConfig config.

PgVectorEmbeddingStore

protected PgVectorEmbeddingStore(String host,
 Integer port,
 String user,
 String password,
 String database,
 String table,
 Integer dimension,
 Boolean useIndex,
 Integer indexListSize,
 Boolean createTable,
 Boolean dropTableFirst,
 MetadataStorageConfig metadataStorageConfig)

Constructor for PgVectorEmbeddingStore Class Use this builder when you don't have datasource management.

Parameters:

host - The database host

port - The database port

user - The database user

password - The database password

database - The database name

table - The database table

dimension - The vector dimension

useIndex - Should use IVFFlat index

indexListSize - The IVFFlat number of lists

createTable - Should create table automatically

dropTableFirst - Should drop table first, usually for testing

metadataStorageConfig - The MetadataStorageConfig config.

PgVectorEmbeddingStore

protected PgVectorEmbeddingStore(PgVectorEmbeddingStore.PgVectorEmbeddingStoreBuilder builder)

New constructor that takes the builder itself. This is the entry point for enhanced configuration (searchMode, textSearchConfig, rrfK and skipCreateVectorExtension).

Parameters:

builder - The builder containing all configuration

PgVectorEmbeddingStore

protected PgVectorEmbeddingStore(PgVectorEmbeddingStore.DatasourceBuilder builder)

New constructor that takes the DatasourceBuilder. This is the entry point for enhanced configuration (searchMode, textSearchConfig, rrfK and skipCreateVectorExtension).

Parameters:

builder - The builder containing all configuration

PgVectorEmbeddingStore

public PgVectorEmbeddingStore()

Method Details

datasourceBuilder

public static PgVectorEmbeddingStore.DatasourceBuilder datasourceBuilder()

builder

public static PgVectorEmbeddingStore.PgVectorEmbeddingStoreBuilder builder()

initTable

protected void initTable(Boolean dropTableFirst,
 Boolean createTable,
 Boolean useIndex,
 Integer dimension,
 Integer indexListSize)

Initialize metadata table following configuration

Parameters:

dropTableFirst - Should drop table first, usually for testing

createTable - Should create table automatically

useIndex - Should use IVFFlat index

dimension - The vector dimension

indexListSize - The IVFFlat number of lists

add

public String add(Embedding embedding)

Adds a given embedding to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

embedding - The embedding to be added to the store.

Returns:

The auto-generated ID associated with the added embedding.

add

public void add(String id,
 Embedding embedding)

Adds a given embedding to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

id - The unique identifier for the embedding to be added.

embedding - The embedding to be added to the store.

add

public String add(Embedding embedding,
 TextSegment textSegment)

Adds a given embedding and the corresponding content that has been embedded to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

embedding - The embedding to be added to the store.

textSegment - Original content that was embedded.

Returns:

The auto-generated ID associated with the added embedding.

addAll

public List<String> addAll(List<Embedding> embeddings)

Adds multiple embeddings to the store.

Specified by:

addAll in interface EmbeddingStore<TextSegment>

Parameters:

embeddings - A list of embeddings to be added to the store.

Returns:

A list of auto-generated IDs associated with the added embeddings.

removeAll

public void removeAll(Collection<String> ids)

Description copied from interface: EmbeddingStore

Removes all embeddings that match the specified IDs from the store.

Having nothing to remove is a no-op: an empty or null collection of IDs leaves the store unchanged and throws nothing, in the same way that adding no embeddings stores nothing.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

Parameters:

ids - A collection of unique IDs of the embeddings to be removed.

removeAll

public void removeAll(Filter filter)

Description copied from interface: EmbeddingStore

Removes all embeddings that match the specified Filter from the store.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

Parameters:

filter - The filter to be applied to the Metadata of the TextSegment during removal. Only embeddings whose TextSegment's Metadata match the Filter will be removed.

removeAll

public void removeAll()

Description copied from interface: EmbeddingStore

Removes all embeddings from the store.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Searches for the most similar (closest in the embedding space) Embeddings.
All search criteria are defined inside the EmbeddingSearchRequest.
EmbeddingSearchRequest.filter() is used to filter by meta dada.

Specified by:

search in interface EmbeddingStore<TextSegment>

Parameters:

request - A request to search in an EmbeddingStore. Contains all search criteria.

Returns:

An EmbeddingSearchResult containing all found Embeddings.

addAll

public void addAll(List<String> ids,
 List<Embedding> embeddings,
 List<TextSegment> embedded)

Description copied from interface: EmbeddingStore

Adds multiple embeddings and their corresponding contents that have been embedded to the store.

The lists are positional: the i-th ID, the i-th embedding and the i-th embedded content belong together. ids and embeddings must therefore have the same size, and embedded, when provided, must have that size as well. A null list of IDs or embeddings counts as an empty list, so passing embeddings without IDs (or the other way around) is a size mismatch, not an empty input. ValidationUtils.ensureConsistentSizes(List, List, List) implements these rules and should be used by implementations.

Passing no embeddings at all (an empty or null embeddings together with an empty or null ids, and no embedded contents) is a no-op: nothing is stored and no exception is thrown.

Specified by:

addAll in interface EmbeddingStore<TextSegment>

Parameters:

ids - A list of IDs associated with the added embeddings.

embeddings - A list of embeddings to be added to the store.

embedded - A list of original contents that were embedded, or null if they were not provided.

getConnection

protected Connection getConnection()
                            throws SQLException

Datasource connection Creates the vector extension and add the vector type if it does not exist. Could be overridden in case extension creation and adding type is done at datasource initialization step.

Returns:

Datasource connection

Throws:

SQLException - exception