Method Rerank

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Rerank<TInput, TField, TOutput>(PipelineDefinition<TInput, TOutput>, RerankQuery, Expression<Func<TOutput, TField>>, int, string)

Appends a $rerank stage to the pipeline.

public static PipelineDefinition<TInput, TOutput> Rerank<TInput, TField, TOutput>(this PipelineDefinition<TInput, TOutput> pipeline, RerankQuery query, Expression<Func<TOutput, TField>> path, int numDocsToRerank, string model)

Parameters

pipeline PipelineDefinition<TInput, TOutput>

The pipeline.

query RerankQuery

The rerank query.

path Expression<Func<TOutput, TField>>

The field to send to the reranker.

numDocsToRerank int

The maximum number of documents to rerank.

model string

The reranking model name.

Returns

PipelineDefinition<TInput, TOutput>

A new pipeline with an additional stage.

Type Parameters

TInput

The type of the input documents.

TField

The type of the field.

TOutput

The type of the output documents.

Rerank<TInput, TOutput>(PipelineDefinition<TInput, TOutput>, RerankQuery, FieldDefinition<TOutput>, int, string)

Appends a $rerank stage to the pipeline.

public static PipelineDefinition<TInput, TOutput> Rerank<TInput, TOutput>(this PipelineDefinition<TInput, TOutput> pipeline, RerankQuery query, FieldDefinition<TOutput> path, int numDocsToRerank, string model)

Parameters

pipeline PipelineDefinition<TInput, TOutput>

The pipeline.

query RerankQuery

The rerank query.

path FieldDefinition<TOutput>

The field to send to the reranker.

numDocsToRerank int

The maximum number of documents to rerank.

model string

The reranking model name.

Returns

PipelineDefinition<TInput, TOutput>

A new pipeline with an additional stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

Rerank<TInput, TOutput>(PipelineDefinition<TInput, TOutput>, RerankQuery, IEnumerable<FieldDefinition<TOutput>>, int, string)

Appends a $rerank stage to the pipeline.

public static PipelineDefinition<TInput, TOutput> Rerank<TInput, TOutput>(this PipelineDefinition<TInput, TOutput> pipeline, RerankQuery query, IEnumerable<FieldDefinition<TOutput>> paths, int numDocsToRerank, string model)

Parameters

pipeline PipelineDefinition<TInput, TOutput>

The pipeline.

query RerankQuery

The rerank query.

paths IEnumerable<FieldDefinition<TOutput>>

The fields to send to the reranker.

numDocsToRerank int

The maximum number of documents to rerank.

model string

The reranking model name.

Returns

PipelineDefinition<TInput, TOutput>

A new pipeline with an additional stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.