Skip to main content
Open In ColabOpen on GitHub

Astra DB 向量存储

本页面提供了使用Astra DB作为向量存储的快速入门指南。

DataStax Astra DB 是一个基于 Apache Cassandra® 构建的无服务器向量数据库,通过易于使用的 JSON API 方便地提供。

设置

使用集成需要langchain-astradb合作伙伴包:

pip install -qU "langchain-astradb>=0.3.3"

凭证

为了使用AstraDB向量存储,您首先需要访问AstraDB网站,创建一个账户,然后创建一个新的数据库 - 初始化可能需要几分钟。

一旦数据库初始化完成,您应该创建一个应用程序令牌并保存以备后续使用。

您还需要从Database Details中复制API Endpoint并将其存储在ASTRA_DB_API_ENDPOINT变量中。

您可以选择提供一个命名空间,您可以从数据库仪表板的Data Explorer选项卡进行管理。如果您不希望设置命名空间,可以将getpass提示符中的ASTRA_DB_NAMESPACE留空。

import getpass

ASTRA_DB_API_ENDPOINT = getpass.getpass("ASTRA_DB_API_ENDPOINT = ")
ASTRA_DB_APPLICATION_TOKEN = getpass.getpass("ASTRA_DB_APPLICATION_TOKEN = ")

desired_namespace = getpass.getpass("ASTRA_DB_NAMESPACE = ")
if desired_namespace:
ASTRA_DB_NAMESPACE = desired_namespace
else:
ASTRA_DB_NAMESPACE = None

如果你想获得最佳的模型调用自动追踪功能,你也可以通过取消下面的注释来设置你的LangSmith API密钥:

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

初始化

有两种方法可以创建Astra DB向量存储,它们的区别在于嵌入的计算方式。

方法1:显式嵌入

你可以单独实例化一个langchain_core.embeddings.Embeddings类并将其传递给AstraDBVectorStore构造函数,就像大多数其他LangChain向量存储一样。

方法2:集成嵌入计算

或者,您可以使用Astra DB的Vectorize功能,并在创建存储时简单地指定支持的嵌入模型的名称。嵌入计算完全在数据库内处理。(要使用此方法,您必须已为您的数据库启用了所需的嵌入集成,如文档中所述。)

显式嵌入初始化

下面,我们使用显式的嵌入类实例化我们的向量存储:

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_astradb import AstraDBVectorStore

vector_store = AstraDBVectorStore(
collection_name="astra_vector_langchain",
embedding=embeddings,
api_endpoint=ASTRA_DB_API_ENDPOINT,
token=ASTRA_DB_APPLICATION_TOKEN,
namespace=ASTRA_DB_NAMESPACE,
)
API Reference:AstraDBVectorStore

集成嵌入初始化

这里假设你已经

  • 在您的Astra DB组织中启用了OpenAI集成,
  • 在集成中添加了一个名为"OPENAI_API_KEY"的API密钥,并将其范围限定为您正在使用的数据库。

有关如何执行此操作的更多详细信息,请查阅文档

from astrapy.info import CollectionVectorServiceOptions

openai_vectorize_options = CollectionVectorServiceOptions(
provider="openai",
model_name="text-embedding-3-small",
authentication={
"providerKey": "OPENAI_API_KEY",
},
)

vector_store_integrated = AstraDBVectorStore(
collection_name="astra_vector_langchain_integrated",
api_endpoint=ASTRA_DB_API_ENDPOINT,
token=ASTRA_DB_APPLICATION_TOKEN,
namespace=ASTRA_DB_NAMESPACE,
collection_vector_service_options=openai_vectorize_options,
)

管理向量存储

一旦你创建了你的向量存储,我们可以通过添加和删除不同的项目来与之交互。

添加项目到向量存储

我们可以使用add_documents函数向我们的向量存储中添加项目。

from uuid import uuid4

from langchain_core.documents import Document

document_1 = Document(
page_content="I had chocalate 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 Reference:Document
[UUID('89a5cea1-5f3d-47c1-89dc-7e36e12cf4de'),
UUID('d4e78c48-f954-4612-8a38-af22923ba23b'),
UUID('058e4046-ded0-4fc1-b8ac-60e5a5f08ea0'),
UUID('50ab2a9a-762c-4b78-b102-942a86d77288'),
UUID('1da5a3c1-ba51-4f2f-aaaf-79a8f5011ce3'),
UUID('f3055d9e-2eb1-4d25-838e-2c70548f91b5'),
UUID('4bf0613d-08d0-4fbc-a43c-4955e4c9e616'),
UUID('18008625-8fd4-45c2-a0d7-92a2cde23dbc'),
UUID('c712e06f-790b-4fd4-9040-7ab3898965d0'),
UUID('a9b84820-3445-4810-a46c-e77b76ab85bc')]

从向量存储中删除项目

我们可以通过使用delete函数按ID从向量存储中删除项目。

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

查询向量存储

一旦您的向量存储已创建并且相关文档已添加,您很可能希望在链或代理运行期间查询它。

直接查询

执行一个简单的相似性搜索并过滤元数据可以如下进行:

results = vector_store.similarity_search(
"LangChain provides abstractions to make working with LLMs easy",
k=2,
filter={"source": "tweet"},
)
for res in results:
print(f"* {res.page_content} [{res.metadata}]")
* Building an exciting new project with LangChain - come check it out! [{'source': 'tweet'}]
* LangGraph is the best framework for building stateful, agentic applications! [{'source': 'tweet'}]

带分数的相似性搜索

你也可以使用分数进行搜索:

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

其他搜索方法

本笔记本未涵盖其他多种搜索方法,例如MMR搜索或通过向量搜索。有关AstraDBVectorStore可用的搜索功能的完整列表,请查看API参考

通过转换为检索器进行查询

你也可以将向量存储转换为检索器,以便在你的链中更轻松地使用。

以下是如何将您的向量存储转换为检索器,然后使用简单的查询和过滤器调用检索器。

retriever = vector_store.as_retriever(
search_type="similarity_score_threshold",
search_kwargs={"k": 1, "score_threshold": 0.5},
)
retriever.invoke("Stealing from the bank is a crime", filter={"source": "news"})
[Document(metadata={'source': 'news'}, page_content='Robbers broke into the city bank and stole $1 million in cash.')]

检索增强生成的使用

有关如何使用此向量存储进行检索增强生成(RAG)的指南,请参阅以下部分:

更多信息,请查看使用Astra DB的完整RAG模板这里

清理向量存储

如果你想从你的Astra DB实例中完全删除集合,请运行这个。

(您将丢失其中存储的数据。)

vector_store.delete_collection()

API 参考

有关所有AstraDBVectorStore功能和配置的详细文档,请访问API参考:https://python.langchain.com/api_reference/astradb/vectorstores/langchain_astradb.vectorstores.AstraDBVectorStore.html


这个页面有帮助吗?