Package dev.langchain4j.store.embedding.neo4j

Class Neo4jEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.neo4j.Neo4jEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class Neo4jEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Represents a Vector index as an embedding store. Annotated with `@Getter` to be used in Neo4jEmbeddingUtils

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Neo4jEmbeddingStore.Neo4jEmbeddingStoreBuilder	Creates an instance of Neo4jEmbeddingStore defining a Driver starting from uri, user and password

Constructor Summary

Constructors

Constructor	Description
Neo4jEmbeddingStore(org.neo4j.driver.SessionConfig config, org.neo4j.driver.Driver driver, int dimension, String label, String embeddingProperty, String idProperty, String metadataPrefix, String textProperty, String indexName, String databaseName, String retrievalQuery, long awaitIndexTimeout)	Creates an instance of Neo4jEmbeddingStore

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.
List<String>	addAll(List<Embedding> embeddings, List<TextSegment> embedded)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)	Searches for the most similar (closest in the embedding space) Embeddings.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.store.embedding.EmbeddingStore

findRelevant, findRelevant, findRelevant, findRelevant, remove, removeAll, removeAll, removeAll

Constructor Details

Neo4jEmbeddingStore

public Neo4jEmbeddingStore(org.neo4j.driver.SessionConfig config,
 org.neo4j.driver.Driver driver,
 int dimension,
 String label,
 String embeddingProperty,
 String idProperty,
 String metadataPrefix,
 String textProperty,
 String indexName,
 String databaseName,
 String retrievalQuery,
 long awaitIndexTimeout)

Creates an instance of Neo4jEmbeddingStore

Parameters:

config - : the SessionConfig (optional, default is `SessionConfig.forDatabase(`databaseName`)`)

driver - : the Driver (required)

dimension - : the dimension (required)

label - : the optional label name (default: "Document")

embeddingProperty - : the optional embeddingProperty name (default: "embedding")

idProperty - : the optional id property name (default: "id")

metadataPrefix - : the optional metadata prefix (default: "")

textProperty - : the optional textProperty property name (default: "text")

indexName - : the optional index name (default: "vector")

databaseName - : the optional database name (default: "neo4j")

retrievalQuery - : the optional retrieval query (default: "RETURN properties(node) AS metadata, node.`idProperty` AS `idProperty`, node.`textProperty` AS `textProperty`, node.`embeddingProperty` AS `embeddingProperty`, score")

Method Details

add

public String add(Embedding embedding)

Description copied from interface: EmbeddingStore

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)

Description copied from interface: EmbeddingStore

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)

Description copied from interface: EmbeddingStore

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)

Description copied from interface: EmbeddingStore

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.

addAll

public List<String> addAll(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.

Specified by:

addAll in interface EmbeddingStore<TextSegment>

Parameters:

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

embedded - A list of original contents that were embedded.

Returns:

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

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Description copied from interface: EmbeddingStore

Searches for the most similar (closest in the embedding space) Embeddings.
All search criteria are defined inside the EmbeddingSearchRequest.
EmbeddingSearchRequest.filter() can be used to filter by various metadata entries (e.g., user/memory ID). Please note that not all EmbeddingStore implementations support Filtering.

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.