`langchain_community.vectorstores.mongodb_atlas`.MongoDBAtlasVectorSearch¶

class langchain_community.vectorstores.mongodb_atlas.MongoDBAtlasVectorSearch(collection: Collection[MongoDBDocumentType], embedding: Embeddings, *, index_name: str = 'default', text_key: str = 'text', embedding_key: str = 'embedding', relevance_score_fn: str = 'cosine')[source]¶

Deprecated since version 0.0.25: 使用 langchain_mongodb.MongoDBAtlasVectorSearch 代替。

MongoDB Atlas Vector Search 向量存储。

要使用，您应该同时具备： - 已安装 pymongo python 包 - 与已部署的 MongoDB Atlas 集群关联的连接字符串

Atlas Search 索引

示例

from langchain_community.vectorstores import MongoDBAtlasVectorSearch
from langchain_community.embeddings.openai import OpenAIEmbeddings
from pymongo import MongoClient

mongo_client = MongoClient("<YOUR-CONNECTION-STRING>")
collection = mongo_client["<db_name>"]["<collection_name>"]
embeddings = OpenAIEmbeddings()
vectorstore = MongoDBAtlasVectorSearch(collection, embeddings)

参数

collection (Collection[MongoDBDocumentType]) – 要将文本添加到的 MongoDB 集合。
embedding (Embeddings) – 要使用的文本嵌入模型。
text_key (str) – 将包含每个文档文本的 MongoDB 字段。
embedding_key (str) – 将包含每个文档嵌入向量的 MongoDB 字段。
index_name (str) – Atlas Search 索引的名称。
relevance_score_fn (str) – 用于索引的相似度评分。
supported (Currently) – 欧几里得距离，余弦相似度和点积。

属性

embeddings

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

方法

`__init__`(collection, embedding, *[, ...])	参数 collection 要将文本添加到的 MongoDB 集合。
`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_connection_string`(connection_string, ...)	从 MongoDB 连接 URI 构建 MongoDB Atlas Vector Search 向量存储。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	从原始文档构建 MongoDB Atlas Vector Search 向量存储。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回与使用指定搜索类型查询最相似的文档。
`similarity_search`(query[, k, pre_filter, ...])	返回与给定查询最相似的 MongoDB 文档。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回范围在 [0, 1] 内的文档和相关性评分。
`similarity_search_with_score`(query[, k, ...])	返回与给定查询最相似的 MongoDB 文档及其评分。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__init__(collection: Collection[MongoDBDocumentType], embedding: Embeddings, *, index_name: str = 'default', text_key: str = 'text', embedding_key: str = 'embedding', relevance_score_fn: str = 'cosine')[source]¶

参数

collection (Collection[MongoDBDocumentType]) – 要将文本添加到的 MongoDB 集合。
embedding (Embeddings) – 要使用的文本嵌入模型。
text_key (str) – 将包含每个文档文本的 MongoDB 字段。
embedding_key (str) – 将包含每个文档嵌入向量的 MongoDB 字段。
index_name (str) – Atlas Search 索引的名称。
relevance_score_fn (str) – 用于索引的相似度评分。
supported (Currently) – 欧几里得距离，余弦相似度和点积。

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

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

参数

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

返回值

添加文本的 ID 列表。

抛出

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

返回类型

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 列表。

抛出

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

返回类型

List[str]

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

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

参数

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

返回值

添加文本的 ID 列表。

抛出

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

返回类型

List[str]

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串迭代器。
metadatas (Optional[List[Dict[str, Any]]]) – 与文本关联的可选元数据列表。
kwargs (Any) –

返回值

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

返回类型

List

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

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

参数

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

返回值

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

返回类型

Optional[bool]

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

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

参数

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

返回值

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

返回类型

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。

返回类型

VectorStore

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

异步通过 ID 获取文档。

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

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

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

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

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

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

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

参数

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

返回值

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

返回类型

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

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

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

参数

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

返回值

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

返回类型

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括：search_type (Optional[str])：定义检索器应执行的搜索类型。

可以是 “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 类。

返回类型

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) – 传递给搜索方法的参数。

返回值

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

抛出

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

返回类型

List[Document]

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

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

参数

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

返回值

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

返回类型

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) – 传递给搜索方法的参数。

返回值

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

返回类型

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 之间的浮点值，用于过滤检索到的文档集。

过滤检索到的文档集

