`$rerank` 聚合管道阶段

$rerank: $rerank 阶段使用 Voyage AI 的重新排名模型对输入文档重新排序，并返回按与查询的相关性排序的相同文档。 $rerank 阶段可以出现在聚合管道中的任何位置。 MongoDB建议您在$vectorSearch、$search、$rankFusion 或 $scoreFusion 阶段之后使用 $rerank。

语法

$rerank管道阶段采用以下语法：

{
  "$rerank": {
    "query": {
      "text": "<query-text>"
    },
    "path": "<text-field-name>",
    "numDocsToRerank": <number-of-documents-to-rerank>,
    "model": "<reranker-model>"
  }
}

字段

$rerank 阶段采用包含以下字段的文档：

字段	类型	必要性	说明
`query`	对象	必需	用于重新排名的查询。
`query.` `text`	字符串	必需	用于重新排名的查询文本。示例，您可以指定：您正在搜索的内容文档的哪些字段最相关用于澄清歧义查询的补充信息
`path`	字符串或字符串数组	必需	用于重新排名的字段的路径。如果 `$rerank` 是中间阶段，请指定前一阶段结果中的字段。注意：如果 `path` 中指定的字段不存在，则 `$rerank`查询将失败。使用先前的 `$match` 阶段过滤掉缺失字段的文档，或使用 `$set` 将缺失字段设立为 `""`。
`numDocsToRerank`	Int	必需	发送到 Voyage AI进行重新排名并在结果中返回的最大文档数。根据管道定义的文档顺序选择文档。最大值必须小于或等于 `1000`。
`model`	对象	必需	用于对文档重新排名的 Voyage AI模型。值可以是以下模型之一： `rerank-3` - 最高精度的通才重排序器。推荐用于大多数应用。 `rerank-3-lite` - 快速且经济高效的重排序器针对延迟敏感的应用程序进行了优化。 `rerank-2.5` - 通过指令跟踪和多语言支持对质量进行了优化的 Generalist reranker。 `rerank-2.5-lite` - 通过指令跟踪和多语言支持，针对延迟和质量优化了 Generalist reranker。 `rerank-2` — 旧版模型。 `rerank-2-lite` — 旧版模型。 `rerank-3` 和 `rerank-3-lite` 模型作为预览功能提供，需要运行MongoDB 9.0 或更高版本的专用集群。要学习；了解更多信息，请参阅要求。

Considerations

在使用 $rerank 之前，请查看要求、限制和 $rerank 行为。

要求

要使用 $rerank：

确保您的集群运行的是MongoDB 9.0 或更高版本。
通过 Project Settings 启用原生重排名。要了解更多信息，请参阅启用或禁用原生重排名。

rerank-3 和 rerank-3-lite 模型还有以下额外要求：

您的集群必须是运行MongoDB 9.0 或更高版本的专用集群（M10 或更高版本）。

要学习；了解这些模型的支持状态，请参阅当前模型状态。

限制

您不能使用 $rerank 阶段：

适用于自管理或 Atlas Local 部署。
对于 $rankFusion 或 $scoreFusion 输入管道。
用于对视图进行查询。

如果您在视图上有 MongoDB Search 或 MongoDB Vector Search 索引，请在源集合上运行 .aggregate() 而不是视图来查询索引。

rerank-3 和 rerank-3-lite 模型还有以下额外限制：

仅适用于运行MongoDB 9.0 或更高版本的专用集群（M10 或更高版本）。
尚不适用于免费集群 (M0) 或 Flex 集群。

行为

$rerank 可以出现在管道中的任何位置。但是， MongoDB建议在已按排序顺序返回相关文档的 $search 或 $vectorSearch 等阶段之后使用 $rerank。

$rerank 重新排序并返回传递到此阶段的前 numDocsToRerank 个文档。如果 $rerank 是第一阶段，或者先前的阶段未返回确定性排序的结果，则用于 $rerank 的文档可能会在查询之间发生变化。

$rerank 如果 path 中指定的任何字段在一个或多个输入文档中不存在，则返回错误。为了缓解这一问题，请使用：

$set 阶段将缺失字段设置为空字符串。
$match 阶段可用于过滤掉缺少字段的文档。

查询

query.text字段确定重排序模型如何对每个文档进行评分。指定的 Voyage 重排序器模型在指定的 path 处计算查询文本与每个文档内容之间的相关性分数。对于大多数使用案例，将 $rerank.query.text设立为与前面的 $search 或 $vectorSearch 阶段中的查询相同或相似的文本。

评分

使用 score 变量和 $meta表达式检索$rerank 阶段结果中每个文档的分数。

示例：将重新排名分数添加到管道

{
  "$addFields": {
    "rerankScore": { "$meta": "score" }
  }
}

