概述

本指南将帮助您集成并使用 Mixedbread AI 重排序 API。重排序 API 允许您根据给定查询重新排序文档列表，从而提高搜索结果或任何排序列表的相关性。

安装

首先，安装 @langchain/mixedbread-ai package:

npm install @langchain/mixedbread-ai

身份验证

在以下网站注册以获取您的 API 密钥 Mixedbread AI。然后您可以将 MXBAI_API_KEY 环境变量设置为您的 Mixedbread AI API 密钥，或直接将其作为 apiKey 选项传递给类构造函数。

使用重排序

该 MixedbreadAIReranker 类提供对重排序 API 的访问。以下是使用方法：

1. **导入类**：首先，从包中导入 MixedbreadAIReranker 类。

1. **实例化类**：创建 MixedbreadAIReranker 的实例并传入您的 API 密钥。

const reranker = new MixedbreadAIReranker({ apiKey: "your-api-key" });

1. **重排序文档**：使用 rerankDocuments 方法根据查询重新排序文档。

const documents = [
  { pageContent: "To bake bread you need flour" },
  { pageContent: "To bake bread you need yeast" },
  { pageContent: "To eat bread you need nothing but good taste" },
];
const query = "What do you need to bake bread?";
const result = await reranker.compressDocuments(documents, query);
console.log(result);

更多资源

如需更多信息，请参阅 重排序 API 文档.