RedisVectorStore

兼容性

仅在 Node.js 上可用。

Redis 是一种快速的开源、内存中数据存储。作为Redis Stack 的一部分，RediSearch 是一个模块，它支持向量相似性语义搜索，以及许多其他类型的搜索。

本指南提供了一个快速入门指南，用于开始使用 Redis向量存储。有关所有 RedisVectorStore 功能和配置的详细文档，请前往API 参考。

概述

集成详细信息

类	包	PY 支持	最新包
RedisVectorStore	@langchain/redis	✅

设置

要使用 Redis 向量存储，你需要设置一个 Redis 实例并安装 @langchain/redis 集成包。你还可以安装node-redis 包，以使用特定的客户端实例初始化向量存储。

本指南还将使用OpenAI 嵌入，这需要你安装 @langchain/openai 集成包。如果你愿意，也可以使用其他支持的嵌入模型。

提示

查看此部分以获取有关安装集成包的通用说明。

npm

npm i @langchain/redis redis @langchain/openai

yarn

yarn add @langchain/redis redis @langchain/openai

pnpm

pnpm add @langchain/redis redis @langchain/openai

你可以按照这些说明，使用 Docker 在本地设置一个 Redis 实例。

凭据

设置完实例后，设置 REDIS_URL 环境变量

process.env.REDIS_URL = "your-redis-url";

如果你在本指南中使用 OpenAI 嵌入，你还需要设置你的 OpenAI 密钥

process.env.OPENAI_API_KEY = "YOUR_API_KEY";

如果你想获得模型调用的自动跟踪，你还可以通过取消注释以下内容来设置你的LangSmith API 密钥

// process.env.LANGCHAIN_TRACING_V2="true"
// process.env.LANGCHAIN_API_KEY="your-api-key"

实例化

import { RedisVectorStore } from "@langchain/redis";
import { OpenAIEmbeddings } from "@langchain/openai";

import { createClient } from "redis";

const embeddings = new OpenAIEmbeddings({
  model: "text-embedding-3-small",
});

const client = createClient({
  url: process.env.REDIS_URL ?? "redis://localhost:6379",
});
await client.connect();

const vectorStore = new RedisVectorStore(embeddings, {
  redisClient: client,
  indexName: "langchainjs-testing",
});

管理向量存储

将项目添加到向量存储

import type { Document } from "@langchain/core/documents";

const document1: Document = {
  pageContent: "The powerhouse of the cell is the mitochondria",
  metadata: { type: "example" },
};

const document2: Document = {
  pageContent: "Buildings are made out of brick",
  metadata: { type: "example" },
};

const document3: Document = {
  pageContent: "Mitochondria are made out of lipids",
  metadata: { type: "example" },
};

const document4: Document = {
  pageContent: "The 2024 Olympics are in Paris",
  metadata: { type: "example" },
};

const documents = [document1, document2, document3, document4];

await vectorStore.addDocuments(documents);

目前不支持顶级文档 ID 和删除操作。

查询向量存储

创建向量存储并添加相关文档后，你很可能希望在链或代理运行期间对其进行查询。

直接查询

可以按照以下步骤执行简单的相似性搜索

const similaritySearchResults = await vectorStore.similaritySearch(
  "biology",
  2
);

for (const doc of similaritySearchResults) {
  console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
}

过滤将当前查找包含提供的字符串的任何元数据键。

如果你想执行相似性搜索并接收相应的得分，你可以运行

const similaritySearchWithScoreResults =
  await vectorStore.similaritySearchWithScore("biology", 2);

for (const [doc, score] of similaritySearchWithScoreResults) {
  console.log(
    `* [SIM=${score.toFixed(3)}] ${doc.pageContent} [${JSON.stringify(
      doc.metadata
    )}]`
  );
}

* [SIM=0.835] The powerhouse of the cell is the mitochondria [{"type":"example"}]
* [SIM=0.852] Mitochondria are made out of lipids [{"type":"example"}]

通过转换为检索器进行查询

你也可以将向量存储转换为检索器，以便在你的链中更轻松地使用。

const retriever = vectorStore.asRetriever({
  k: 2,
});
await retriever.invoke("biology");

[
  Document {
    pageContent: 'The powerhouse of the cell is the mitochondria',
    metadata: { type: 'example' },
    id: undefined
  },
  Document {
    pageContent: 'Mitochondria are made out of lipids',
    metadata: { type: 'example' },
    id: undefined
  }
]

用于检索增强生成的用法

有关如何将此向量存储用于检索增强生成 (RAG) 的指南，请参阅以下部分

• 教程：使用外部知识.
• 操作方法：使用 RAG 进行问答
• 检索概念文档

删除索引

你可以使用以下命令删除整个索引

await vectorStore.delete({ deleteAll: true });

关闭连接

使用完毕后，请确保关闭客户端连接，以避免过度消耗资源。

await client.disconnect();

API 参考

有关所有RedisVectorSearch功能和配置的详细文档，请访问API 参考。

相关

• 向量存储 概念指南
• 向量存储 操作指南