$rerank 阶段将 $meta: "score" 的值替换为新分数。要保留 $rankFusion 等前一阶段的值，您可以在 $rerank 阶段之前将分数项目到命名字段中。

示例：保留前一阶段的分数

{
  "$addFields": {
    "originalRankFusionScore": { "$meta": "score" }
  }
},
{
  "$rerank": {
    ...
  }
},
{
  "$addFields": {
    "rerankScore": { "$meta": "score" }
  }
}

性能与准确性

$rerank 阶段的计算成本可能很高，具体取决于输入的大小，例如要重新排名的字段、要重新排名的文档数量以及查询文本。 $rerank 在查询时联合处理查询和文档。因此，$rerank 可能比由...提供支持索引（例如 $search 或 $vectorSearch 的索引）支持的相关性搜索慢。要平衡准确性和性能，请配置 numDocsToRerank 和 path 以限制输入大小。 $rerank 不会在您的Atlas 集群资源上运行Voyage AI重排名模型。

$rerank 最适合在资源检索质量优先于超低延迟的工作负载，例如 RAG 和代理 AI 应用程序。对于需要超低延迟的工作负载，MongoDB 建议使用索引驱动的搜索阶段，例如 $search 或 $vectorSearch。

例子

以下示例演示了如何使用 $rerank 阶段根据 Voyage AI重排序器模型对 sample_mflix.embedded_movies集合中的文档重新排序。查询在 $match 阶段之后使用 $rerank，使用 rerank-2.5 重排序器模型对文档重新排序。在以下聚合管道中：

$match 阶段筛选文档，以仅包含具有 string 类型的 plot字段的文档。
$sort 阶段按 released字段的降序对文档进行排序，以确保确定性的排序。
$rerank 阶段使用 rerank-2.5 重排序器模型对文档重新排序以匹配查询。
$addFields 阶段将名为 rerankScore 的字段添加到文档中。

1 db.embedded_movies.aggregate([
2   {
3     "$match": {
4       "plot": { "$exists": true, "$type": "string" }
5     }
6   },
7   {
8     "$sort": { "released": -1 }
9   },
10   {
11     "$rerank": {
12       "model": "rerank-2.5",
13       "query": {
14         "text": "a group of heroes band together to stop a powerful enemy and save the world"
15       },
16       "numDocsToRerank": 100,
17       "path": ["title", "plot"]
18     }
19   },
20   {
21     "$addFields": {
22       "rerankScore": { "$meta": "score" }
23     }
24   },
25   { "$limit": 10 },
26   {
27     "$project": {
28       "_id": 0,
29       "title": 1,
30       "plot": 1,
31       "rerankScore": 1
32     }
33   }
34 ])

[
  {
    plot: 'No treason, no surrender.',
    title: 'Ti mene nosis',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'The life of the greatest karate master of a generation.',
    title: 'The Real Miyagi',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'A shy genius is employed by his former university to design robot software.',
    title: 'Eva',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'The owners of a failing security company start robbing houses to boost business.',
    title: 'Armed Response',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'A live telecast of the beloved J. M. Barrie story.',
    title: 'Peter Pan Live!',
    rerankScore: 0.5986876487731934
  },
  {
    plot: "A French police magistrate spends years trying to take down one of the country's most powerful drug rings.",
    title: 'The Connection',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'A documentary that follows undercover activists trying to stave off a man-made mass extinction.',
    title: 'Racing Extinction',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'An ex-hitman comes out of retirement to track down the gangsters that took everything from him.',
    title: 'John Wick',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'A former hit-man for a drug cartel becomes a vigilante to pay for his sins and find redemption.',
    title: 'Redeemer',
    rerankScore: 0.5986876487731934
  },
  {
    plot: 'Charles Ingvar Jènsson gathers three criminals to take vengeance upon the people who killed his uncle.',
    title: 'The Master Plan',
    rerankScore: 0.5986876487731934
  }
]

1	db.embedded_movies.aggregate([
2	{
3	"$match": {
4	"plot": { "$exists": true, "$type": "string" }
5	}
6	},
7	{
8	"$sort": { "released": -1 }
9	},
10	{
11	"$rerank": {
12	"model": "rerank-2.5",
13	"query": {
14	"text": "a group of heroes band together to stop a powerful enemy and save the world"
15	},
16	"numDocsToRerank": 100,
17	"path": ["title", "plot"]
18	}
19	},
20	{
21	"$addFields": {
22	"rerankScore": { "$meta": "score" }
23	}
24	},
25	{ "$limit": 10 },
26	{
27	"$project": {
28	"_id": 0,
29	"title": 1,
30	"plot": 1,
31	"rerankScore": 1
32	}
33	}
34	])

$rerank 聚合管道阶段

语法

字段

Considerations

要求

限制

行为

查询

评分

性能与准确性

例子

`$rerank` 聚合管道阶段