Annoy#

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

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, ids])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas])

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

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)

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

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)

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

Parameters:
  • 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])[来源]#

使用必要的组件进行初始化。

Parameters:
  • 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]#

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

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_texts(texts: Iterable[str], metadatas: List[dict] | None = None, **kwargs: Any) List[str][source]#

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

Parameters:
  • texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

  • metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。

  • ids – 与文本关联的可选ID列表。

  • **kwargs (Any) – 向量存储特定参数。 其中一个 kwargs 应该是 ids,这是一个与文本相关联的 ID 列表。

Returns:

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

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

  • ValueError – 如果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中添加。

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

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

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]

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

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, 浮点数]]

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, **kwargs: Any) VST#

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

Parameters:
  • documents (list[Document]) – 要添加到向量存储中的文档列表。

  • embedding (Embeddings) – 使用的嵌入函数。

  • kwargs (Any) – 额外的关键字参数。

Returns:

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

Return type:

VectorStore

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

从嵌入构建Annoy包装器。

Parameters:
  • text_embeddings (List[Tuple[str, List[float]]]) – (文本, 嵌入) 的元组列表

  • embedding (Embeddings) – 使用的嵌入函数。

  • metadatas (List[dict] | None) – 与文档关联的元数据字典列表。

  • metric (str) – 用于索引的度量标准。默认为“angular”。

  • trees (int) – 用于索引的树的数量。默认为100。

  • n_jobs (int) – 用于索引的作业数量。默认为 -1

  • kwargs (Any)

Return type:

Annoy

This is a user friendly interface that:
  1. 使用提供的嵌入创建一个内存中的文档存储

  2. 初始化 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: List[dict] | None = None, metric: str = 'angular', trees: int = 100, n_jobs: int = -1, **kwargs: Any) Annoy[来源]#

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

Parameters:
  • texts (List[str]) – 要索引的文档列表。

  • embedding (Embeddings) – 使用的嵌入函数。

  • metadatas (List[dict] | None) – 与文档关联的元数据字典列表。

  • metric (str) – 用于索引的度量标准。默认为“angular”。

  • trees (int) – 用于索引的树的数量。默认为100。

  • n_jobs (int) – 用于索引的作业数量。默认为-1。

  • kwargs (Any)

Return type:

Annoy

This is a user friendly interface that:
  1. 嵌入文档。

  2. 创建一个内存中的文档存储

  3. 初始化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的文档,此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

classmethod load_local(folder_path: str, embeddings: Embeddings, *, allow_dangerous_deserialization: bool = False) Annoy[来源]#

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

Parameters:
  • folder_path (str) – 用于加载索引、文档存储和index_to_docstore_id的文件夹路径。

  • embeddings (Embeddings) – 生成查询时使用的嵌入。

  • allow_dangerous_deserialization (bool) – 是否允许反序列化涉及加载pickle文件的数据。Pickle文件可以被恶意行为者修改,以传递恶意负载,导致在您的机器上执行任意代码。

Return type:

Annoy

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

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

Parameters:
  • query (str) – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • fetch_k (int) – 要获取并传递给MMR算法的文档数量。

  • lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。

  • 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][source]#

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

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

Parameters:
  • embedding (List[float]) – 用于查找相似文档的嵌入。

  • fetch_k (int) – 要获取并传递给MMR算法的文档数量。

  • k (int) – 返回的文档数量。默认为4。

  • lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。

  • kwargs (Any)

Returns:

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

Return type:

列表[文档]

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

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

Parameters:
  • idxs (List[int]) – 索引中文档的索引列表。

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

Returns:

文档和分数列表。

Return type:

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

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

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

Parameters:
  • folder_path (str) – 保存索引、文档存储和索引到文档存储ID的文件夹路径。

  • prefault (bool) – 是否预加载索引到内存中。

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]

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

Parameters:
  • query (str) – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • search_k (int) – 检查最多 search_k 个节点,默认值为 n_trees * n(如果未提供)

  • kwargs (Any)

Returns:

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

Return type:

列表[文档]

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

返回与docstore_index最相似的文档。

Parameters:
  • docstore_index (int) – 文档在docstore中的索引

  • k (int) – 返回的文档数量。默认为4。

  • search_k (int) – 检查最多 search_k 个节点,默认值为 n_trees * n(如果未提供)

  • kwargs (Any)

Returns:

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

Return type:

列表[文档]

similarity_search_by_vector(embedding: List[float], k: int = 4, search_k: int = -1, **kwargs: Any) List[Document][来源]#

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

Parameters:
  • embedding (List[float]) – 用于查找相似文档的嵌入。

  • k (int) – 返回的文档数量。默认为4。

  • search_k (int) – 检查最多 search_k 个节点,默认值为 n_trees * n(如果未提供)

  • 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, search_k: int = -1) List[Tuple[Document, float]][source]#

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

Parameters:
  • query (str) – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • search_k (int) – 检查最多 search_k 个节点,默认值为 n_trees * n(如果未提供)

Returns:

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

Return type:

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

similarity_search_with_score_by_index(docstore_index: int, k: int = 4, search_k: int = -1) List[Tuple[Document, float]][来源]#

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

Parameters:
  • query – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • search_k (int) – 检查最多 search_k 个节点,默认值为 n_trees * n(如果未提供)

  • docstore_index (int)

Returns:

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

Return type:

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

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

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

Parameters:
  • query – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • search_k (int) – 检查最多 search_k 个节点,默认值为 n_trees * n(如果未提供)

  • embedding (列表[浮点数])

Returns:

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

Return type:

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

使用Annoy的示例