Package org.springframework.ai.vectorstore

Class Neo4jVectorStore

java.lang.Object

org.springframework.ai.vectorstore.Neo4jVectorStore

All Implemented Interfaces:

Consumer<List<Document>>, DocumentWriter, VectorStore, org.springframework.beans.factory.InitializingBean

public class Neo4jVectorStore
extends Object
implements VectorStore, org.springframework.beans.factory.InitializingBean

Author:

Gerrit Meier, Michael Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Neo4jVectorStore.Neo4jDistanceType	An enum to configure the distance function used in the Neo4j vector index.
static final class	Neo4jVectorStore.Neo4jVectorStoreConfig	Configuration for the Neo4j vector store.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_EMBEDDING_DIMENSION
static final String	DEFAULT_EMBEDDING_PROPERTY
static final String	DEFAULT_INDEX_NAME
static final String	DEFAULT_LABEL

Constructor Summary

Constructors

Constructor	Description
Neo4jVectorStore(org.neo4j.driver.Driver driver, EmbeddingClient embeddingClient, Neo4jVectorStore.Neo4jVectorStoreConfig config)

Method Summary

Modifier and Type	Method	Description
void	add(List<Document> documents)	Adds list of Documents to the vector store.
void	afterPropertiesSet()
Optional<Boolean>	delete(List<String> idList)	Deletes documents from the vector store.
List<Document>	similaritySearch(SearchRequest request)	Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.springframework.ai.vectorstore.VectorStore

accept, similaritySearch

Field Details

DEFAULT_EMBEDDING_DIMENSION

public static final int DEFAULT_EMBEDDING_DIMENSION

See Also:

• Constant Field Values

DEFAULT_LABEL

public static final String DEFAULT_LABEL

See Also:

• Constant Field Values

DEFAULT_INDEX_NAME

public static final String DEFAULT_INDEX_NAME

See Also:

• Constant Field Values

DEFAULT_EMBEDDING_PROPERTY

public static final String DEFAULT_EMBEDDING_PROPERTY

See Also:

• Constant Field Values

Constructor Details

Neo4jVectorStore

public Neo4jVectorStore(org.neo4j.driver.Driver driver,
 EmbeddingClient embeddingClient,
 Neo4jVectorStore.Neo4jVectorStoreConfig config)

Method Details

add

public void add(List<Document> documents)

Description copied from interface: VectorStore

Adds list of Documents to the vector store.

Specified by:

add in interface VectorStore

Parameters:

documents - the list of documents to store. Throws an exception if the underlying provider checks for duplicate IDs.

delete

public Optional<Boolean> delete(List<String> idList)

Description copied from interface: VectorStore

Deletes documents from the vector store.

Specified by:

delete in interface VectorStore

Parameters:

idList - list of document ids for which documents will be removed.

Returns:

similaritySearch

public List<Document> similaritySearch(SearchRequest request)

Description copied from interface: VectorStore

Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.

Specified by:

similaritySearch in interface VectorStore

Parameters:

request - Search request for set search parameters, such as the query text, topK, similarity threshold and metadata filter expressions.

Returns:

Returns documents th match the query request conditions.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean