Google Memorystore for Redis
Google Memorystore for Redis 是一个完全托管的服务，由 Redis 内存数据存储提供支持，用于构建提供亚毫秒级数据访问的应用程序缓存。扩展您的数据库应用程序，利用 Memorystore for Redis 的 Langchain 集成构建由 AI 驱动的体验。
本笔记本介绍如何使用Memorystore for Redis通过MemorystoreVectorStore类存储向量嵌入。
了解更多关于该包的信息，请访问GitHub。
先决条件
开始之前
要运行此笔记本，您需要执行以下操作：
🦜🔗 库安装
集成位于其自己的langchain-google-memorystore-redis包中，因此我们需要安装它。
%pip install -upgrade --quiet langchain-google-memorystore-redis langchain
仅限Colab：取消注释以下单元格以重新启动内核，或使用按钮重新启动内核。对于Vertex AI Workbench，您可以使用顶部的按钮重新启动终端。
# # Automatically restart kernel after installs so that your environment can access the new packages
# import IPython
# app = IPython.Application.instance()
# app.kernel.do_shutdown(True)
☁ 设置您的Google Cloud项目
设置您的Google Cloud项目，以便您可以在此笔记本中利用Google Cloud资源。
如果您不知道您的项目ID，请尝试以下操作：
- 运行
gcloud config list。 - 运行
gcloud projects list。 - 查看支持页面：Locate the project ID。
# @markdown Please fill in the value below with your Google Cloud project ID and then run the cell.
PROJECT_ID = "my-project-id" # @param {type:"string"}
# Set the project id
!gcloud config set project {PROJECT_ID}
🔐 认证
以登录此笔记本的IAM用户身份验证到Google Cloud，以便访问您的Google Cloud项目。
- 如果您正在使用Colab运行此笔记本，请使用下面的单元格并继续。
- 如果您正在使用Vertex AI Workbench，请查看这里的设置说明。
from google.colab import auth
auth.authenticate_user()
基本用法
初始化向量索引
import redis
from langchain_google_memorystore_redis import (
DistanceStrategy,
HNSWConfig,
RedisVectorStore,
)
# Connect to a Memorystore for Redis instance
redis_client = redis.from_url("redis://127.0.0.1:6379")
# Configure HNSW index with descriptive parameters
index_config = HNSWConfig(
name="my_vector_index", distance_strategy=DistanceStrategy.COSINE, vector_size=128
)
# Initialize/create the vector store index
RedisVectorStore.init_index(client=redis_client, index_config=index_config)
准备文档
在与向量存储交互之前，文本需要处理和数值表示。这包括：
- 加载文本：TextLoader 从文件中获取文本数据（例如，"state_of_the_union.txt"）。
- 文本分割：CharacterTextSplitter 将文本分割成较小的块，以便嵌入模型使用。
from langchain_community.document_loaders import TextLoader
from langchain_text_splitters import CharacterTextSplitter
loader = TextLoader("./state_of_the_union.txt")
documents = loader.load()
text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)
docs = text_splitter.split_documents(documents)
将文档添加到向量存储
在文本准备和嵌入生成之后，以下方法将它们插入到Redis向量存储中。
方法1：用于直接插入的类方法
这种方法使用from_documents类方法将嵌入创建和插入结合为一个步骤：
from langchain_community.embeddings.fake import FakeEmbeddings
embeddings = FakeEmbeddings(size=128)
redis_client = redis.from_url("redis://127.0.0.1:6379")
rvs = RedisVectorStore.from_documents(
docs, embedding=embeddings, client=redis_client, index_name="my_vector_index"
)
方法2：基于实例的插入
这种方法在使用新的或现有的RedisVectorStore时提供了灵活性：
- [可选] 创建 RedisVectorStore 实例：实例化一个 RedisVectorStore 对象以进行自定义。如果您已经有一个实例，请继续下一步。
- 添加带有元数据的文本：向实例提供原始文本和元数据。嵌入生成和插入向量存储的过程是自动处理的。
rvs = RedisVectorStore(
client=redis_client, index_name="my_vector_index", embeddings=embeddings
)
ids = rvs.add_texts(
texts=[d.page_content for d in docs], metadatas=[d.metadata for d in docs]
)
执行相似性搜索 (KNN)
随着向量存储的填充，可以搜索与查询语义相似的文本。以下是使用默认设置的KNN（K-最近邻）的方法：
- 制定查询：一个自然语言问题表达了搜索意图（例如，“总统对Ketanji Brown Jackson说了什么”）。
- 检索相似结果：
similarity_search方法在向量存储中查找与查询在意义上最接近的项目。
import pprint
query = "What did the president say about Ketanji Brown Jackson"
knn_results = rvs.similarity_search(query=query)
pprint.pprint(knn_results)
执行基于范围的相似性搜索
范围查询通过指定所需的相似度阈值以及查询文本，提供了更多的控制：
- 制定查询：自然语言问题定义了搜索意图。
- 设置相似度阈值：distance_threshold 参数决定了匹配必须有多接近才能被认为是相关的。
- 检索结果：
similarity_search_with_score方法从向量存储中查找落在指定相似度阈值内的项目。
rq_results = rvs.similarity_search_with_score(query=query, distance_threshold=0.8)
pprint.pprint(rq_results)
执行最大边际相关性（MMR）搜索
MMR查询旨在找到既与查询相关又彼此多样化的结果，减少搜索结果中的冗余。
- 制定查询：自然语言问题定义了搜索意图。
- 平衡相关性和多样性：lambda_mult 参数控制严格相关性和促进结果多样性之间的权衡。
- 检索MMR结果：
max_marginal_relevance_search方法返回基于lambda设置优化相关性和多样性组合的项目。
mmr_results = rvs.max_marginal_relevance_search(query=query, lambda_mult=0.90)
pprint.pprint(mmr_results)
使用向量存储作为检索器
为了与其他LangChain组件无缝集成，可以将向量存储转换为检索器。这提供了几个优势：
- LangChain 兼容性：许多 LangChain 工具和方法设计用于直接与检索器交互。
- 易于使用：
as_retriever()方法将向量存储转换为简化查询的格式。
retriever = rvs.as_retriever()
results = retriever.invoke(query)
pprint.pprint(results)
清理
从向量存储中删除文档
偶尔，需要从向量存储中删除文档（及其相关向量）。delete方法提供了此功能。
rvs.delete(ids)
删除向量索引
在某些情况下，可能需要删除现有的向量索引。常见的原因包括：
- 索引配置更改：如果需要修改索引参数，通常需要删除并重新创建索引。
- 存储管理：删除未使用的索引可以帮助释放Redis实例中的空间。
注意：向量索引删除是一个不可逆的操作。在继续之前，请确保不再需要存储的向量和搜索功能。
# Delete the vector index
RedisVectorStore.drop_index(client=redis_client, index_name="my_vector_index")