Neo4jVector#

class langchain_community.vectorstores.neo4j_vector.Neo4jVector(embedding: Embeddings, *, search_type: SearchType = SearchType.VECTOR, username: str | None = None, password: str | None = None, url: str | None = None, keyword_index_name: str | None = 'keyword', database: str | None = None, index_name: str = 'vector', node_label: str = 'Chunk', embedding_node_property: str = 'embedding', text_node_property: str = 'text', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, logger: Logger | None = None, pre_delete_collection: bool = False, retrieval_query: str = '', relevance_score_fn: Callable[[float], float] | None = None, index_type: IndexType = IndexType.NODE, graph: Neo4jGraph | None = None)[source]#

Neo4j vector index.

To use, you should have the neo4j python package installed.

Parameters:

url (Optional[str]) – Neo4j connection url
username (Optional[str]) – Neo4j username.
password (Optional[str]) – Neo4j password
database (Optional[str]) – Optionally provide Neo4j database Defaults to “neo4j”
embedding (Embeddings) – Any embedding function implementing langchain.embeddings.base.Embeddings interface.
distance_strategy (DistanceStrategy) – The distance strategy to use. (default: COSINE)
pre_delete_collection (bool) – If True, will delete existing data if it exists. (default: False). Useful for testing.
search_type (SearchType) –
keyword_index_name (Optional[str]) –
index_name (str) –
node_label (str) –
embedding_node_property (str) –
text_node_property (str) –
logger (Optional[logging.Logger]) –
retrieval_query (str) –
relevance_score_fn (Optional[Callable[[float], float]]) –
index_type (IndexType) –
graph (Optional[Neo4jGraph]) –

Example

from langchain_community.vectorstores.neo4j_vector import Neo4jVector
from langchain_community.embeddings.openai import OpenAIEmbeddings

url="bolt://localhost:7687"
username="neo4j"
password="pleaseletmein"
embeddings = OpenAIEmbeddings()
vectorestore = Neo4jVector.from_documents(
    embedding=embeddings,
    documents=docs,
    url=url
    username=username,
    password=password,
)

Attributes

embeddings

Access the query embedding object if available.

Methods

