Skip to main content

Semantic Router - API Specification

Version: v1.0.0 | Status: Active | Last Updated: March 2026

1. Overview​

The semantic_router module provides embedding-based intent routing. Maps user queries to predefined routes using semantic similarity, enabling routing decisions without keyword matching.

2. Core Components​

2.1 Classes​

ClassDescription
SemanticRouterMain router that matches queries against registered routes
RouteA named route with example utterances and metadata
RouteMatchResult of a routing decision (route name, confidence score)

3. Usage Example​

from codomyrmex.semantic_router import SemanticRouter, Route

router = SemanticRouter()
router.add_route(Route(
name="weather",
utterances=["What's the weather?", "Is it raining?", "Temperature today"],
))
router.add_route(Route(
name="calendar",
utterances=["What's on my schedule?", "Book a meeting", "Next appointment"],
))

match = router.route("Will it rain tomorrow?")
print(f"Route: {match.name}, Score: {match.score:.3f}")

4. Navigation​