Skip to main content
Open In Colab在 GitHub 上打开

MongoDB Atlas

本笔记本介绍如何在 LangChain 中使用langchain-mongodb包。

MongoDB Atlas 是一个完全托管的云数据库，可在 AWS、Azure 和 GCP 中使用。它支持对 MongoDB 文档数据进行本机矢量搜索、全文搜索 （BM25） 和混合搜索。

MongoDB Atlas Vector Search 允许您将嵌入存储在 MongoDB 文档中，创建向量搜索索引，并使用近似最近邻算法 （Hierarchical Navigable Small Worlds).它使用 $vectorSearch MQL Stage。

设置

*运行 MongoDB 版本 6.0.11、7.0.2 或更高版本（包括 RC）的 Atlas 集群。

要使用 MongoDB Atlas，您必须先部署一个集群。我们在您选择的云上提供永久免费的集群层。要开始使用，请在此处前往 Atlas：快速入门。

您需要安装langchain-mongodb和pymongo以使用此集成。

pip install -qU langchain-mongodb pymongo

凭据

对于此笔记本，您需要查找 MongoDB 集群 URI。

有关查找集群 URI 的信息，请通读本指南。

import getpass

MONGODB_ATLAS_CLUSTER_URI = getpass.getpass("MongoDB Atlas Cluster URI:")

如果您想获得一流的模型调用自动跟踪，您还可以通过取消下面的注释来设置 LangSmith API 密钥：

# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"

初始化

pip install -qU langchain-openai
import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
  os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(model="text-embedding-3-large")
from langchain_mongodb import MongoDBAtlasVectorSearch
from pymongo import MongoClient

# initialize MongoDB python client
client = MongoClient(MONGODB_ATLAS_CLUSTER_URI)

DB_NAME = "langchain_test_db"
COLLECTION_NAME = "langchain_test_vectorstores"
ATLAS_VECTOR_SEARCH_INDEX_NAME = "langchain-test-index-vectorstores"

MONGODB_COLLECTION = client[DB_NAME][COLLECTION_NAME]

vector_store = MongoDBAtlasVectorSearch(
    collection=MONGODB_COLLECTION,
    embedding=embeddings,
    index_name=ATLAS_VECTOR_SEARCH_INDEX_NAME,
    relevance_score_fn="cosine",
)

# Create vector search index on the collection
# Since we are using the default OpenAI embedding model (ada-v2) we need to specify the dimensions as 1536
vector_store.create_vector_search_index(dimensions=1536)

[可选]替代vector_store.create_vector_search_index命令中，您还可以使用 Atlas UI 创建向量搜索索引，索引定义如下：

{
  "fields":[
    {
      "type": "vector",
      "path": "embedding",
      "numDimensions": 1536,
      "similarity": "cosine"
    }
  ]
}

管理矢量存储

创建 vector store 后，我们可以通过添加和删除不同的项目来与之交互。

将项目添加到向量存储

我们可以使用add_documents功能。

from uuid import uuid4

from langchain_core.documents import Document

document_1 = Document(
    page_content="I had chocolate chip pancakes and scrambled eggs for breakfast this morning.",
    metadata={"source": "tweet"},
)

document_2 = Document(
    page_content="The weather forecast for tomorrow is cloudy and overcast, with a high of 62 degrees.",
    metadata={"source": "news"},
)

document_3 = Document(
    page_content="Building an exciting new project with LangChain - come check it out!",
    metadata={"source": "tweet"},
)

document_4 = Document(
    page_content="Robbers broke into the city bank and stole $1 million in cash.",
    metadata={"source": "news"},
)

document_5 = Document(
    page_content="Wow! That was an amazing movie. I can't wait to see it again.",
    metadata={"source": "tweet"},
)

document_6 = Document(
    page_content="Is the new iPhone worth the price? Read this review to find out.",
    metadata={"source": "website"},
)

document_7 = Document(
    page_content="The top 10 soccer players in the world right now.",
    metadata={"source": "website"},
)

document_8 = Document(
    page_content="LangGraph is the best framework for building stateful, agentic applications!",
    metadata={"source": "tweet"},
)

document_9 = Document(
    page_content="The stock market is down 500 points today due to fears of a recession.",
    metadata={"source": "news"},
)

document_10 = Document(
    page_content="I have a bad feeling I am going to get deleted :(",
    metadata={"source": "tweet"},
)

documents = [
    document_1,
    document_2,
    document_3,
    document_4,
    document_5,
    document_6,
    document_7,
    document_8,
    document_9,
    document_10,
]
uuids = [str(uuid4()) for _ in range(len(documents))]