`__init__`(embedding, *[, search_type, ...])
`aadd_documents`(documents, **kwargs)	Async run more documents through the embeddings and add to the vectorstore.
`aadd_texts`(texts[, metadatas])	Async run more texts through the embeddings and add to the vectorstore.
`add_documents`(documents, **kwargs)	Add or update documents in the vectorstore.
`add_embeddings`(texts, embeddings[, ...])	Add embeddings to the vectorstore.
`add_texts`(texts[, metadatas, ids])	Run more texts through the embeddings and add to the vectorstore.
`adelete`([ids])	Async delete by vector ID or other criteria.
`afrom_documents`(documents, embedding, **kwargs)	Async return VectorStore initialized from documents and embeddings.
`afrom_texts`(texts, embedding[, metadatas])	Async return VectorStore initialized from texts and embeddings.
`aget_by_ids`(ids, /)	Async get documents by their IDs.
`amax_marginal_relevance_search`(query[, k, ...])	Async return docs selected using the maximal marginal relevance.
`amax_marginal_relevance_search_by_vector`(...)	Async return docs selected using the maximal marginal relevance.
`as_retriever`(**kwargs)	Return VectorStoreRetriever initialized from this VectorStore.
`asearch`(query, search_type, **kwargs)	Async return docs most similar to query using a specified search type.
`asimilarity_search`(query[, k])	Async return docs most similar to query.
`asimilarity_search_by_vector`(embedding[, k])	Async return docs most similar to embedding vector.
`asimilarity_search_with_relevance_scores`(query)	Async return docs and relevance scores in the range [0, 1].
`asimilarity_search_with_score`(args, *kwargs)	Async run similarity search with distance.
`create_new_index`()	This method constructs a Cypher query and executes it to create a new vector index in Neo4j.
`create_new_keyword_index`([text_node_properties])	This method constructs a Cypher query and executes it to create a new full text index in Neo4j.
`delete`([ids])	Delete by vector ID or other criteria.
`from_documents`(documents, embedding[, ...])	Return Neo4jVector initialized from documents and embeddings.
`from_embeddings`(text_embeddings, embedding)	Construct Neo4jVector wrapper from raw documents and pre- generated embeddings.
`from_existing_graph`(embedding, node_label, ...)	Initialize and return a Neo4jVector instance from an existing graph.
`from_existing_index`(embedding, index_name[, ...])	Get instance of an existing Neo4j vector index.
`from_existing_relationship_index`(embedding, ...)	Get instance of an existing Neo4j relationship vector index.
`from_texts`(texts, embedding[, metadatas, ...])	Return Neo4jVector initialized from texts and embeddings.
`get_by_ids`(ids, /)	Get documents by their IDs.
`max_marginal_relevance_search`(query[, k, ...])	Return docs selected using the maximal marginal relevance.
`max_marginal_relevance_search_by_vector`(...)	Return docs selected using the maximal marginal relevance.
`query`(query, *[, params, ...])	This method sends a Cypher query to the connected Neo4j database and returns the results as a list of dictionaries.
`retrieve_existing_fts_index`([...])	Check if the fulltext index exists in the Neo4j database
`retrieve_existing_index`()	Check if the vector index exists in the Neo4j database and returns its embedding dimension.
`search`(query, search_type, **kwargs)	Return docs most similar to query using a specified search type.
`similarity_search`(query[, k, params, filter])	Run similarity search with Neo4jVector.
`similarity_search_by_vector`(embedding[, k, ...])	Return docs most similar to embedding vector.
`similarity_search_with_relevance_scores`(query)	Return docs and relevance scores in the range [0, 1].
`similarity_search_with_score`(query[, k, ...])	Return docs most similar to query.
`similarity_search_with_score_by_vector`(embedding)	Perform a similarity search in the Neo4j database using a given vector and return the top k similar documents with their scores.
`verify_version`()	Check if the connected Neo4j database version supports vector indexing.

__init__(embedding: Embeddings, *, search_type: SearchType = SearchType.VECTOR, username: str | None = None, password: str | None = None, url: str | None = None, keyword_index_name: str | None = 'keyword', database: str | None = None, index_name: str = 'vector', node_label: str = 'Chunk', embedding_node_property: str = 'embedding', text_node_property: str = 'text', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, logger: Logger | None = None, pre_delete_collection: bool = False, retrieval_query: str = '', relevance_score_fn: Callable[[float], float] | None = None, index_type: IndexType = IndexType.NODE, graph: Neo4jGraph | None = None) → None[source]#

Parameters:

embedding (Embeddings) –
search_type (SearchType) –
username (str | None) –
password (str | None) –
url (str | None) –
keyword_index_name (str | None) –
database (str | None) –
index_name (str) –
node_label (str) –
embedding_node_property (str) –
text_node_property (str) –
distance_strategy (DistanceStrategy) –
logger (Logger | None) –
pre_delete_collection (bool) –
retrieval_query (str) –
relevance_score_fn (Callable[[float], float] | None) –
index_type (IndexType) –
graph (Neo4jGraph | None) –

Return type:

None

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]#

Async run more documents through the embeddings and add to the vectorstore.

Parameters:

