以编程方式使用文档

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

本笔记本介绍如何使用 Memorystore for Redis 使用 MemorystoreVectorStore class.

了解更多关于该包的信息，请访问 GitHub.

![在 Colab 中打开](https://colab.research.google.com/github/googleapis/langchain-google-memorystore-redis-python/blob/main/docs/vector_store.ipynb)

Pre-reqs

开始之前

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

🦜🔗 库安装

该集成位于其独立的 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，请查看 Vertex AI Workbench 设置说明.
from google.colab import auth

auth.authenticate_user()

基本用法

初始化向量索引

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近邻）搜索的方法：

  • * 构建查询：自然语言问题表达了搜索意图（例如，"What did the president say about Ketanji Brown Jackson"）。
  • * 检索相似结果: The similarity_search 该方法在向量存储中查找与查询语义最接近的项。
query = "What did the president say about Ketanji Brown Jackson"
knn_results = rvs.similarity_search(query=query)
pprint.pprint(knn_results)

执行基于范围相似性搜索

范围查询通过指定所需的相似度阈值以及查询文本来提供更多控制：

  • * 制定查询：自然语言问题定义了搜索意图。
  • * 设置相似度阈值：距离_阈值参数决定匹配必须多接近才能被视为相关。
  • * 检索结果： 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")