Google Memorystore for Redis
Google Memorystore for Redis is a fully-managed service that is powered by the Redis in-memory data store to build application caches that provide sub-millisecond data access. Extend your database application to build AI-powered experiences leveraging Memorystore for Redis's Langchain integrations.
本笔记本介绍了如何使用 Memorystore for Redis 配合 MemorystoreDocumentLoader 和 MemorystoreDocumentSaver 来保存、加载和删除 LangChain 文档。
在 GitHub 上了解更多关于该包的信息。
开始之前
要运行此笔记本，您需要执行以下操作：
在确认此笔记本的运行时环境已具备数据库访问权限后，请填写以下值并运行该单元格，然后再运行示例脚本。
# @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，请查看设置说明 此处。
from google.colab import auth
auth.authenticate_user()
基本用法
保存文档
使用 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)
加载文档
初始化一个加载器，用于加载存储在具有特定前缀的 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)
删除文档
删除 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())
高级用法
自定义文档页面内容与元数据
当使用超过 1 个内容字段初始化加载器时，已加载文档的 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"]),
)