Apache Cassandra
本页面提供了使用Apache Cassandra®作为向量存储的快速入门指南。
Cassandra 是一个面向行的、高度可扩展且高度可用的NoSQL数据库。从5.0版本开始,该数据库提供了向量搜索功能。
注意:除了访问数据库外,运行完整示例还需要一个OpenAI API密钥。
设置和一般依赖
使用集成需要以下Python包。
%pip install --upgrade --quiet langchain-community "cassio>=0.1.4"
注意:根据您的LangChain设置,您可能需要安装/升级此演示所需的其他依赖项
(特别是需要最新版本的datasets
、openai
、pypdf
和tiktoken
,以及langchain-community
)。
import os
from getpass import getpass
from datasets import (
load_dataset,
)
from langchain_community.document_loaders import PyPDFLoader
from langchain_core.documents import Document
from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import RunnablePassthrough
from langchain_openai import ChatOpenAI, OpenAIEmbeddings
from langchain_text_splitters import RecursiveCharacterTextSplitter
if "OPENAI_API_KEY" not in os.environ:
os.environ["OPENAI_API_KEY"] = getpass("OPENAI_API_KEY = ")
embe = OpenAIEmbeddings()
导入向量存储
from langchain_community.vectorstores import Cassandra
连接参数
本页展示的Vector Store集成可以与Cassandra以及其他使用CQL(Cassandra查询语言)协议的衍生数据库(如Astra DB)一起使用。
DataStax Astra DB 是一个基于Cassandra构建的托管无服务器数据库,提供相同的接口和优势。
根据您是通过CQL连接到Cassandra集群还是Astra DB,在创建向量存储对象时,您将提供不同的参数。
连接到Cassandra集群
首先,您需要创建一个cassandra.cluster.Session
对象,如Cassandra驱动文档中所述。具体细节可能有所不同(例如网络设置和身份验证),但这可能类似于:
from cassandra.cluster import Cluster
cluster = Cluster(["127.0.0.1"])
session = cluster.connect()
您现在可以将会话以及您想要的键空间名称设置为全局CassIO参数:
import cassio
CASSANDRA_KEYSPACE = input("CASSANDRA_KEYSPACE = ")
cassio.init(session=session, keyspace=CASSANDRA_KEYSPACE)
现在你可以创建向量存储:
vstore = Cassandra(
embedding=embe,
table_name="cassandra_vector_demo",
# session=None, keyspace=None # Uncomment on older versions of LangChain
)
注意:在创建向量存储时,您也可以直接将您的会话和键空间作为参数传递。然而,如果您的应用程序以多种方式使用Cassandra(例如,用于向量存储、聊天记忆和LLM响应缓存),使用全局cassio.init
设置会非常方便,因为它允许将凭据和数据库连接管理集中在一个地方。
通过CQL连接到Astra DB
在这种情况下,您可以使用以下连接参数初始化 CassIO:
- 数据库ID,例如
01234567-89ab-cdef-0123-456789abcdef
- 令牌,例如
AstraCS:6gBhNmsk135....
(必须是“数据库管理员”令牌) - 可选的Keyspace名称(如果省略,将使用数据库的默认名称)
ASTRA_DB_ID = input("ASTRA_DB_ID = ")
ASTRA_DB_APPLICATION_TOKEN = getpass("ASTRA_DB_APPLICATION_TOKEN = ")
desired_keyspace = input("ASTRA_DB_KEYSPACE (optional, can be left empty) = ")
if desired_keyspace:
ASTRA_DB_KEYSPACE = desired_keyspace
else:
ASTRA_DB_KEYSPACE = None
import cassio
cassio.init(
database_id=ASTRA_DB_ID,
token=ASTRA_DB_APPLICATION_TOKEN,
keyspace=ASTRA_DB_KEYSPACE,
)
现在你可以创建向量存储:
vstore = Cassandra(
embedding=embe,
table_name="cassandra_vector_demo",
# session=None, keyspace=None # Uncomment on older versions of LangChain
)
加载数据集
将源数据集中的每个条目转换为Document
,然后将它们写入向量存储中:
philo_dataset = load_dataset("datastax/philosopher-quotes")["train"]
docs = []
for entry in philo_dataset:
metadata = {"author": entry["author"]}
doc = Document(page_content=entry["quote"], metadata=metadata)
docs.append(doc)
inserted_ids = vstore.add_documents(docs)
print(f"\nInserted {len(inserted_ids)} documents.")
在上面,metadata
字典是从源数据创建的,并且是 Document
的一部分。
添加更多条目,这次使用add_texts
:
texts = ["I think, therefore I am.", "To the things themselves!"]
metadatas = [{"author": "descartes"}, {"author": "husserl"}]
ids = ["desc_01", "huss_xy"]
inserted_ids_2 = vstore.add_texts(texts=texts, metadatas=metadatas, ids=ids)
print(f"\nInserted {len(inserted_ids_2)} documents.")
注意:你可能希望通过增加并发级别来加速add_texts
和add_documents
的执行
这些批量操作 - 查看方法的batch_size
参数
了解更多详情。根据网络和客户端机器的规格,你最佳性能的参数选择可能会有所不同。
运行搜索
本节演示元数据过滤并获取相似度分数:
results = vstore.similarity_search("Our life is what we make of it", k=3)
for res in results:
print(f"* {res.page_content} [{res.metadata}]")
results_filtered = vstore.similarity_search(
"Our life is what we make of it",
k=3,
filter={"author": "plato"},
)
for res in results_filtered:
print(f"* {res.page_content} [{res.metadata}]")
results = vstore.similarity_search_with_score("Our life is what we make of it", k=3)
for res, score in results:
print(f"* [SIM={score:3f}] {res.page_content} [{res.metadata}]")
MMR(最大边际相关性)搜索
results = vstore.max_marginal_relevance_search(
"Our life is what we make of it",
k=3,
filter={"author": "aristotle"},
)
for res in results:
print(f"* {res.page_content} [{res.metadata}]")
删除存储的文档
delete_1 = vstore.delete(inserted_ids[:3])
print(f"all_succeed={delete_1}") # True, all documents deleted
delete_2 = vstore.delete(inserted_ids[2:5])
print(f"some_succeeds={delete_2}") # True, though some IDs were gone already
一个最小的RAG链
接下来的单元格将实现一个简单的RAG管道:
- 下载一个示例PDF文件并将其加载到商店中;
- 使用LCEL(LangChain表达式语言)创建一个RAG链,以向量存储为核心;
- 运行问答链。
!curl -L \
"https://github.com/awesome-astra/datasets/blob/main/demo-resources/what-is-philosophy/what-is-philosophy.pdf?raw=true" \
-o "what-is-philosophy.pdf"
pdf_loader = PyPDFLoader("what-is-philosophy.pdf")
splitter = RecursiveCharacterTextSplitter(chunk_size=512, chunk_overlap=64)
docs_from_pdf = pdf_loader.load_and_split(text_splitter=splitter)
print(f"Documents from PDF: {len(docs_from_pdf)}.")
inserted_ids_from_pdf = vstore.add_documents(docs_from_pdf)
print(f"Inserted {len(inserted_ids_from_pdf)} documents.")
retriever = vstore.as_retriever(search_kwargs={"k": 3})
philo_template = """
You are a philosopher that draws inspiration from great thinkers of the past
to craft well-thought answers to user questions. Use the provided context as the basis
for your answers and do not make up new reasoning paths - just mix-and-match what you are given.
Your answers must be concise and to the point, and refrain from answering about other topics than philosophy.
CONTEXT:
{context}
QUESTION: {question}
YOUR ANSWER:"""
philo_prompt = ChatPromptTemplate.from_template(philo_template)
llm = ChatOpenAI()
chain = (
{"context": retriever, "question": RunnablePassthrough()}
| philo_prompt
| llm
| StrOutputParser()
)
chain.invoke("How does Russel elaborate on Peirce's idea of the security blanket?")
更多信息,请查看通过CQL使用Astra DB的完整RAG模板这里。
清理
以下内容基本上是从CassIO中检索Session
对象,并使用它运行CQL DROP TABLE
语句:
(您将丢失其中存储的数据。)
cassio.config.resolve_session().execute(
f"DROP TABLE {cassio.config.resolve_keyspace()}.cassandra_vector_demo;"
)
了解更多
欲了解更多信息、扩展的快速入门指南和额外的使用示例,请访问CassIO 文档以获取更多关于使用 LangChain Cassandra
向量存储的信息。
归属声明
Apache Cassandra、Cassandra 和 Apache 是 Apache 软件基金会 在美国和/或其他国家的注册商标或商标。