vector_store.add_documents(documents=documents, ids=uuids)
API 参考：文档
['03ad81e8-32a0-46f0-b7d8-f5b977a6b52a',
 '8396a68d-f4a3-4176-a581-a1a8c303eea4',
 'e7d95150-67f6-499f-b611-84367c50fa60',
 '8c31b84e-2636-48b6-8b99-9fccb47f7051',
 'aa02e8a2-a811-446a-9785-8cea0faba7a9',
 '19bd72ff-9766-4c3b-b1fd-195c732c562b',
 '642d6f2f-3e34-4efa-a1ed-c4ba4ef0da8d',
 '7614bb54-4eb5-4b3b-990c-00e35cb31f99',
 '69e18c67-bf1b-43e5-8a6e-64fb3f240e52',
 '30d599a7-4a1a-47a9-bbf8-6ed393e2e33c']

从 vector store 中删除项目

vector_store.delete(ids=[uuids[-1]])
True

查询向量存储

创建矢量存储并添加相关文档后，您很可能希望在链或代理运行期间对其进行查询。

直接查询

可以按如下方式执行简单的相似性搜索：

results = vector_store.similarity_search(
    "LangChain provides abstractions to make working with LLMs easy", k=2
)
for res in results:
    print(f"* {res.page_content} [{res.metadata}]")
* Building an exciting new project with LangChain - come check it out! [{'_id': 'e7d95150-67f6-499f-b611-84367c50fa60', 'source': 'tweet'}]
* LangGraph is the best framework for building stateful, agentic applications! [{'_id': '7614bb54-4eb5-4b3b-990c-00e35cb31f99', 'source': 'tweet'}]

带分数的相似性搜索

您还可以使用 score 进行搜索：

results = vector_store.similarity_search_with_score("Will it be hot tomorrow?", k=1)
for res, score in results:
    print(f"* [SIM={score:3f}] {res.page_content} [{res.metadata}]")
* [SIM=0.784560] The weather forecast for tomorrow is cloudy and overcast, with a high of 62 degrees. [{'_id': '8396a68d-f4a3-4176-a581-a1a8c303eea4', 'source': 'news'}]

Atlas Vector Search 支持使用 MQL 运算符进行预筛选。以下是对上面加载的相同数据的索引和查询示例，它允许您对 “page” 字段进行元数据筛选。您可以使用定义的过滤器更新现有索引，并使用矢量搜索进行预过滤。

要启用预筛选，您需要更新索引定义以包含筛选条件字段。在此示例中，我们将使用sourcefield （字段） 作为 filter 字段。

这可以使用MongoDBAtlasVectorSearch.create_vector_search_index方法。

vectorstore.create_vector_search_index(
  dimensions=1536,
  filters=[{"type":"filter", "path":"source"}],
  update=True
)

或者，您也可以使用具有以下索引定义的 Atlas UI 更新索引：

{
  "fields":[
    {
      "type": "vector",
      "path": "embedding",
      "numDimensions": 1536,
      "similarity": "cosine"
    },
    {
      "type": "filter",
      "path": "source"
    }
  ]
}

然后，您可以使用 filter 运行查询，如下所示：

results = vector_store.similarity_search(query="foo", k=1, pre_filter={"source": {"$eq": "https://example.com"}})
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

其他搜索方法

本笔记本中未涵盖各种其他搜索方法，例如 MMR 搜索或按向量搜索。有关可用于MongoDBAtlasVectorStore请查看 API 参考。

通过转换为 retriever 进行查询

您还可以将 vector store 转换为检索器，以便在您的链中更轻松地使用。

下面介绍如何将 vector store 转换为 retriever，然后使用简单的查询和过滤器调用 retreiever。

retriever = vector_store.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={"k": 1, "score_threshold": 0.2},
)
retriever.invoke("Stealing from the bank is a crime")
[Document(metadata={'_id': '8c31b84e-2636-48b6-8b99-9fccb47f7051', 'source': 'news'}, page_content='Robbers broke into the city bank and stole $1 million in cash.')]

用于检索增强生成

有关如何使用此向量存储进行检索增强生成 （RAG） 的指南，请参阅以下部分：

其他说明

  • 更多文档可以在 MongoDB 的 LangChain Docs 站点上找到
  • 此功能已正式发布，可用于生产部署。
  • langchain 版本 0.0.305（发行说明）引入了对 $vectorSearch MQL 阶段的支持，该阶段在 MongoDB Atlas 6.0.11 和 7.0.2 中提供。使用早期版本的 MongoDB Atlas 的用户需要将其 LangChain 版本固定到 <=0.0.304

API 参考

有关所有MongoDBAtlasVectorSearch功能和配置可参考 API 参考：https://python.langchain.com/api_reference/mongodb/index.html