documents (List[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of IDs does not match the number of documents.

Return type:

List[str]

async aadd_texts(texts: Iterable[str], metadatas: List[dict] | None = None, **kwargs: Any) → List[str]#

Async run more texts through the embeddings and add to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the vectorstore.
metadatas (List[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
**kwargs (Any) – vectorstore specific parameters.

Returns:

List of ids from adding the texts into the vectorstore.

Raises:

ValueError – If the number of metadatas does not match the number of texts.
ValueError – If the number of ids does not match the number of texts.

Return type:

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]#

Add or update documents in the vectorstore.

Parameters:

documents (List[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments. if kwargs contains ids and documents contain ids, the ids in the kwargs will receive precedence.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of ids does not match the number of documents.

Return type:

List[str]

add_embeddings(texts: Iterable[str], embeddings: List[List[float]], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

Add embeddings to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the vectorstore.
embeddings (List[List[float]]) – List of list of embedding vectors.
metadatas (List[dict] | None) – List of metadatas associated with the texts.
kwargs (Any) – vectorstore specific parameters
ids (List[str] | None) –

Return type:

List[str]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

Run more texts through the embeddings and add to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the vectorstore.
metadatas (List[dict] | None) – Optional list of metadatas associated with the texts.
kwargs (Any) – vectorstore specific parameters
ids (List[str] | None) –

Returns:

List of ids from adding the texts into the vectorstore.

Return type:

List[str]

async adelete(ids: List[str] | None = None, **kwargs: Any) → bool | None#

Async delete by vector ID or other criteria.

Parameters:

ids (List[str] | None) – List of ids to delete. If None, delete all. Default is None.
**kwargs (Any) – Other keyword arguments that subclasses might use.

Returns:

True if deletion is successful, False otherwise, None if not implemented.

Return type:

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST#

Async return VectorStore initialized from documents and embeddings.

Parameters:

documents (List[Document]) – List of Documents to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from documents and embeddings.

Return type:

VectorStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, **kwargs: Any) → VST#

Async return VectorStore initialized from texts and embeddings.

Parameters:

texts (List[str]) – Texts to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
metadatas (List[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from texts and embeddings.

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List[Document]#

Async get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: List[Document]

New in version 0.2.11.

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
kwargs (Any) –

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

Return VectorStoreRetriever initialized from this VectorStore.

Parameters:

**kwargs (Any) –

Keyword arguments to pass to the search function. Can include: search_type (Optional[str]): Defines the type of search that

the Retriever should perform. Can be “similarity” (default), “mmr”, or “similarity_score_threshold”.

search_kwargs (Optional[Dict]): Keyword arguments to pass to the

search function. Can include things like:

k: Amount of documents to return (Default: 4) score_threshold: Minimum relevance threshold

for similarity_score_threshold

fetch_k: Amount of documents to pass to MMR algorithm: (Default: 20)
lambda_mult: Diversity of results returned by MMR;: 1 for minimum diversity and 0 for maximum. (Default: 0.5)

filter: Filter by document metadata

Returns:

Retriever class for VectorStore.

Return type:

VectorStoreRetriever

Examples:

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]#

Async return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text.
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]#

Async return docs most similar to query.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Return type:

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]#

Async return docs most similar to embedding vector.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query vector.

Return type:

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]#

Async return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs

Returns:

List of Tuples of (doc, similarity_score)

Return type:

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]#

Async run similarity search with distance.

Parameters:

*args (Any) – Arguments to pass to the search method.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

List[Tuple[Document, float]]

create_new_index() → None[source]#

This method constructs a Cypher query and executes it to create a new vector index in Neo4j.

Return type:: None

create_new_keyword_index(text_node_properties: List[str] = []) → None[source]#

This method constructs a Cypher query and executes it to create a new full text index in Neo4j.

Parameters:: text_node_properties (List[str]) –
Return type:: None

delete(ids: List[str] | None = None, **kwargs: Any) → bool | None#

Delete by vector ID or other criteria.

Parameters:

ids (List[str] | None) – List of ids to delete. If None, delete all. Default is None.
**kwargs (Any) – Other keyword arguments that subclasses might use.

Returns:

True if deletion is successful, False otherwise, None if not implemented.

Return type:

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, **kwargs: Any) → Neo4jVector[source]#

Return Neo4jVector initialized from documents and embeddings. Neo4j credentials are required in the form of url, username, and password and optional database parameters.

Parameters:

documents (List[Document]) –
embedding (Embeddings) –
distance_strategy (DistanceStrategy) –
ids (List[str] | None) –
kwargs (Any) –

Return type:

Neo4jVector

classmethod from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: List[dict] | None = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, pre_delete_collection: bool = False, **kwargs: Any) → Neo4jVector[source]#

