Skip to main content
Open In ColabOpen on GitHub

Google Memorystore for Redis

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

本 Notebook 将介绍如何使用 Memorystore for Redis 通过 MemorystoreDocumentLoader 和 MemorystoreDocumentSaver 来保存、加载和删除 Langchain 文档。

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

在 Colab 中打开

开始之前​

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

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

# @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 项目，以便在此 notebook 中利用 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()

基本用法​

保存文档​

使用 MemorystoreDocumentSaver.add_documents(<documents>) 保存 Langchain 文档。要初始化 MemorystoreDocumentSaver 类，您需要提供两项内容：

  1. client - 一个 redis.Redis 客户端对象。
  2. key_prefix - 用于在 Redis 中存储 Documents 的键的前缀。

Documents 将被存储在具有指定 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)
API Reference:Document

加载文档​

初始化一个加载器，该加载器将加载 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())

高级用法​

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

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