Elasticsearch

兼容性

仅在 Node.js 上可用。

Elasticsearch 是一款分布式 RESTful 搜索引擎，针对生产环境规模的工作负载进行了优化，以提高速度和相关性。它还支持使用 k 最近邻 (kNN) 算法进行向量搜索，以及用于自然语言处理 (NLP) 的自定义模型。您可以在 Elasticsearch 中了解有关向量搜索支持的更多信息此处。

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

概述

集成详细信息

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

设置

要使用 Elasticsearch 向量存储，您需要安装 @langchain/community 集成包。

LangChain.js 接受 @elastic/elasticsearch 作为 Elasticsearch 向量存储的客户端。您需要将其作为对等依赖项进行安装。

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

提示

参见此部分，了解有关安装集成包的一般说明。

npm
yarn
pnpm

npm i @langchain/community @elastic/elasticsearch @langchain/openai @langchain/core

yarn add @langchain/community @elastic/elasticsearch @langchain/openai @langchain/core

pnpm add @langchain/community @elastic/elasticsearch @langchain/openai @langchain/core

凭据

要使用 Elasticsearch 向量存储，您需要有一个 Elasticsearch 实例正在运行。

您可以使用官方 Docker 镜像开始，或者使用 Elastic Cloud（Elastic 的官方云服务）。

有关连接到 Elastic Cloud 的信息，您可以阅读此处报告的文档，以获取 API 密钥。

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

实例化

实例化 Elasticsearch 的方式将取决于实例托管的位置。

import {
  ElasticVectorSearch,
  type ElasticClientArgs,
} from "@langchain/community/vectorstores/elasticsearch";
import { OpenAIEmbeddings } from "@langchain/openai";

import { Client, type ClientOptions } from "@elastic/elasticsearch";

import * as fs from "node:fs";

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

const config: ClientOptions = {
  node: process.env.ELASTIC_URL ?? "https://127.0.0.1:9200",
};

if (process.env.ELASTIC_API_KEY) {
  config.auth = {
    apiKey: process.env.ELASTIC_API_KEY,
  };
} else if (process.env.ELASTIC_USERNAME && process.env.ELASTIC_PASSWORD) {
  config.auth = {
    username: process.env.ELASTIC_USERNAME,
    password: process.env.ELASTIC_PASSWORD,
  };
}
// Local Docker deploys require a TLS certificate
if (process.env.ELASTIC_CERT_PATH) {
  config.tls = {
    ca: fs.readFileSync(process.env.ELASTIC_CERT_PATH),
    rejectUnauthorized: false,
  };
}
const clientArgs: ElasticClientArgs = {
  client: new Client(config),
  indexName: process.env.ELASTIC_INDEX ?? "test_vectorstore",
};

const vectorStore = new ElasticVectorSearch(embeddings, clientArgs);

管理向量存储

将项目添加到向量存储

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' ]

从向量存储中删除项目

您可以通过传递与之前传递的相同的 id 来从存储中删除值。

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

查询向量存储

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

直接查询

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

const filter = [
  {
    operator: "match",
    field: "source",
    value: "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"}]

向量存储支持 Elasticsearch 过滤器语法运算符。

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

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.374] The powerhouse of the cell is the mitochondria [{"source":"https://example.com"}]
* [SIM=0.370] 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) 的指南，请参阅以下部分。

API 参考

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

向量数据库概念指南
向量数据库操作指南

Elasticsearch

概述

集成详细信息

设置

凭据

实例化

管理向量存储

将项目添加到向量存储

从向量存储中删除项目

查询向量存储

直接查询

通过转换为检索器查询

用于检索增强型生成

API 参考

此页面是否有用？

您也可以留下详细的反馈在 GitHub 上.

概述​

集成详细信息​

设置​

凭据​

实例化​

管理向量存储​

将项目添加到向量存储​

从向量存储中删除项目​

查询向量存储​

直接查询​

通过转换为检索器查询​

用于检索增强型生成​

API 参考​

相关​

此页面是否有用？

您也可以留下详细的反馈 在 GitHub 上.

概述

集成详细信息

设置

凭据

实例化

管理向量存储

将项目添加到向量存储

从向量存储中删除项目

查询向量存储

直接查询

通过转换为检索器查询

用于检索增强型生成

API 参考

相关

您也可以留下详细的反馈在 GitHub 上.