混合面包 AI

MixedbreadAIEmbeddings 类使用混合面包 AI API 生成文本嵌入。本指南将引导您完成设置和使用 MixedbreadAIEmbeddings 类，帮助您有效地将其集成到您的项目中。

安装

要安装 @langchain/mixedbread-ai 包，请使用以下命令

提示

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

npm

npm install @langchain/mixedbread-ai

Yarn

yarn add @langchain/mixedbread-ai

pnpm

pnpm add @langchain/mixedbread-ai

初始化

首先，在混合面包 AI 网站上注册并从此处获取您的 API 密钥。然后，您可以使用此密钥初始化 MixedbreadAIEmbeddings 类。

您可以将 API 密钥直接传递给构造函数，也可以将其设置为环境变量 (MXBAI_API_KEY)。

基本用法

以下是创建 MixedbreadAIEmbeddings 实例的方法

import { MixedbreadAIEmbeddings } from "@langchain/mixedbread-ai";

const embeddings = new MixedbreadAIEmbeddings({
  apiKey: "YOUR_API_KEY",
  // Optionally specify model
  // model: "mixedbread-ai/mxbai-embed-large-v1",
});

如果未提供 apiKey，它将从 MXBAI_API_KEY 环境变量中读取。

生成嵌入

嵌入单个查询

要为单个文本查询生成嵌入，请使用 embedQuery 方法

const embedding = await embeddings.embedQuery(
  "Represent this sentence for searching relevant passages: Is baking fun?"
);
console.log(embedding);

嵌入多个文档

要为多个文档生成嵌入，请使用 embedDocuments 方法。此方法会根据 batchSize 参数自动处理批处理

const documents = ["Baking bread is fun", "I love baking"];

const embeddingsArray = await embeddings.embedDocuments(documents);
console.log(embeddingsArray);

自定义请求

您可以通过传递其他参数来自定义 SDK。

const customEmbeddings = new MixedbreadAIEmbeddings({
  apiKey: "YOUR_API_KEY",
  baseUrl: "...",
  maxRetries: 6,
});

错误处理

如果未提供 API 密钥，也无法在环境变量中找到，则会抛出错误

try {
  const embeddings = new MixedbreadAIEmbeddings();
} catch (error) {
  console.error(error);
}

相关

• 嵌入模型 概念指南
• 嵌入模型 操作指南