Google Cloud Memorystore for Redis
Google Memorystore for Redis 是一款完全托管的服务，它由 Redis 内存数据存储提供支持，用于构建提供亚毫秒数据访问的应用程序缓存。扩展您的数据库应用程序以构建利用 Memorystore for Redis 的 Langchain 集成的 AI 驱动的体验。
此笔记本介绍了如何使用 Memorystore for Redis 来使用 MemorystoreDocumentLoader 和 MemorystoreDocumentSaver 保存、加载和删除 LangChain 文档。
在 GitHub 上了解有关该软件包的更多信息。
开始之前 (Before You Begin)
要运行此笔记本，您需要执行以下操作
在确认已访问此笔记本运行时环境中的数据库后，填写以下值并在运行示例脚本之前运行单元格。
# @markdown Please specify an endpoint associated with the instance and a key prefix for demo purpose.
ENDPOINT = "redis://127.0.0.1:6379" # @param {type:"string"}
KEY_PREFIX = "doc:" # @param {type:"string"}
🦜🔗 库安装 (Library Installation)
集成位于其自己的 langchain-google-memorystore-redis 包中，因此我们需要安装它。
%pip install -upgrade --quiet langchain-google-memorystore-redis
**仅限 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 项目 (Set Your Google Cloud Project)
设置您的 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}
🔐 身份验证 (Authentication)
以登录此笔记本的 IAM 用户身份对 Google Cloud 进行身份验证，以便访问您的 Google Cloud 项目。
- 如果您使用 Colab 运行此笔记本，请使用下面的单元格并继续。
- 如果您使用 Vertex AI Workbench，请查看此处的设置说明。
from google.colab import auth
auth.authenticate_user()
基本用法 (Basic Usage)
保存文档 (Save documents)
使用 MemorystoreDocumentSaver.add_documents(<documents>) 保存 LangChain 文档。要初始化 MemorystoreDocumentSaver 类，您需要提供两样东西
client- 一个redis.Redis客户端对象。key_prefix- 用于在 Redis 中存储文档的键的前缀。
文档将存储到使用指定的 key_prefix 前缀的随机生成的键中。或者，您可以通过在 add_documents 方法中指定 ids 来指定键的后缀。
import redis
from langchain_core.documents import Document
from langchain_google_memorystore_redis import MemorystoreDocumentSaver
test_docs = [
Document(
page_content="Apple Granny Smith 150 0.99 1",
metadata={"fruit_id": 1},
),
Document(
page_content="Banana Cavendish 200 0.59 0",
metadata={"fruit_id": 2},
),
Document(
page_content="Orange Navel 80 1.29 1",
metadata={"fruit_id": 3},
),
]
doc_ids = [f"{i}" for i in range(len(test_docs))]
redis_client = redis.from_url(ENDPOINT)
saver = MemorystoreDocumentSaver(
client=redis_client,
key_prefix=KEY_PREFIX,
content_field="page_content",
)
saver.add_documents(test_docs, ids=doc_ids)
加载文档 (Load documents)
初始化一个加载程序，该加载程序加载存储在 Memorystore for Redis 实例中具有特定前缀的所有文档。
使用 MemorystoreDocumentLoader.load() 或 MemorystoreDocumentLoader.lazy_load() 加载 LangChain 文档。lazy_load 返回一个生成器，该生成器仅在迭代期间查询数据库。要初始化 MemorystoreDocumentLoader 类，您需要提供
client- 一个redis.Redis客户端对象。key_prefix- 用于在 Redis 中存储文档的键的前缀。
import redis
from langchain_google_memorystore_redis import MemorystoreDocumentLoader
redis_client = redis.from_url(ENDPOINT)
loader = MemorystoreDocumentLoader(
client=redis_client,
key_prefix=KEY_PREFIX,
content_fields=set(["page_content"]),
)
for doc in loader.lazy_load():
print("Loaded documents:", doc)
删除文档 (Delete documents)
使用 MemorystoreDocumentSaver.delete() 删除 Memorystore for Redis 实例中具有指定前缀的所有键。如果您知道，也可以指定键的后缀。
docs = loader.load()
print("Documents before delete:", docs)
saver.delete(ids=[0])
print("Documents after delete:", loader.load())
saver.delete()
print("Documents after delete all:", loader.load())
高级用法 (Advanced Usage)
自定义文档页面内容和元数据 (Customize Document Page Content & Metadata)
当使用多个内容字段初始化加载程序时，加载的文档的 page_content 将包含一个 JSON 编码的字符串，其顶级字段等于 content_fields 中指定的字段。
如果指定了 metadata_fields，则加载的文档的 metadata 字段将仅具有等于指定的 metadata_fields 的顶级字段。如果元数据字段的任何值存储为 JSON 编码的字符串，则在加载到元数据字段之前将对其进行解码。
loader = MemorystoreDocumentLoader(
client=redis_client,
key_prefix=KEY_PREFIX,
content_fields=set(["content_field_1", "content_field_2"]),
metadata_fields=set(["title", "author"]),
)