Construct Neo4jVector wrapper from raw documents and pre- generated embeddings.

Return Neo4jVector initialized from documents and embeddings. Neo4j credentials are required in the form of url, username, and password and optional database parameters.

Example

from langchain_community.vectorstores.neo4j_vector import Neo4jVector
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
vectorstore = Neo4jVector.from_embeddings(
    text_embedding_pairs, embeddings)

Parameters:

text_embeddings (List[Tuple[str, List[float]]]) –
embedding (Embeddings) –
metadatas (List[dict] | None) –
distance_strategy (DistanceStrategy) –
ids (List[str] | None) –
pre_delete_collection (bool) –
kwargs (Any) –

Return type:

Neo4jVector

classmethod from_existing_graph(embedding: Embeddings, node_label: str, embedding_node_property: str, text_node_properties: List[str], *, keyword_index_name: str | None = 'keyword', index_name: str = 'vector', search_type: SearchType = SearchType.VECTOR, retrieval_query: str = '', **kwargs: Any) → Neo4jVector[source]#

Initialize and return a Neo4jVector instance from an existing graph.

This method initializes a Neo4jVector instance using the provided parameters and the existing graph. It validates the existence of the indices and creates new ones if they don’t exist.

Returns: Neo4jVector: An instance of Neo4jVector initialized with the provided parameters

and existing graph.

Example: >>> neo4j_vector = Neo4jVector.from_existing_graph( … embedding=my_embedding, … node_label=”Document”, … embedding_node_property=”embedding”, … text_node_properties=[“title”, “content”] … )

Note: Neo4j credentials are required in the form of url, username, and password, and optional database parameters passed as additional keyword arguments.

Parameters:

embedding (Embeddings) –
node_label (str) –
embedding_node_property (str) –
text_node_properties (List[str]) –
keyword_index_name (str | None) –
index_name (str) –
search_type (SearchType) –
retrieval_query (str) –
kwargs (Any) –

Return type:

Neo4jVector

classmethod from_existing_index(embedding: Embeddings, index_name: str, search_type: SearchType = SearchType.VECTOR, keyword_index_name: str | None = None, **kwargs: Any) → Neo4jVector[source]#

Get instance of an existing Neo4j vector index. This method will return the instance of the store without inserting any new embeddings. Neo4j credentials are required in the form of url, username, and password and optional database parameters along with the index_name definition.

Parameters:

embedding (Embeddings) –
index_name (str) –
search_type (SearchType) –
keyword_index_name (str | None) –
kwargs (Any) –

Return type:

Neo4jVector

classmethod from_existing_relationship_index(embedding: Embeddings, index_name: str, search_type: SearchType = SearchType.VECTOR, **kwargs: Any) → Neo4jVector[source]#

Get instance of an existing Neo4j relationship vector index. This method will return the instance of the store without inserting any new embeddings. Neo4j credentials are required in the form of url, username, and password and optional database parameters along with the index_name definition.

Parameters:

embedding (Embeddings) –
index_name (str) –
search_type (SearchType) –
kwargs (Any) –

Return type:

Neo4jVector

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, **kwargs: Any) → Neo4jVector[source]#

Return Neo4jVector initialized from texts and embeddings. Neo4j credentials are required in the form of url, username, and password and optional database parameters.

Parameters:

texts (List[str]) –
embedding (Embeddings) –
metadatas (List[dict] | None) –
distance_strategy (DistanceStrategy) –
ids (List[str] | None) –
kwargs (Any) –

Return type:

Neo4jVector

get_by_ids(ids: Sequence[str], /) → List[Document]#

Get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: List[Document]

New in version 0.2.11.

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: dict | None = None, **kwargs: Any) → List[Document][source]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

query (str) – search query text.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
filter (dict | None) –
Filter on metadata properties, e.g. {

”str_property”: “foo”, “int_property”: 123

}
kwargs (Any) –

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

