Neo4j向量#

class langchain_neo4j.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 向量索引。

要使用，您应该安装neo4j python包。

Parameters:

url (可选[str]) – Neo4j 连接地址
username (可选[str]) – Neo4j 用户名。
password (可选[str]) – Neo4j 密码
database (可选[str]) – 可选提供Neo4j数据库默认为“neo4j”
embedding (Embeddings) – 任何实现langchain.embeddings.base.Embeddings接口的嵌入函数。
distance_strategy (DistanceStrategy) – 使用的距离策略。(默认: COSINE)
search_type (SearchType) – 要执行的搜索类型，可以是‘vector’或‘hybrid’
node_label (str) – 用于Neo4j数据库中节点的标签。 (默认值: “Chunk”)
embedding_node_property (str) – Neo4j 中用于存储嵌入的属性名称。 (默认值: “embedding”)
text_node_property (str) – 在Neo4j中存储文本的属性名称。 (默认值: “text”)
retrieval_query (str) – 用于自定义检索的Cypher查询。如果为空，将使用默认查询。
index_type (IndexType) – 要使用的索引类型，可以是‘NODE’或‘RELATIONSHIP’
pre_delete_collection (bool) – 如果为True，将删除已存在的数据。 (默认值: False)。对测试很有用。
effective_search_ratio – 通过乘以$k来控制候选池的大小，以平衡查询准确性和性能。
keyword_index_name (可选[str])
index_name (str)
logger (可选[logging.Logger])
relevance_score_fn (可选[Callable[[float], float]])
graph (可选[Neo4jGraph])

示例

from langchain_neo4j import Neo4jVector
from langchain_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,
)

属性

embeddings

如果可用，访问查询嵌入对象。

方法

