API Reference
On this page
This section documents every public class and function in router, organized by module. Private members (prefixed with _) are documented only where they materially affect the behavior of a public API (e.g. _LRUTTLCache underlying CacheManager, or _with_retry underlying ExecutionEngine).
Public API surface (router/__init__)
The top-level package re-exports the following symbols as router.__all__:
Some classes are available in their respective submodules but not re-exported at the top-level router package (import from the submodule directly):
Module index
- config — see the dedicated Configuration page for the full field-by-field reference.
- core.base —
BaseHandler,HandlerRequest,HandlerResponse,CallableHandler,BaseRouter. - core.route —
Route,RouteKeywords. - core.route_group —
RouteGroup,make_rag_group,make_tools_group,make_chat_group. - core.result —
RouteCandidate,RoutingTrace,RoutingResult,MultiRoutingResult. - routing.hierarchical —
HierarchicalRouter. - routing.pipeline —
RoutingPipeline,EmbeddingProvider,ConfidenceEvaluator. - routing.scorers —
BaseScorer,SemanticScorer,KeywordScorer,LLMScorer,HybridScorer. - execution.executor —
ExecutionEngine,BaseAggregator,FirstWinsAggregator,MergeAggregator. - execution.streaming_executor —
StreamingRouterAdapter,RouterStreamExecutor,RouterStreamEvent,StreamEventType. - cache.manager —
CacheManager. - feedback.engine —
FeedbackEngine,FeedbackRecord,RouteFeedbackState. - observability.observability —
RouterLogger,MetricsCollector,RouteStats.