API Reference

Below is an overview of the modules, classes, and functions available in Rankify v0.1.4.

Dataset Module

• Dataset

Metrics Module

• Metrics

Retrievers

• Retriever - Unified retriever interface
• BM25 Retriever - Sparse retrieval
• Dense Retriever (DPR) - Dense Passage Retrieval
• ANCE Retriever - Approximate Nearest Neighbor Negative Contrastive Estimation
• BGE Retriever - BAAI General Embedding
• ColBERT Retriever - Late interaction retrieval
• Contriever Retriever - Contrastive retriever
• Online Retriever - Real-time web retrieval
• HyDE Retriever - Hypothetical Document Embeddings

Indexing Module

• Indexing - Build custom search indices

Rerankers

Main Interface

• Reranking - Unified reranking interface
• Base - Base reranker class

Pointwise Rerankers

• MonoBERT - BERT-based pointwise reranker
• MonoT5 - T5-based pointwise reranker
• UPR - Unsupervised Passage Reranker

Pairwise Rerankers

• RankGPT - GPT-based pairwise reranking
• InRanker - Instruction-based reranker
• EchoRank - Echo-based reranking

Listwise Rerankers

• RankT5 - T5-based listwise reranker
• ListT5 - Listwise T5 reranker
• LiT5 - Lightweight T5 reranker
• Transformer Reranker - Cross-encoder rerankers

API-Based Rerankers

• API Reranker - Cohere, Jina, Voyage, MixedBread.ai

LLM-Based Rerankers

• First Reranker - First model reranker
• Incontext Reranker - In-context learning reranker
• Vicuna Reranker - Vicuna-based reranker
• Zephyr Reranker - Zephyr-based reranker

Embedding-Based Rerankers

• ColBERT Reranker - ColBERT for reranking
• Sentence Transformer - Sentence transformer reranker
• SPLADE Reranker - Sparse reranker
• LLM2Vec Reranker - LLM to vector reranker
• LLM Layerwise - Layerwise LLM reranker

Other Rerankers

• FlashRank - Fast ONNX-based reranker
• Blender Reranker - PairRM blender
• TwoLAR - Two-stage listwise reranker
• Rank FiD - Fusion-in-Decoder reranker

Generator Module

Main Interface

• Generator - Unified generator interface
• Prompt Generator
• Prompt Template

LLM Endpoints

• Base RAG Model
• Model Factory
• HuggingFace Model
• LiteLLM Model
• OpenAI Model
• vLLM Model
• FiD Model

RAG Methods

• Base RAG Method
• Zero-Shot RAG
• Basic RAG
• Chain-of-Thought RAG
• Self-Consistency RAG
• ReAct RAG
• Fusion-in-Decoder
• In-Context RALM

Tools Module

• Tools - WebSearchTool and agent utilities