Skip to main content

Google Memorystore for Redis

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

本笔记将介绍如何使用 Memorystore for Redis 来使用 MemorystoreDocumentLoader 和 MemorystoreDocumentSaver 保存、加载和删除 langchain 文档。

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

在 Colab 中打开

开始之前​

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

在笔记的运行环境中确认对数据库的访问权限后，填写以下值并在运行示例脚本之前运行单元格。

# @markdown 请指定与实例关联的端点和用于演示目的的键前缀。
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，您可以使用顶部的按钮重新启动终端。

# # 自动安装后重新启动内核，以便您的环境可以访问新的包
# 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 请在下面的值中填写您的 Google Cloud 项目 ID，然后运行单元格。
PROJECT_ID = "my-project-id"  # @param {type:"string"}
# 设置项目 ID
!gcloud config set project {PROJECT_ID}

🔐 身份验证​

作为在此笔记本中登录的 IAM 用户，进行身份验证以访问您的 Google Cloud 项目。

  • 如果您使用 Colab 运行此笔记本，请使用下面的单元格并继续。

  • 如果您使用 Vertex AI Workbench，请查看此处的设置说明。

from google.colab import auth
auth.authenticate_user()

基本用法​

保存文档​

使用 MemorystoreDocumentSaver.add_documents(<documents>) 保存 langchain 文档。要初始化 MemorystoreDocumentSaver 类，您需要提供两样东西：

  1. client - 一个 redis.Redis 客户端对象。

  2. key_prefix - 用于在 Redis 中存储文档的键前缀。

文档将以指定前缀的随机生成的键存储。或者，您可以通过在 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)

加载文档​

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

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

  1. client - 一个 redis.Redis 客户端对象。

  2. 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)

删除文档​

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

高级用法​

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

当使用多个内容字段初始化加载器时，加载的文档的 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"]),
)

Was this page helpful?


You can leave detailed feedback on GitHub.