$rerankO estágio
$rerankreordena os documentos de entrada usando os modelos de reclassificação do Voyage AI e retorna os mesmos documentos classificados por relevância para a query. O estágio$rerankpode aparecer em qualquer lugar em um pipeline de agregação. O MongoDB recomenda que você use$rerankapós um estágio$vectorSearch,$search,$rankFusionou$scoreFusion.
Sintaxe
Um estágio de pipeline do $rerank tem a seguinte sintaxe:
{ "$rerank": { "query": { "text": "<query-text>" }, "path": "<text-field-name>", "numDocsToRerank": <number-of-documents-to-rerank>, "model": "<reranker-model>" }}Campos
O estágio $rerank recebe um documento com os seguintes campos:
Campo | Tipo | necessidade | Descrição |
|---|---|---|---|
| Objeto | Obrigatório | Query a ser usada para reclassificação. |
| String | Obrigatório | Texto da query a ser usado para reclassificação. Por exemplo, você pode especificar:
|
| string ou matriz de strings | Obrigatório | Caminho para os campos a serem usados na reclassificação. Se NOTA: a query |
| Int | Obrigatório | Número máximo de documentos a serem enviados à IA do Voyage para reclassificação e retorno nos resultados. Os documentos são selecionados com base na ordem dos documento definida para o pipeline. O valor máximo deve ser menor ou igual a |
| Objeto | Obrigatório | Voyage AI modelo para usar para reclassificar os documentos. O valor pode ser um dos seguintes modelos:
Os modelos |
Considerações
Revise os requisitos, limitações e o comportamento $rerank antes de usar $rerank.
Requisitos
Para usar $rerank:
Certifique-se de que seu cluster esteja executando o MongoDB 9.0 ou posterior.
Habilite a reclassificação nativa por meio de Project Settings. Para saber mais, consulte Habilitar ou desabilitar a reclassificação nativa.
Os modelos rerank-3 e rerank-3-lite têm os seguintes requisitos adicionais:
- Seu cluster deve ser um cluster dedicado (
M10ou superior) executando o MongoDB 9.0 ou posterior.
Para aprender sobre o status de suporte desses modelos, consulte Status atual do modelo.
Limitações
Você não pode usar o estágio $rerank:
Para implantações autogerenciadas ou Atlas Local.
Para
$rankFusionou$scoreFusionpipeline de entrada.Para query em uma View.
Se você tiver um índice MongoDB Search ou MongoDB pesquisa vetorial em uma View, consulte o índice executando
.aggregate()na coleção de origem em vez da View.Com a criptografia no nível do campo do lado do cliente ou a Queryable Encryption. Um pipeline que contém
$rerankfalha com um erro comoUnrecognized pipeline stage name: '$rerank'.Essa limitação se aplica a todas as coleção, incluindo coleção que não têm campo criptografado, e ao uso de
$rerankdentro de sub-pipeline, como$unionWith.
Os modelos rerank-3 e rerank-3-lite têm as seguintes limitações adicionais:
Disponível apenas em cluster dedicado (
M10ou superior) executando o MongoDB 9.0 ou posterior.Ainda não disponível em clusters gratuitos (
M0) ou clusters Flex.
Comportamento
$rerank pode aparecer em qualquer lugar no pipeline. No entanto, o MongoDB recomenda usar $rerank após um estágio como $search ou $vectorSearch que já retorna documentos relevantes em ordem classificada.
$rerank reclassifica e retorna os primeiros numDocsToRerank documentos que são passados para o estágio. Se $rerank for o primeiro estágio, ou se os estágios anteriores não retornarem resultados classificados deterministicamente, os documentos usados para $rerank poderão mudar entre as queries.
$rerank retorna um erro se algum dos campos especificados em path não estiver presente em um ou mais documentos de entrada. Para mitigar isso, use o:
$setestágio para definir campos ausentes como uma string vazia.$matchestágio para filtrar documentos onde os campos estão ausentes.
Para aprender mais sobre os limites de memória que o $rerank força e os erros que ele retorna quando uma solicitação excede um limite, consulte A solicitação $rerank falha com um erro de limite de memória.
Query
O campo query.text determina como o modelo de reranker pontua cada documento. O modelo de reranker Voyage especificado calcula uma pontuação de relevância entre o texto da query e o conteúdo de cada documento no path especificado. Para a maioria dos casos de uso, defina $rerank.query.text como o mesmo texto ou texto semelhante à query do estágio $search ou $vectorSearch anterior.
Pontuação
Use a variável score com a expressão $meta para recuperar a pontuação de cada documento nos resultados do estágio $rerank.
Exemplo: adicionar pontuação de reclassificação ao pipeline
{ "$addFields": { "rerankScore": { "$meta": "score" } }}O estágio $rerank substitui o valor de $meta: "score" por uma nova pontuação. Para preservar o valor de um estágio anterior como $rankFusion, você pode projeto as pontuações em campos nomeados antes do estágio $rerank.
Exemplo: Preservar pontuação do estágio anterior
{ "$addFields": { "originalRankFusionScore": { "$meta": "score" } }},{ "$rerank": { ... }},{ "$addFields": { "rerankScore": { "$meta": "score" } }}Desempenho e precisão
O estágio $rerank pode ser computacionalmente caro, dependendo do tamanho da entrada, como os campos para reclassificar, o número de documentos para reclassificar e o texto da query. $rerank processa queries e documentos em conjunto no momento da query. Portanto, $rerank pode ser mais lento do que a pesquisa de relevância alimentada por um índice, como os índices para $search ou $vectorSearch. Para equilibrar a precisão e o desempenho, configure numDocsToRerank e path para limitar o tamanho da entrada. $rerank não executa modelos de reclassificação do Voyage AI nos recursos do cluster Atlas.
$rerank é mais adequado para cargas de trabalho em que a qualidade de recuperação é priorizada em relação à latência ultrabaixa, como RAG e aplicativos de IA agentic. Para cargas de trabalho que exigem latência ultrabaixa, o MongoDB recomenda usar um estágio de pesquisa baseado em índice, como $search ou $vectorSearch.
Exemplo
O exemplo a seguir demonstra como usar o estágio $rerank para reordenar documentos na coleção sample_mflix.embedded_movies com base em um modelo de reclassificação do Voyage AI. A query usa $rerank após o estágio $match para reordenar documentos usando o modelo de reclassificação rerank-2.5. No seguinte pipeline de agregação ,:
$matchO estágio filtra os documentos para incluir somente documentos que tenham um campoplotdo tipo string.$sortO estágio classifica os documentos em ordem decrescente do camporeleasedpara garantir a ordem determinística.$reranko estágio reordena os documentos para corresponder à query usando o modelo de reclassificaçãorerank-2.5.$addFieldsestágio adiciona um campo chamadorerankScoreaos documentos.
db.embedded_movies.aggregate([ { "$match": { "plot": { "$exists": true, "$type": "string" } } }, { "$sort": { "released": -1 } }, { "$rerank": { "model": "rerank-2.5", "query": { "text": "a group of heroes band together to stop a powerful enemy and save the world" }, "numDocsToRerank": 100, "path": ["title", "plot"] } }, { "$addFields": { "rerankScore": { "$meta": "score" } } }, { "$limit": 10 }, { "$project": { "_id": 0, "title": 1, "plot": 1, "rerankScore": 1 } }])