List[Document]

query(query: str, *, params: dict | None = None, retry_on_session_expired: bool = True) → List[Dict[str, Any]][source]#

This method sends a Cypher query to the connected Neo4j database and returns the results as a list of dictionaries.

Parameters:

query (str) – The Cypher query to execute.
params (dict, optional) – Dictionary of query parameters. Defaults to {}.
retry_on_session_expired (bool) –

Returns:

List of dictionaries containing the query results.

Return type:

List[Dict[str, Any]]

retrieve_existing_fts_index(text_node_properties: List[str] = []) → str | None[source]#

Check if the fulltext index exists in the Neo4j database

This method queries the Neo4j database for existing fts indexes with the specified name.

Returns:: keyword index information
Return type:: (Tuple)
Parameters:: text_node_properties (List[str]) –

retrieve_existing_index() → Tuple[int | None, str | None][source]#

Check if the vector index exists in the Neo4j database and returns its embedding dimension.

This method queries the Neo4j database for existing indexes and attempts to retrieve the dimension of the vector index with the specified name. If the index exists, its dimension is returned. If the index doesn’t exist, None is returned.

Returns:: The embedding dimension of the existing index if found.
Return type:: int or None

search(query: str, search_type: str, **kwargs: Any) → List[Document]#

Return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

List[Document]

similarity_search(query: str, k: int = 4, params: Dict[str, Any] = {}, filter: Dict[str, Any] | None = None, **kwargs: Any) → List[Document][source]#

Run similarity search with Neo4jVector.

Parameters:

query (str) – Query text to search for.
k (int) – Number of results to return. Defaults to 4.
params (Dict[str, Any]) – The search params for the index type. Defaults to empty dict.
filter (Optional[Dict[str, Any]]) –

Dictionary of argument(s) to
filter on metadata.

Defaults to None.
kwargs (Any) –

Returns:

List of Documents most similar to the query.

Return type:

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Dict[str, Any] | None = None, params: Dict[str, Any] = {}, **kwargs: Any) → List[Document][source]#

Return docs most similar to embedding vector.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
filter (Optional[Dict[str, Any]]) –

Dictionary of argument(s) to
filter on metadata.

Defaults to None.
params (Dict[str, Any]) – The search params for the index type. Defaults to empty dict.
kwargs (Any) –

Returns:

List of Documents most similar to the query vector.

Return type:

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]#

Return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, params: Dict[str, Any] = {}, filter: Dict[str, Any] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Return docs most similar to query.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
params (Dict[str, Any]) – The search params for the index type. Defaults to empty dict.
filter (Optional[Dict[str, Any]]) –

Dictionary of argument(s) to
filter on metadata.

Defaults to None.
kwargs (Any) –

Returns:

List of Documents most similar to the query and score for each

Return type:

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Dict[str, Any] | None = None, params: Dict[str, Any] = {}, **kwargs: Any) → List[Tuple[Document, float]][source]#

Perform a similarity search in the Neo4j database using a given vector and return the top k similar documents with their scores.

This method uses a Cypher query to find the top k documents that are most similar to a given embedding. The similarity is measured using a vector index in the Neo4j database. The results are returned as a list of tuples, each containing a Document object and its similarity score.

Parameters:

embedding (List[float]) – The embedding vector to compare against.
k (int, optional) – The number of top similar documents to retrieve.
filter (Optional[Dict[str, Any]]) –

Dictionary of argument(s) to
filter on metadata.

Defaults to None.
params (Dict[str, Any]) – The search params for the index type. Defaults to empty dict.
kwargs (Any) –

Returns:

A list of tuples, each containing: a Document object and its similarity score.

Return type:

List[Tuple[Document, float]]

verify_version() → None[source]#

Check if the connected Neo4j database version supports vector indexing.

Queries the Neo4j database to retrieve its version and compares it against a target version (5.11.0) that is known to support vector indexing. Raises a ValueError if the connected Neo4j version is not supported.

Return type:: None

Examples using Neo4jVector