UpstashVectorStore

Upstash Vector 是一个基于 REST 的无服务器向量数据库，专为处理向量嵌入而设计。

本指南简要概述了如何开始使用 Upstash 向量存储。有关所有 UpstashVectorStore 功能和配置的详细文档，请访问 API 参考.

概述

集成详细信息

类	包	PY 支持	最新包
UpstashVectorStore	@langchain/community	✅

设置

要使用 Upstash 向量存储，您需要创建一个 Upstash 帐户、创建一个索引并安装 @langchain/community 集成包。您还需要安装 @upstash/vector 包作为对等依赖项。

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

提示

查看 此部分以获取有关安装集成包的一般说明.

npm

npm i @langchain/community @upstash/vector @langchain/openai

yarn

yarn add @langchain/community @upstash/vector @langchain/openai

pnpm

pnpm add @langchain/community @upstash/vector @langchain/openai

您可以从 Upstash 控制台 创建索引。有关更多参考，请参阅 官方文档.

凭据

设置索引后，设置以下环境变量

process.env.UPSTASH_VECTOR_REST_URL = "your-rest-url";
process.env.UPSTASH_VECTOR_REST_TOKEN = "your-rest-token";

如果您在本指南中使用 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"

实例化

确保您的索引与您的嵌入具有相同的维度数。OpenAI text-embedding-3-small 的默认值为 1536。

import { UpstashVectorStore } from "@langchain/community/vectorstores/upstash";
import { OpenAIEmbeddings } from "@langchain/openai";

import { Index } from "@upstash/vector";

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

const indexWithCredentials = new Index({
  url: process.env.UPSTASH_VECTOR_REST_URL,
  token: process.env.UPSTASH_VECTOR_REST_TOKEN,
});

const vectorStore = new UpstashVectorStore(embeddings, {
  index: indexWithCredentials,
  // You can use namespaces to partition your data in an index
  // namespace: "test-namespace",
});

管理向量存储

向向量存储添加项目

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

const document1: Document = {
  pageContent: "The powerhouse of the cell is the mitochondria",
  metadata: { source: "https://example.com" },
};

const document2: Document = {
  pageContent: "Buildings are made out of brick",
  metadata: { source: "https://example.com" },
};

const document3: Document = {
  pageContent: "Mitochondria are made out of lipids",
  metadata: { source: "https://example.com" },
};

const document4: Document = {
  pageContent: "The 2024 Olympics are in Paris",
  metadata: { source: "https://example.com" },
};

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

await vectorStore.addDocuments(documents, { ids: ["1", "2", "3", "4"] });

[ '1', '2', '3', '4' ]

注意：添加文档后，它们可能需要一段时间才能被查询。

从向量存储中删除项目

await vectorStore.delete({ ids: ["4"] });

查询向量存储

创建向量存储并添加相关文档后，您可能希望在运行链或代理时查询它。

直接查询

可以按如下方式执行简单的相似性搜索

const filter = "source = 'https://example.com'";

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

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

* The powerhouse of the cell is the mitochondria [{"source":"https://example.com"}]
* Mitochondria are made out of lipids [{"source":"https://example.com"}]

有关 Upstash Vector 过滤器语法的更多信息，请参阅 此页面。

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

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

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

* [SIM=0.576] The powerhouse of the cell is the mitochondria [{"source":"https://example.com"}]
* [SIM=0.557] Mitochondria are made out of lipids [{"source":"https://example.com"}]

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

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

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

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

用于检索增强生成的用法

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

• 教程：使用外部知识.
• 如何：使用 RAG 进行问答
• 检索概念文档

API 参考

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

相关

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