Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs

$rerank Estágio do pipeline de agregação

Importante

A reclassificação nativa está disponível como um recurso de visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de pré-visualização. Portanto, não recomendamos o uso desse recurso em ambientes de produção. Não usamos nenhum dado do cliente desse recurso para treinar nossos modelos neste momento. Para aprender mais, consulte Recursos de visualização.

$rerank

O estágio $rerank reordena 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 $rerank pode aparecer em qualquer lugar em um pipeline de agregação. O MongoDB recomenda que você use $rerank após um estágio $vectorSearch, $search, $rankFusion ou $scoreFusion.

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>"
}
}

O estágio $rerank recebe um documento com os seguintes campos:

Campo
Tipo
necessidade
Descrição

query

Objeto

Obrigatório

Query a ser usada para reclassificação.

query.
text

String

Obrigatório

Texto da query a ser usado para reclassificação. Por exemplo, você pode especificar:

  • O que você está procurando

  • Quais campos de um documento são mais relevantes

  • Informações complementares para esclarecer queries ambíguas

path

string ou matriz de strings

Obrigatório

Caminho para os campos a serem usados na reclassificação. Se $rerank for um estágio intermediário, especifique um campo a partir dos resultados do estágio anterior.

NOTA: a query $rerank falhará se os campos especificados em path não existirem. Use um estágio $match anterior para filtrar documentos com campos ausentes ou use $set para definir campos ausentes como "".

numDocsToRerank

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 1000.

model

Objeto

Obrigatório

Voyage AI modelo para usar para reclassificar os documentos. O valor pode ser um dos seguintes modelos:

  • rerank-2.5 - Reclassificação generalista otimizada para qualidade com suporte a instruções e multilíngue.

  • rerank-2.5-lite - Reclassificação generalista otimizada para latência e qualidade com acompanhamento de instruções e suporte multilíngue.

  • rerank-2 - Modelo legado.

  • rerank-2-lite - Modelo legado.

Revise os requisitos, limitações e o comportamento $rerank antes de usar $rerank.

Para usar $rerank:

  • Verifique se o cluster está executando o MongoDB 8.3 ou posterior selecionando Latest version with auto-upgrades na página Cluster Builder da IU do Atlas.

  • Habilite a reclassificação nativa por meio de Project Settings. Para saber mais, consulte Habilitar ou desabilitar a reclassificação nativa.

Você não pode usar o estágio $rerank:

  • Para implantações autogerenciadas ou Atlas Local.

  • Para $rankFusion ou $scoreFusion pipeline 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.

$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:

  • $set estágio para definir campos ausentes como uma string vazia.

  • $match estágio para filtrar documentos onde os campos estão ausentes.

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.

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" }
}
}

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.

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 ,:

  • $match O estágio filtra os documentos para incluir somente documentos que tenham um campo plot do tipo string.

  • $sort O estágio classifica os documentos em ordem decrescente do campo released para garantir a ordem determinística.

  • $rerank o estágio reordena os documentos para corresponder à query usando o modelo de reclassificação rerank-2.5.

  • $addFields estágio adiciona um campo chamado rerankScore aos documentos.

1db.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
}
]