GitHub

Re-ranking Operations

Improve search result quality with LLM-powered re-ranking. Use chain-of-thought reasoning to reorder documents based on relevance, recency, diversity, or custom strategies.

Why Re-ranking?

Vector search alone optimizes for semantic similarity, which may not align with actual relevance. LLM re-ranking adds contextual understanding, reasoning about which results truly answer the query.
POST

/api/v1/rerank

Basic re-ranking endpoint using LLM chain-of-thought reasoning. Supports listwise and pointwise methods with configurable relevance thresholds.

Request Parameters

ParameterTypeRequiredDescription
querystringYesQuery for re-ranking context
documentsarrayYesDocuments to re-rank (must include id and content fields)
methodstringNoRe-ranking method: listwise or pointwise (default: listwise)
top_kintegerNoNumber of top results to return (1-50, default: 10)
min_scoreintegerNoMinimum relevance score threshold (0-10, default: 5)

Response Fields

FieldTypeDescription
labelsarraySorted list of re-ranked documents with scores
labels[].idintegerOriginal document ID (index in input array)
labels[].cotstringChain-of-thought reasoning (1-2 sentences)
labels[].scoreintegerRelevance score (0-10)

Re-ranking Methods

MethodDescriptionBest For
listwiseEvaluates all documents together in contextBetter ranking quality, optimal for <20 documents
pointwiseScores each document independentlyFaster processing, scales to more documents
POST

/api/v1/rerank/enhanced

Advanced re-ranking with quality filtering, deduplication, multiple strategies, and comprehensive analytics. Supports custom weighting, personalization, and batch processing.

Request Parameters

ParameterTypeRequiredDescription
querystringYesQuery for re-ranking
documentsarrayYesDocuments to re-rank
methodstringNoMethod: listwise, pointwise, pairwise, hybrid, ensemble (default: listwise)
strategystringNoStrategy: relevance, diversity, recency, quality, custom (default: relevance)
top_kintegerNoTop results to return (1-100, default: 10)
min_scorenumberNoMinimum relevance score threshold (0-1, default: 0.3)
enable_quality_filteringbooleanNoEnable quality-based filtering (default: true)
enable_deduplicationbooleanNoRemove duplicate content (default: false)
diversity_thresholdnumberNoContent diversity threshold (0-1, default: 0.8)
boost_recentbooleanNoBoost recent documents (default: false)
date_fieldstringNoField name for document dates
include_reasoningbooleanNoInclude LLM reasoning (default: true)
output_formatstringNoFormat: standard, detailed, compact (default: standard)

Re-ranking Strategies

StrategyDescriptionUse Case
relevancePure semantic relevance to queryStandard search results
diversityMaximize content diversity in resultsAvoid redundant results, exploratory search
recencyFavor recent documentsNews, time-sensitive content
qualityPrioritize high-quality sourcesResearch, authoritative content
customCustom weighting via score_weights parameterDomain-specific ranking needs

Quality Features

Enhanced re-ranking includes automatic quality assessment:

  • Deduplication: Remove near-duplicate content using cosine similarity
  • Quality Filtering: Filter out low-quality or incomplete documents
  • Diversity Scoring: Measure content diversity in final results
  • Boost Functions: Amplify recent or viewed documents
  • Batch Processing: Efficient handling of large document sets
Custom Weighting Example
# Define custom scoring weights
result = client.reranking.enhanced_rerank(
query="Best machine learning frameworks",
documents=documents,
strategy="custom",
score_weights={
"relevance": 0.5,
"recency": 0.3,
"quality": 0.2
},
boost_recent=True,
enable_quality_filtering=True
)
# Results balanced between relevance, recency, and quality

Basic vs Enhanced Re-ranking

FeatureBasicEnhanced
Re-ranking MethodsListwise, PointwiseListwise, Pointwise, Pairwise, Hybrid, Ensemble
StrategiesRelevance onlyRelevance, Diversity, Recency, Quality, Custom
Quality FilteringNoYes, configurable
DeduplicationNoYes, with similarity threshold
Max Documents50100
AnalyticsBasic scoresComprehensive metrics and statistics
PersonalizationNoUser preferences and context
Processing TimeFasterSlower (more features)

Best Practices

  • Document Structure: Ensure documents have unique IDs and meaningful content fields
  • Batch Size: For basic re-ranking, limit to 20 documents for best quality
  • Method Selection: Use listwise for smaller sets (<20), pointwise for larger
  • Strategy Choice: Match strategy to use case (recency for news, quality for research)
  • Deduplication: Enable for user-generated content or web scraping results
  • Score Thresholds: Tune min_score based on your quality requirements
  • Date Fields: Include date metadata when using recency boosting
  • Caching: Re-rank results can be cached for identical queries
Re-ranking adds 200-500ms latency depending on document count and method. For real-time applications, consider caching results or using pointwise method for faster processing.