Routir

User Guide

  • Getting Started
    • Installation
    • Starting the Service
    • Configuration
    • HTTP API
      • 1. Available services
      • 2. Search an index
      • 3. Score/Rerank
      • 4. Search with dynamic pipeline
    • Extension Examples
      • PyTerrier
      • Pyserini
      • Rank1
    • Other Helper Scripts

API Reference

  • Models
    • Base Classes
      • Engine
        • Engine.name
        • Engine.config
        • Engine.index_path
        • Engine.__init__()
        • Engine.search_batch()
        • Engine.search()
        • Engine.score_batch()
        • Engine.score()
        • Engine.decompose_query_batch()
        • Engine.decompose_query()
        • Engine.fuse_batch()
        • Engine.fuse()
        • Engine.can_search
        • Engine.can_score
        • Engine.can_decompose_query
        • Engine.can_fuse
      • Reranker
        • Reranker.upstream
        • Reranker.text_service
        • Reranker.rerank_topk_max
        • Reranker.rerank_multiplier
        • Reranker.__init__()
        • Reranker.get_text()
        • Reranker.search_batch()
      • Aggregation
        • Aggregation.mapping
        • Aggregation.__init__()
        • Aggregation.__contains__()
        • Aggregation.__getitem__()
        • Aggregation.maxp()
        • Aggregation.n_docs
        • Aggregation.__len__()
    • PLAID-X (ColBERT)
      • colbert_all_pair_scores()
      • PLAIDX
        • PLAIDX.colbert_config
        • PLAIDX.searcher
        • PLAIDX.passage_mapper
        • PLAIDX.subset_mapper
        • PLAIDX.inference_batch_size
        • PLAIDX.__init__()
        • PLAIDX.filter_subset()
        • PLAIDX.search_batch()
        • PLAIDX.score_batch()
    • LSR (SPLADE)
      • LSR
        • LSR.anserini
        • LSR.model
        • LSR.subset_mapper
        • LSR.__init__()
        • LSR.filter_subset()
        • LSR.search_batch()
    • mT5
      • MT5Reranker
        • MT5Reranker.prompt
        • MT5Reranker.model
        • MT5Reranker.tokenizer
        • MT5Reranker.q_max_length
        • MT5Reranker.d_max_length
        • MT5Reranker.batch_size
        • MT5Reranker.token_false_id
        • MT5Reranker.token_true_id
        • MT5Reranker.prompt
        • MT5Reranker.__init__()
        • MT5Reranker.tokenize_pairs()
        • MT5Reranker.forward()
        • MT5Reranker.score()
    • Qwen3
    • Relay
    • Fusion
      • Fusion
        • Fusion.upstream
        • Fusion.fusion_function
        • Fusion.fusion_args
        • Fusion.__init__()
        • Fusion.search_batch()
      • RRF
        • RRF.fuse_batch()
      • ScoreFusion
        • ScoreFusion.fuse_batch()
    • LLM Rerankers
  • Processors
    • Base Classes
      • Processor
        • Processor.cache
        • Processor.cache_key
        • Processor.__init__()
        • Processor.start()
        • Processor.submit()
      • BatchProcessor
        • BatchProcessor.__init__()
        • BatchProcessor.start()
    • Query Processors
      • AsyncQueryProcessor
        • AsyncQueryProcessor.__init__()
      • BatchQueryProcessor
        • BatchQueryProcessor.__init__()
    • Content Processors
      • ContentProcessor
        • ContentProcessor.config
        • ContentProcessor.line_reader
        • ContentProcessor.content_field
        • ContentProcessor.lang_mapping
        • ContentProcessor.__init__()
    • Score Processors
      • AsyncPairwiseScoreProcessor
        • AsyncPairwiseScoreProcessor.__init__()
      • BatchPairwiseScoreProcessor
        • BatchPairwiseScoreProcessor.__init__()
    • Cache
      • Cache
        • Cache.__init__()
        • Cache.get()
        • Cache.put()
        • Cache.remove()
        • Cache.clear()
        • Cache.__len__()
        • Cache.connect()
        • Cache.close()
        • Cache.__aenter__()
        • Cache.__aexit__()
      • LRUCache
        • LRUCache.__init__()
        • LRUCache.get()
        • LRUCache.put()
        • LRUCache.remove()
        • LRUCache.clear()
        • LRUCache.__len__()
      • RedisCache
        • RedisCache.__init__()
        • RedisCache.connect()
        • RedisCache.close()
        • RedisCache.get()
        • RedisCache.put()
        • RedisCache.remove()
        • RedisCache.clear()
        • RedisCache.__len__()
    • File Random Access Reader
    • Registry
      • DummyProcessor
        • DummyProcessor.__init__()
        • DummyProcessor.submit()
      • auto_register()
  • Pipeline
    • Pipeline Module
      • SearchPipeline
        • SearchPipeline.pipeline
        • SearchPipeline.collection
        • SearchPipeline.runtime_kwargs
        • SearchPipeline.doc_content_cache
        • SearchPipeline.__init__()
        • SearchPipeline.verify()
        • SearchPipeline.from_string()
        • SearchPipeline.get_doc_content()
        • SearchPipeline.run()
    • Parser
      • SystemCall
        • SystemCall.name
        • SystemCall.alias
        • SystemCall.limit
        • SystemCall.role
        • SystemCall.all_calls
        • SystemCall.as_role()
        • SystemCall.__init__()
      • CallSequence
        • CallSequence.stages
        • CallSequence.all_calls
        • CallSequence.as_role()
        • CallSequence.__init__()
      • ParallelCallSequences
        • ParallelCallSequences.sequences
        • ParallelCallSequences.merger
        • ParallelCallSequences.expander
        • ParallelCallSequences.all_calls
        • ParallelCallSequences.as_role()
        • ParallelCallSequences.__init__()
      • PipelineTransformer
        • PipelineTransformer.seq()
        • PipelineTransformer.system_call()
        • PipelineTransformer.alias()
        • PipelineTransformer.parallel_seq()
        • PipelineTransformer.stage()
        • PipelineTransformer.seq_list()
  • Configuration
    • Config Module
      • ServiceConfig
        • ServiceConfig.name
        • ServiceConfig.engine
        • ServiceConfig.config
        • ServiceConfig.processor
        • ServiceConfig.cache
        • ServiceConfig.batch_size
        • ServiceConfig.cache_ttl
        • ServiceConfig.max_wait_time
        • ServiceConfig.cache_key_fields
        • ServiceConfig.cache_redis_url
        • ServiceConfig.cache_redis_kwargs
        • ServiceConfig.scoring_disabled
        • ServiceConfig.name
        • ServiceConfig.engine
        • ServiceConfig.config
        • ServiceConfig.processor
        • ServiceConfig.cache
        • ServiceConfig.batch_size
        • ServiceConfig.cache_ttl
        • ServiceConfig.max_wait_time
        • ServiceConfig.cache_key_fields
        • ServiceConfig.cache_redis_url
        • ServiceConfig.cache_redis_kwargs
        • ServiceConfig.scoring_disabled
        • ServiceConfig.model_config
      • ColllectionConfig
        • ColllectionConfig.name
        • ColllectionConfig.doc_path
        • ColllectionConfig.offset_source
        • ColllectionConfig.id_field
        • ColllectionConfig.content_field
        • ColllectionConfig.id_to_lang_mapping
        • ColllectionConfig.cache_path
        • ColllectionConfig.name
        • ColllectionConfig.doc_path
        • ColllectionConfig.offset_source
        • ColllectionConfig.id_field
        • ColllectionConfig.content_field
        • ColllectionConfig.id_to_lang_mapping
        • ColllectionConfig.cache_path
        • ColllectionConfig.model_post_init()
        • ColllectionConfig.model_config
      • Config
        • Config.services
        • Config.collections
        • Config.server_imports
        • Config.file_imports
        • Config.dynamic_pipeline
        • Config.services
        • Config.collections
        • Config.server_imports
        • Config.file_imports
        • Config.dynamic_pipeline
        • Config.model_config
    • Config Loader
  • Utilities
    • Faiss Indexing
    • Extensions
      • load_all_extensions()
    • Lazy Import
      • LazyImportFinder
        • LazyImportFinder.__init__()
        • LazyImportFinder.find_spec()
  • Server
    • Serve Module

Developer Guide

  • Contributing
    • Getting Started
    • Development Setup
    • Running Tests
    • Code Style
  • Architecture
    • Overview
    • Components
      • Models
      • Processors
      • Pipeline
      • Configuration
  • Changelog
    • Version 0.0.1b9
    • Version 0.0.1
Routir
  • Search

© Copyright 2025, Routir Contributors.

Built with Sphinx using a theme provided by Read the Docs.