`langchain_community.vectorstores.annoy`.Annoy¶

class langchain_community.vectorstores.annoy.Annoy(embedding_function: Callable, index: Any, metric: str, docstore: Docstore, index_to_docstore_id: Dict[int, str])[source]¶

Annoy 向量存储。

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

示例

from langchain_community.vectorstores import Annoy
db = Annoy(embedding_function, index, docstore, index_to_docstore_id)

使用必要的组件初始化。

属性

embeddings

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

方法

`__init__`(embedding_function, index, metric, ...)	使用必要的组件初始化。
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步运行更多文本通过嵌入并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas])	运行更多文本通过嵌入并添加到向量存储。
`adelete`([ids])	异步按向量 ID 或其他条件删除。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的 VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	异步返回从文本和嵌入初始化的 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)	异步运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)
`delete`([ids])	按向量 ID 或其他条件删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_embeddings`(text_embeddings, embedding)	从嵌入构建 Annoy 包装器。
`from_texts`(texts, embedding[, metadatas, ...])	从原始文档构建 Annoy 包装器。
`get_by_ids`(ids, /)	按 ID 获取文档。
`load_local`(folder_path, embeddings, *[, ...])	将 Annoy 索引、文档存储和 index_to_docstore_id 加载到磁盘。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`process_index_results`(idxs, dists)	将 Annoy 结果转换为文档和分数的列表。
`save_local`(folder_path[, prefault])	将 Annoy 索引、文档存储和 index_to_docstore_id 保存到磁盘。
`search`(query, search_type, **kwargs)	返回与使用指定搜索类型查询最相似的文档。
`similarity_search`(query[, k, search_k])	返回与查询最相似的文档。
`similarity_search_by_index`(docstore_index[, ...])	返回与 docstore_index 最相似的文档。
`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_index`(...[, ...])	返回与查询最相似的文档。
`similarity_search_with_score_by_vector`(embedding)	返回与查询最相似的文档。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

参数

embedding_function (Callable) –
index (Any) –
metric (str) –
docstore (Docstore) –
index_to_docstore_id (Dict[int, str]) –

__init__(embedding_function: Callable, index: Any, metric: str, docstore: Docstore, index_to_docstore_id: Dict[int, str])[source]¶

使用必要的组件初始化。

参数

embedding_function (Callable) –
index (Any) –
metric (str) –
docstore (Docstore) –
index_to_docstore_id (Dict[int, str]) –

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 额外的关键词参数。

返回

添加的文本的 ID 列表。

Raises

ValueError – 如果 ID 的数量与文档的数量不匹配，则引发 ValueError 异常。

Return type

List[str]

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

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

参数

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

返回

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

Raises

ValueError – 如果元数据的数量与文本的数量不匹配，则引发 ValueError 异常。
ValueError – 如果 ID 的数量与文本的数量不匹配，则引发 ValueError 异常。

Return type

List[str]

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

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

参数

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

返回

添加的文本的 ID 列表。

Raises

ValueError – 如果 ID 的数量与文档的数量不匹配，则引发 ValueError 异常。

Return type

List[str]

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串迭代器。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
**kwargs (Any) – 向量存储特定的参数。kwargs 之一应该是 ids，它是与文本关联的 id 列表。

返回

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

Raises

ValueError – 如果元数据的数量与文本的数量不匹配，则引发 ValueError 异常。
ValueError – 如果 ID 的数量与文本的数量不匹配，则引发 ValueError 异常。

Return type

List[str]

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

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

参数

ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None，则删除全部。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键词参数。

返回

如果删除成功，则返回 True，否则返回 False，如果未实现，则返回 None。

Return type

Optional[bool]

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

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

参数

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

返回

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

Return type

VectorStore

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

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

参数

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

返回

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

Return type

VectorStore

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

异步按 ID 获取文档。

返回的文档应将 ID 字段设置为文档在向量存储中的 ID。

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

用户不应假设返回文档的顺序与输入 ID 的顺序一致。用户应以返回文档的 ID 字段为准。

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
Return type: List[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]¶

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

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

参数

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

返回

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

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

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

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

参数

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

返回

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

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从该 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括：search_type (Optional[str]): 定义

Retriever 应执行的搜索类型。可以是 “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: 按文档元数据筛选

返回

VectorStore 的 Retriever 类。

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

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

参数

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

返回

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

Raises

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

Return type

List[Document]

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

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

参数

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

返回

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

Return type

List[Document]

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

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

参数

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

返回

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

Return type

List[Document]

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

异步返回 [0, 1] 范围内的文档和相关性分数。

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

参数

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

筛选检索到的文档结果集

返回

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

Return type

List[Tuple[Document, float]]

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

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

参数

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

返回

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

Return type

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta 版本

0.2.11 版本新增。API 可能会发生变化。

以流式方式 Upsert 文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的 Document 的可迭代对象。
batch_size (int) – 每次批量 upsert 的大小。
kwargs (Any) – 额外的关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引的超时时间、重试策略等）kwargs 不应包含 ID，以避免语义不明确。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

AsyncIterator[UpsertResponse]

0.2.11 版本新增。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta 版本

0.2.11 版本新增。API 可能会发生变化。

在向量存储中添加或更新文档。upsert 的异步版本。

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的 Document 序列。
kwargs (Any) – 额外的关键词参数。

返回

一个响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

UpsertResponse

0.2.11 版本新增。

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

按向量 ID 或其他条件删除。

参数

ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None，则删除全部。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键词参数。

返回

如果删除成功，则返回 True，否则返回 False，如果未实现，则返回 None。

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

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

参数

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

返回

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

Return type

VectorStore

classmethod from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: Optional[List[dict]] = None, metric: str = 'angular', trees: int = 100, n_jobs: int = -1, **kwargs: Any) → Annoy[source]¶

从嵌入构建 Annoy 包装器。

参数

text_embeddings (List[Tuple[str, List[float]]]) – (文本, 嵌入向量) 元组的列表
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 要与文档关联的元数据字典列表。
metric (str) – 用于索引的度量标准。默认为 “angular”。
trees (int) – 用于索引的树的数量。默认为 100。
n_jobs (int) – 用于索引的作业数量。默认为 -1
kwargs (Any) –

Return type

Annoy

这是一个用户友好的界面，它

使用提供的嵌入向量创建内存文档存储
初始化 Annoy 数据库

旨在提供一种快速入门的方式。

示例

from langchain_community.vectorstores import Annoy
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
db = Annoy.from_embeddings(text_embedding_pairs, embeddings)

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, metric: str = 'angular', trees: int = 100, n_jobs: int = -1, **kwargs: Any) → Annoy[source]¶

从原始文档构建 Annoy 包装器。

参数

texts (List[str]) – 要索引的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 要与文档关联的元数据字典列表。
metric (str) – 用于索引的度量标准。默认为 “angular”。
trees (int) – 用于索引的树的数量。默认为 100。
n_jobs (int) – 用于索引的作业数量。默认为 -1。
kwargs (Any) –

Return type

Annoy

这是一个用户友好的界面，它

嵌入文档。
创建内存文档存储
初始化 Annoy 数据库

旨在提供一种快速入门的方式。

示例

from langchain_community.vectorstores import Annoy
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
index = Annoy.from_texts(texts, embeddings)

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

按 ID 获取文档。

返回的文档应将 ID 字段设置为文档在向量存储中的 ID。

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

用户不应假设返回文档的顺序与输入 ID 的顺序一致。用户应以返回文档的 ID 字段为准。

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
Return type: List[Document]

0.2.11 版本新增。

classmethod load_local(folder_path: str, embeddings: Embeddings, *, allow_dangerous_deserialization: bool = False) → Annoy[source]¶

将 Annoy 索引、文档存储和 index_to_docstore_id 加载到磁盘。

参数

folder_path (str) – 从中加载索引、文档存储和 index_to_docstore_id 的文件夹路径。
embeddings (Embeddings) – 生成查询时使用的嵌入。
allow_dangerous_deserialization (bool) – 是否允许反序列化数据，其中涉及加载 pickle 文件。 Pickle 文件可能被恶意行为者修改，以传递恶意负载，从而导致在您的机器上执行任意代码。

Return type

Annoy

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

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

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

参数

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

返回

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

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][source]¶

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

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

参数

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

返回

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

Return type

List[Document]

process_index_results(idxs: List[int], dists: List[float]) → List[Tuple[Document, float]][source]¶

将 Annoy 结果转换为文档和分数的列表。

参数

idxs (List[int]) – 索引中文档的索引列表。
dists (List[float]) – 索引中文档的距离列表。

返回

文档和分数的列表。

Return type

List[Tuple[Document, float]]

save_local(folder_path: str, prefault: bool = False) → None[source]¶

将 Annoy 索引、文档存储和 index_to_docstore_id 保存到磁盘。

参数

folder_path (str) – 用于保存索引、文档存储和 index_to_docstore_id 的文件夹路径。
prefault (bool) – 是否预加载索引到内存中。

Return type

None

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

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

参数

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

返回

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

Raises

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

Return type

List[Document]

similarity_search(query: str, k: int = 4, search_k: int = -1, **kwargs: Any) → List[Document][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
search_k (int) – 检查最多 search_k 个节点，如果未提供，则默认为 n_trees * n
kwargs (Any) –

返回

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

Return type

List[Document]

similarity_search_by_index(docstore_index: int, k: int = 4, search_k: int = -1, **kwargs: Any) → List[Document][source]¶

返回与 docstore_index 最相似的文档。

参数

docstore_index (int) – 文档存储中文档的索引
k (int) – 要返回的文档数量。默认为 4。
search_k (int) – 检查最多 search_k 个节点，如果未提供，则默认为 n_trees * n
kwargs (Any) –

返回

与嵌入向量最相似的文档列表。

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, search_k: int = -1, **kwargs: Any) → List[Document][source]¶

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
search_k (int) – 检查最多 search_k 个节点，如果未提供，则默认为 n_trees * n
kwargs (Any) –

返回

与嵌入向量最相似的文档列表。

Return type

List[Document]

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

返回 [0, 1] 范围内的文档和相关性分数。

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

参数

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

过滤检索到的文档结果集。

返回

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

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, search_k: int = -1) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
search_k (int) – 检查最多 search_k 个节点，如果未提供，则默认为 n_trees * n

返回

与查询最相似的文档及其各自得分的列表

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_index(docstore_index: int, k: int = 4, search_k: int = -1) → List[Tuple[Document, float]][source]¶

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

参数

query – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
search_k (int) – 检查最多 search_k 个节点，如果未提供，则默认为 n_trees * n
docstore_index (int) –

返回

与查询最相似的文档及其各自得分的列表

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, search_k: int = -1) → List[Tuple[Document, float]][source]¶

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

参数

query – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
search_k (int) – 检查最多 search_k 个节点，如果未提供，则默认为 n_trees * n
embedding (List[float]) –

返回

与查询最相似的文档及其各自得分的列表

Return type

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

Beta 版本

0.2.11 版本新增。API 可能会发生变化。

以流式方式更新文档。

参数

items (Iterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次批量 upsert 的大小。
kwargs (Any) – 附加的关键字参数。kwargs 应该只包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 id，以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

Iterator[UpsertResponse]

0.2.11 版本新增。

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta 版本

0.2.11 版本新增。API 可能会发生变化。

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

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的 Document 序列。
kwargs (Any) – 额外的关键词参数。

返回

一个响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

UpsertResponse

0.2.11 版本新增。

Annoy 使用示例¶

Annoy

langchain_community.vectorstores.annoy.Annoy¶

Annoy 使用示例¶

`langchain_community.vectorstores.annoy`.Annoy¶