`__init__`(embedding, *[, search_type, ...])
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_embeddings`(texts, embeddings[, ...])	将嵌入添加到向量存储中。
`add_texts`(texts[, metadatas, ids])	通过嵌入运行更多文本并将其添加到向量存储中。
`adelete`([ids])	异步删除通过向量ID或其他条件。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas, ids])	异步返回从文本和嵌入初始化的VectorStore。
`aget_by_ids`(ids, /)	通过ID异步获取文档。
`amax_marginal_relevance_search`(query[, k, ...])	异步返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	异步返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	返回从此VectorStore初始化的VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	异步返回与查询最相似的文档，使用指定的搜索类型。
`asimilarity_search`(query[, k])	异步返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	异步返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步返回文档和相关分数，范围在[0, 1]之间。
`asimilarity_search_with_score`(args, *kwargs)	异步运行带距离的相似性搜索。
`create_new_index`()	此方法构建一个Cypher查询并执行它以在Neo4j中创建一个新的向量索引。
`create_new_keyword_index`([text_node_properties])	此方法构建一个Cypher查询并执行它以在Neo4j中创建一个新的全文索引。
`delete`([ids])	通过向量ID或其他条件删除。
`from_documents`(documents, embedding[, ...])	返回从文档和嵌入初始化的Neo4jVector。
`from_embeddings`(text_embeddings, embedding)	从原始文档和预生成的嵌入中构建Neo4jVector包装器。
`from_existing_graph`(embedding, node_label, ...)	从现有图中初始化并返回一个Neo4jVector实例。
`from_existing_index`(embedding, index_name[, ...])	获取现有Neo4j向量索引的实例。
`from_existing_relationship_index`(embedding, ...)	获取现有Neo4j关系向量索引的实例。
`from_texts`(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的Neo4jVector。
`get_by_ids`(ids, /)	通过ID获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`query`(query, *[, params])	使用重试和指数退避查询Neo4j数据库。
`retrieve_existing_fts_index`([...])	检查Neo4j数据库中是否存在全文索引
`retrieve_existing_index`()	检查向量索引是否存在于Neo4j数据库中，并返回其嵌入维度。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k, params, ...])	使用Neo4jVector进行相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关度分数，范围在[0, 1]之间。
`similarity_search_with_score`(query[, k, ...])	返回与查询最相似的文档。
`similarity_search_with_score_by_vector`(embedding)	在Neo4j数据库中使用给定的向量执行相似性搜索，并返回前k个相似文档及其分数。
`verify_version`()	检查连接的Neo4j数据库版本是否支持向量索引。

__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)
数据库 (字符串 | 无)
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:

无

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

通过嵌入异步运行更多文档并将其添加到向量存储中。

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果ID的数量与文档的数量不匹配。

Return type:

列表[字符串]

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

异步运行更多文本通过嵌入并添加到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。
ids (list[str] | None) – 可选的列表
**kwargs (Any) – 向量存储特定参数。

Returns:

将文本添加到向量存储中后的ID列表。

Raises:

ValueError – 如果元数据的数量与文本的数量不匹配。
ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[字符串]

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

在向量存储中添加或更新文档。

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。如果 kwargs 包含 ids 并且 documents 也包含 ids， kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果id的数量与文档的数量不匹配。

Return type:

列表[字符串]

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

将嵌入添加到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
embeddings (List[List[float]]) – 嵌入向量的列表的列表。
metadatas (List[dict] | None) – 与文本相关联的元数据列表。
kwargs (Any) – 向量存储特定参数
ids (列表[字符串] | 无)

Return type:

列表[str]

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

通过嵌入运行更多文本并添加到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。
kwargs (Any) – 向量存储特定参数
ids (列表[字符串] | 无)

Returns:

将文本添加到向量存储中后的ID列表。

Return type:

列表[str]

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

通过向量ID或其他条件异步删除。

Parameters:

ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

异步返回从文档和嵌入初始化的VectorStore。

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档列表。
embedding (Embeddings) – 使用的嵌入函数。
kwargs (Any) – 额外的关键字参数。

Returns:

从文档和嵌入初始化的VectorStore。

Return type:

VectorStore

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

异步返回从文本和嵌入初始化的VectorStore。

Parameters:

texts (list[str]) – 要添加到向量存储中的文本。
embedding (Embeddings) – 使用的嵌入函数。
metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。
ids (list[str] | None) – 可选的与文本关联的ID列表。
kwargs (Any) – 额外的关键字参数。

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

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

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[Document]

在版本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]#

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
kwargs (Any)

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[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]#

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

检索器应执行的搜索类型。可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。

可以包括以下内容：

k: 返回的文档数量（默认：4） score_threshold: 最小相关性阈值

用于similarity_score_threshold

fetch_k: 传递给MMR算法的文档数量: （默认：20）
lambda_mult: MMR返回结果的多样性；: 1表示最小多样性，0表示最大多样性。（默认：0.5）

filter: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

VectorStoreRetriever

示例：

# 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]#

异步返回与查询最相似的文档，使用指定的搜索类型。

Parameters:

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

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

异步返回与查询最相似的文档。

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Return type:

列表[Document]

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

异步返回与嵌入向量最相似的文档。

Parameters:

embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

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

异步返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) –
传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

过滤检索到的文档集

Returns:

（文档，相似度分数）的元组列表

Return type:

列表[元组[Document, 浮点数]]

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

异步运行带有距离的相似性搜索。

Parameters:

*args (Any) – 传递给搜索方法的参数。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

create_new_index() → None[source]#

此方法构建一个Cypher查询并执行它，以在Neo4j中创建一个新的向量索引。

Return type:: 无

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

此方法构建一个Cypher查询并执行它，以在Neo4j中创建一个新的全文索引。

Parameters:: text_node_properties (List[str])
Return type:: 无

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

根据向量ID或其他条件删除。

Parameters:

ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

返回从文档和嵌入初始化的Neo4jVector。需要以url、username、password和可选的database参数形式提供Neo4j凭据。

Parameters:

文档 (列表[Document])
embedding (Embeddings)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
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]#

从原始文档和预生成的嵌入中构建Neo4jVector包装器。

返回从文档和嵌入初始化的Neo4jVector。需要以url、username、password和可选的database参数形式提供Neo4j凭据。

示例

from langchain_neo4j import Neo4jVector
from langchain_openai 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 (列表[字典] | 无)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
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]#

从现有图初始化并返回一个Neo4jVector实例。

此方法使用提供的参数和现有图初始化一个Neo4jVector实例。它验证索引的存在性，并在它们不存在时创建新的索引。

返回: Neo4jVector: 使用提供的参数初始化的Neo4jVector实例

和现有的图表。

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

注意：需要以url、username和password的形式提供Neo4j凭据，以及可选的database参数作为额外的关键字参数传递。

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[来源]#

获取现有Neo4j向量索引的实例。此方法将返回存储的实例，而不会插入任何新的嵌入。 Neo4j凭据需要以url、username和password的形式提供，以及可选的database参数和index_name定义。

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]#

获取现有Neo4j关系向量索引的实例。此方法将返回存储的实例，而不会插入任何新的嵌入。需要以url、username和password的形式提供Neo4j凭据，以及可选的database参数和index_name定义。

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]#

返回从文本和嵌入初始化的Neo4jVector。需要以url、username、password和可选的database参数形式提供Neo4j凭据。

Parameters:

文本 (列表[字符串])
embedding (Embeddings)
metadatas (列表[字典] | 无)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
kwargs (Any)

Return type:

Neo4jVector

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

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[Document]

在版本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]#

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

query (str) – 搜索查询文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
filter (dict | None) –
对元数据属性进行过滤，例如： {

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

}
kwargs (Any)

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[文档]

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]#

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

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

使用重试和指数退避查询Neo4j数据库。

Parameters:

query (str) – 要执行的Cypher查询。
params (dict, optional) – 查询参数字典。默认为 {}。

Returns:

包含查询结果的字典列表。

Return type:

列表[字典[字符串, 任意类型]]

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

检查全文索引是否存在于Neo4j数据库中

此方法查询Neo4j数据库中具有指定名称的现有fts索引。

Returns:: 关键词索引信息
Return type:: (元组)
Parameters:: text_node_properties (List[str])

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

检查向量索引是否存在于Neo4j数据库中并返回其嵌入维度。

此方法查询Neo4j数据库中现有的索引，并尝试检索具有指定名称的向量索引的维度。如果索引存在，则返回其维度。如果索引不存在，则返回None。

Returns:: 如果找到现有索引的嵌入维度。
Return type:: 整数或无

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

使用指定的搜索类型返回与查询最相似的文档。

Parameters:

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

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

使用Neo4jVector运行相似性搜索。

Parameters:

query (str) – 要搜索的查询文本。
k (int) – 返回的结果数量。默认为4。
params (Dict[str, Any]) – 索引类型的搜索参数。默认为空字典。
filter (可选[Dict[str, Any]]) –

用于过滤元数据的参数字典
过滤元数据。

默认为 None。
effective_search_ratio (int) – 通过乘以$k来控制候选池的大小，以平衡查询准确性和性能。默认值为1。
kwargs (Any)

Returns:

与查询最相似的文档列表。

Return type:

列表[文档]

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

返回与嵌入向量最相似的文档。

Parameters:

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
filter (可选[Dict[str, Any]]) –

参数的字典
用于过滤元数据。

默认为 None。
params (Dict[str, Any]) – 索引类型的搜索参数。默认为空字典。
effective_search_ratio (int)
kwargs (Any)

Returns:

与查询向量最相似的文档列表。

Return type:

列表[文档]

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

返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) –
传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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

返回与查询最相似的文档。

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
params (Dict[str, Any]) – 索引类型的搜索参数。默认为空字典。
filter (可选[Dict[str, Any]]) –

用于过滤元数据的参数字典
过滤元数据。

默认为 None。
effective_search_ratio (int) – 通过乘以$k来控制候选池的大小，以平衡查询准确性和性能。默认值为1。
kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数]]

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

在Neo4j数据库中使用给定的向量执行相似性搜索，并返回前k个相似文档及其分数。

此方法使用Cypher查询来查找与给定嵌入最相似的前k个文档。相似度是通过Neo4j数据库中的向量索引来衡量的。结果以元组列表的形式返回，每个元组包含一个Document对象及其相似度分数。

Parameters:

embedding (List[float]) – 用于比较的嵌入向量。
k (int, optional) – 要检索的相似文档的数量。
filter (可选[Dict[str, Any]]) –

参数的字典
用于过滤元数据。

默认为 None。
params (Dict[str, Any]) – 索引类型的搜索参数。默认为空字典。
effective_search_ratio (int) – 通过乘以$k来控制候选池的大小，以平衡查询准确性和性能。默认值为1。
kwargs (Any)

Returns:

一个元组列表，每个元组包含: 一个Document对象及其相似度分数。

Return type:

列表[元组[Document, 浮点数]]

verify_version() → None[source]#

检查连接的Neo4j数据库版本是否支持向量索引。

查询Neo4j数据库以检索其版本，并将其与已知支持向量索引的目标版本（5.11.0）进行比较。如果连接的Neo4j版本不受支持，则引发ValueError。

Return type:: 无

使用 Neo4jVector 的示例