rerank

package
v1.1.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 6, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package rerank provides reranking steps for RAG retrieval pipelines.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CrossEncoderRerank

func CrossEncoderRerank(reranker core.Reranker, topK int, logger logging.Logger, metrics core.Metrics) pipeline.Step[*core.RetrievalContext]

CrossEncoderRerank creates a cross-encoder reranking step.

func Order

func Order(
	enhancer core.ResultEnhancer,
	logger logging.Logger,
	metrics core.Metrics,
) pipeline.Step[*core.RetrievalContext]

Order creates a new reranking step.

func ParentDocExpand

func ParentDocExpand(expander core.ResultEnhancer, logger logging.Logger, metrics core.Metrics) pipeline.Step[*core.RetrievalContext]

ParentDocExpand creates a parent document expansion step with logger and metrics.

Parameters:

  • expander: result enhancer implementation for expanding chunks
  • logger: structured logger (auto-defaults to NoopLogger if nil)
  • metrics: metrics collector (optional, can be nil)

Example:

p.AddStep(rerank.ParentDocExpand(expander, logger, metrics))

func Score

func Score(
	reranker core.Reranker,
	topK int,
	logger logging.Logger,
	metrics core.Metrics,
) pipeline.Step[*core.RetrievalContext]

Score creates a new reranking step with logger and metrics.

Parameters:

  • reranker: cross-encoder reranker implementation
  • topK: number of results to keep after reranking (default: 5)
  • logger: structured logger (auto-defaults to NoopLogger if nil)
  • metrics: metrics collector (optional, can be nil)

Example:

p.AddStep(rerank.Score(reranker, 10, logger, metrics))

func SentenceWindowExpand

func SentenceWindowExpand(expander core.ResultEnhancer, logger logging.Logger, metrics core.Metrics) pipeline.Step[*core.RetrievalContext]

SentenceWindowExpand creates a sentence window expansion step with logger and metrics.

Parameters:

  • expander: result enhancer implementation for expanding chunks with sentence context
  • logger: structured logger (auto-defaults to NoopLogger if nil)
  • metrics: metrics collector (optional, can be nil)

Example:

p.AddStep(rerank.SentenceWindowExpand(expander, logger, metrics))

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL