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

本笔记本介绍如何使用 Memorystore for Redis to 保存、加载和删除 LangChain 文档 配合 MemorystoreDocumentLoader 和 MemorystoreDocumentSaver.

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


准备工作

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

• * 创建 Google Cloud 项目
• * 启用 Memorystore for Redis API
• * 创建 Memorystore for Redis 实例。确保版本大于或等于 5.0。

确认在笔记本的运行时环境中可以访问数据库后，填写以下值并运行单元格，然后再运行示例脚本。

# @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"}

🦜🔗 库安装

该集成位于其独立的 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 项目

设置您的 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()

基本用法

保存文档

使用以下方式保存 LangChain 文档 MemorystoreDocumentSaver.add_documents(<documents>)。要初始化 MemorystoreDocumentSaver 类，您需要提供 2 件事：

1. client - A redis.Redis 客户端对象。
2. key_prefix - 用于存储 Redis 中文档的键的前缀。

文档将存储到具有指定前缀的随机生成的键中 key_prefix。或者，您可以通过指定来指定键的后缀 ids 在 add_documents method.

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)

加载文档

初始化一个加载器，用于加载存储在 Memorystore for Redis 实例中具有特定前缀的所有文档。

使用以下方式加载 langchain 文档 MemorystoreDocumentLoader.load() or MemorystoreDocumentLoader.lazy_load(). lazy_load 返回一个生成器，仅在迭代时查询数据库。要初始化 MemorystoreDocumentLoader 类，您需要提供：

1. client - A redis.Redis 客户端对象。
2. key_prefix - 用于在 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)

删除文档

删除 Memorystore for Redis 实例中具有指定前缀的所有键 MemorystoreDocumentSaver.delete()。如果您知道的话，也可以指定键的后缀。

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())

高级用法

自定义文档页面内容和元数据

当初始化具有多个内容字段的加载器时， page_content 加载的文档的 content_fields.

如果指定了 metadata_fields ，则 metadata 加载的文档的 metadata_fields字段将仅包含与指定的

loader = MemorystoreDocumentLoader(
    client=redis_client,
    key_prefix=KEY_PREFIX,
    content_fields=set(["content_field_1", "content_field_2"]),
    metadata_fields=set(["title", "author"]),
)