返回值

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

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回值

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

返回类型

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

产出

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

返回类型

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]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加关键字参数。

返回值

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

返回类型

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。

返回类型

Optional[bool]

classmethod from_connection_string(connection_string: str, namespace: str, embedding: Embeddings, **kwargs: Any) → MongoDBAtlasVectorSearch[source]¶

从 MongoDB 连接 URI 构建 MongoDB Atlas Vector Search 向量存储。

参数

connection_string (str) – 有效的 MongoDB 连接 URI。
namespace (str) – 有效的 MongoDB 命名空间（数据库和集合）。
embedding (Embeddings) – 用于向量存储的文本嵌入模型。
kwargs (Any) –

返回值

一个新的 MongoDBAtlasVectorSearch 实例。

返回类型

MongoDBAtlasVectorSearch

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

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

参数

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

返回值

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

返回类型

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[Dict]] = None, collection: Optional[Collection[MongoDBDocumentType]] = None, **kwargs: Any) → MongoDBAtlasVectorSearch[source]¶

从原始文档构建 MongoDB Atlas Vector Search 向量存储。

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

嵌入文档。
将文档添加到提供的 MongoDB Atlas Vector Search 索引 (Lucene)
（Lucene）

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

示例

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[Dict]]) –
collection (Optional[Collection[MongoDBDocumentType]]) –
kwargs (Any) –

返回类型

MongoDBAtlasVectorSearch

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

通过 ID 获取文档。

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

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

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

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

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

新增于版本 0.2.11。

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

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – （可选）要返回的文档数量。默认为 4。
fetch_k (int) – （可选）在传递给 MMR 算法之前要获取的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
pre_filter (Optional[Dict]) – （可选）用于预过滤文档字段的参数字典。
post_filter_pipeline (Optional[List[Dict]]) – （可选）在 vectorSearch 阶段之后执行的 MongoDB 聚合阶段管道。
kwargs (Any) –

返回值

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

返回类型

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

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

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

参数

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

返回值

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

返回类型

List[Document]

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

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

参数

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

返回值

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

抛出

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

返回类型

List[Document]

similarity_search(query: str, k: int = 4, pre_filter: Optional[Dict] = None, post_filter_pipeline: Optional[List[Dict]] = None, **kwargs: Any) → List[Document][source]¶

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

使用 MongoDB Atlas Search 中提供的 vectorSearch 操作符。更多信息请参考： https://mongodb.ac.cn/docs/atlas/atlas-vector-search/vector-search-stage/

参数

query (str) – 用于查找相似文档的文本。
k (int) – （可选）要返回的文档数量。默认为 4。
pre_filter (Optional[Dict]) – （可选）用于预筛选文档字段的参数字典。
post_filter_pipeline (Optional[List[Dict]]) – （可选）在 vectorSearch 阶段之后执行的 MongoDB 聚合阶段的管道。
kwargs (Any) –

返回值

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

返回类型

List[Document]

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

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

参数

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

返回值

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

返回类型

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 之间的浮点值，用于过滤检索到的文档集。

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

返回值

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

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, pre_filter: Optional[Dict] = None, post_filter_pipeline: Optional[List[Dict]] = None) → List[Tuple[Document, float]][source]¶

返回与给定查询最相似的 MongoDB 文档及其评分。

使用 MongoDB Atlas Search 中提供的 vectorSearch 操作符。更多信息请参考： https://mongodb.ac.cn/docs/atlas/atlas-vector-search/vector-search-stage/

参数

query (str) – 用于查找相似文档的文本。
k (int) – （可选）要返回的文档数量。默认为 4。
pre_filter (Optional[Dict]) – （可选）用于预筛选文档字段的参数字典。
post_filter_pipeline (Optional[List[Dict]]) – （可选）在 vectorSearch 阶段之后执行的 MongoDB 聚合阶段的管道。

返回值

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

返回类型

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 对象的一部分提供。

产出

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

返回类型

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]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加关键字参数。

返回值

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

返回类型

UpsertResponse

新增于版本 0.2.11。

使用 MongoDBAtlasVectorSearch 的示例¶

MongoDB Atlas

langchain_community.vectorstores.mongodb_atlas.MongoDBAtlasVectorSearch¶

使用 MongoDBAtlasVectorSearch 的示例¶

`langchain_community.vectorstores.mongodb_atlas`.MongoDBAtlasVectorSearch¶