User Guide
API Reference
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__()
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
LSR.anserini
LSR.model
LSR.subset_mapper
LSR.__init__()
LSR.filter_subset()
LSR.search_batch()
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.__init__()
MT5Reranker.tokenize_pairs()
MT5Reranker.forward()
MT5Reranker.score()
Fusion
Fusion.upstream
Fusion.fusion_function
Fusion.fusion_args
Fusion.__init__()
Fusion.search_batch()
RRF
RRF.fuse_batch()
ScoreFusion
ScoreFusion.fuse_batch()
Processor
Processor.cache
Processor.cache_key
Processor.__init__()
Processor.start()
Processor.submit()
BatchProcessor
BatchProcessor.__init__()
BatchProcessor.start()
AsyncQueryProcessor
AsyncQueryProcessor.__init__()
BatchQueryProcessor
BatchQueryProcessor.__init__()
ContentProcessor
ContentProcessor.config
ContentProcessor.line_reader
ContentProcessor.content_field
ContentProcessor.lang_mapping
ContentProcessor.__init__()
AsyncPairwiseScoreProcessor
AsyncPairwiseScoreProcessor.__init__()
BatchPairwiseScoreProcessor
BatchPairwiseScoreProcessor.__init__()
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__()
DummyProcessor
DummyProcessor.__init__()
DummyProcessor.submit()
auto_register()
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()
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()
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.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.model_post_init()
ColllectionConfig.model_config
Config
Config.services
Config.collections
Config.server_imports
Config.file_imports
Config.dynamic_pipeline
Config.model_config
load_all_extensions()
LazyImportFinder
LazyImportFinder.__init__()
LazyImportFinder.find_spec()
Developer Guide
This section contains auto-generated documentation for the server module.