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

适用于 Redis 的 Google Memorystore

Google Memorystore for Redis 是一项完全托管的服务，由 Redis 内存数据存储提供支持，用于构建提供亚毫秒级数据访问的应用程序缓存。扩展您的数据库应用程序，以利用 Memorystore for Redis 的 Langchain 集成构建 AI 驱动的体验。

本笔记本介绍了如何使用 Memorystore for Redis 存储向量嵌入向量，其中包含MemorystoreVectorStore类。

在 GitHub 上了解有关该软件包的更多信息。

Open In Colab

先决条件

准备工作

要运行此笔记本，您需要执行以下作：

🦜🔗 库安装

集成存在于自己的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.
  • 请参阅支持页面：查找项目 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()

基本用法

初始化 Vector 索引

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)

将文档添加到 Vector Store

在文本准备和嵌入生成后，以下方法将它们插入到 Redis 向量存储中。

方法 1：直接插入的 Classmethod

这种方法使用 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"
)
API 参考：FakeEmbeddings

方法 2：基于实例的插入

这种方法在使用新的或现有的 RedisVectorStore 时提供了灵活性：

  • [可选]创建 RedisVectorStore 实例：实例化 RedisVectorStore 对象以进行自定义。如果您已经有一个实例，请继续执行下一步。
  • Add Text with Metadata：向实例提供原始文本和元数据。嵌入生成和插入到向量存储中是自动处理的。
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_searchmethod 在 vector store 中查找与 meaning 上的查询最接近的项目。
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_scoremethod 从 vector store 中查找位于指定相似性阈值范围内的项目。
rq_results = rvs.similarity_search_with_score(query=query, distance_threshold=0.8)
pprint.pprint(rq_results)

MMR 查询旨在查找与查询相关且彼此不同的结果，从而减少搜索结果中的冗余。

  • 制定查询：自然语言问题定义搜索意图。
  • 平衡相关性和多样性：lambda_mult 参数控制严格相关性与促进结果多样性之间的权衡。
  • 检索 MMR 结果：max_marginal_relevance_searchmethod 返回根据 Lambda 设置优化相关性和多样性组合的项目。
mmr_results = rvs.max_marginal_relevance_search(query=query, lambda_mult=0.90)
pprint.pprint(mmr_results)

将 Vector Store 用作检索器

为了与其他 LangChain 组件无缝集成，可以将 vector store 转换为 Retriever。这提供了几个优点：

  • LangChain 兼容性：许多 LangChain 工具和方法都设计为直接与检索器交互。
  • 易用性：as_retriever()方法将 vector store 转换为可简化查询的格式。
retriever = rvs.as_retriever()
results = retriever.invoke(query)
pprint.pprint(results)

收拾

从 Vector Store 中删除文档

有时，需要从 vector store 中删除文档（及其关联的 vector）。这deletemethod 提供此功能。

rvs.delete(ids)

删除向量索引

在某些情况下，可能需要删除现有向量索引。常见原因包括：

  • 索引配置更改：如果需要修改索引参数，通常需要删除并重新创建索引。
  • 存储管理：删除未使用的索引有助于释放 Redis 实例中的空间。

注意：矢量索引删除是不可逆的作。在继续之前，请确保不再需要存储的向量和搜索功能。

# Delete the vector index
RedisVectorStore.drop_index(client=redis_client, index_name="my_vector_index")