VoyageEmbeddings 集成

使用 LangChain JavaScript 集成 VoyageEmbeddings 嵌入模型。

这将帮助您使用 LangChain 开始使用 VoyageEmbeddings 嵌入模型。有关 VoyageEmbeddings 功能和配置选项的详细文档，请参阅 API 参考。

概述

集成详情

类	包	本地	Python 支持	下载	版本
VoyageEmbeddings	@langchain/mongodb	❌	✅

设置

要访问 Voyage AI 嵌入模型，您需要创建一个 Voyage AI 账户，获取一个 API 密钥，并安装 @langchain/mongodb 集成包。

凭证

前往 voyageai.com 注册并生成 API 密钥。完成后，设置 VOYAGE_API_KEY 环境变量：

export VOYAGE_API_KEY="your-api-key"

如果您希望自动跟踪您的模型调用，可以通过取消注释以下内容来设置您的 LangSmith API 密钥：

# export LANGSMITH_TRACING="true"
# export LANGSMITH_API_KEY="your-api-key"

安装

LangChain VoyageEmbeddings 集成位于 @langchain/mongodb 包中：

npm

npm install @langchain/mongodb @langchain/core

实例化

现在我们可以实例化我们的模型对象并嵌入文本：

import { VoyageEmbeddings } from "@langchain/mongodb";

const embeddings = new VoyageEmbeddings({
  apiKey: "YOUR-API-KEY", // In Node.js defaults to process.env.VOYAGE_API_KEY
  model: "voyage-4",
});

索引和检索

嵌入模型通常用于检索增强生成 (RAG) 流程中，既作为索引数据的一部分，也用于稍后检索数据。有关更详细的说明，请参阅我们在 学习 标签 下 RAG 教程。

以下是如何使用我们上面初始化的 embeddings 对象索引和检索数据。在这个示例中，我们将使用 demo MemoryVectorStore 索引和检索一个示例文档。

// Create a vector store with a sample text
import { MemoryVectorStore } from "@langchain/classic/vectorstores/memory";

const text = "LangChain is the framework for building context-aware reasoning applications";

const vectorstore = await MemoryVectorStore.fromDocuments(
  [{ pageContent: text, metadata: {} }],
  embeddings,
);

// Use the vector store as a retriever that returns a single document
const retriever = vectorstore.asRetriever(1);

// Retrieve the most similar text
const retrievedDocuments = await retriever.invoke("What is LangChain?");

retrievedDocuments[0].pageContent;

LangChain is the framework for building context-aware reasoning applications

直接使用

在底层，向量存储和检索器的实现会调用 embeddings.embedDocument(...) 和 embeddings.embedQuery(...) 来为 fromDocuments 中使用的文本和检索器的 invoke 操作创建嵌入。

您可以直接调用这些方法来获取您自己的用例的嵌入。

嵌入单个文本

您可以使用 embedQuery 嵌入搜索查询。这会生成特定于查询的向量表示：

const singleVector = await embeddings.embedQuery(text);

console.log(singleVector.slice(0, 3));

嵌入多个文本

您可以使用 embedDocuments 嵌入多个用于索引的文本。此方法使用的内部机制可能与嵌入查询不同：

const text2 = "LangGraph is a library for building stateful, multi-actor applications with LLMs";

const vectors = await embeddings.embedDocuments([text, text2]);

console.log(vectors[0].slice(0, 3));
console.log(vectors[1].slice(0, 3));

---

API 参考

有关所有 VoyageEmbeddings 功能和配置的详细文档，请前往 API 参考。

---

官方原文：src/oss/javascript/integrations/embeddings/voyageai.mdx · 非官方翻译，译文由 AI 生成，以英文原文为准。