Skip to main content

Semantic Router

PyPI - Python Version GitHub Contributors GitHub Last Commit GitHub Issues GitHub Pull Requests Github License

Semantic Router is a superfast decision-making layer for your LLMs and agents. Rather than waiting for slow LLM generations to make tool-use decisions, it decides in milliseconds: it compares the semantic meaning of a request against your routes in vector space, or asks a small decision model in a single fast call. Every decision comes with a confidence you can calibrate into a real probability.

Read the Docs


Versions

Semantic Router has two release lines. The 1.x line (main branch) rebuilds the routing layer around calibrated confidence, decision models and composable routers. The 0.x line (v0 branch) finishes at 0.2.0 and receives bug fixes only.

pip install -qU "semantic-router>=1,<2"   # 1.x
pip install -qU "semantic-router<1"       # 0.x

Upgrading from 0.x? The migration guide covers every change, with before and after code. The 0.x docs stay on the versions page.


Quickstart

This quickstart runs entirely on your machine, with a small local embedding model and no API keys:

pip install -qU "semantic-router[fastembed]"

We begin by defining a set of Route objects. These are the decisions the router can make. Let's try two simple routes for now, one for talk on politics and another for chitchat:

from semantic_router import Route

# we could use this as a guide for our chatbot to avoid political conversations
politics = Route(
    name="politics",
    utterances=[
        "isn't politics the best thing ever",
        "why don't you tell me about your political opinions",
        "don't you just love the president",
        "they're going to destroy this country!",
        "they will save the country!",
    ],
)

# this could be used as an indicator to our chatbot to switch to a more
# conversational prompt
chitchat = Route(
    name="chitchat",
    utterances=[
        "how's the weather today?",
        "how are things going?",
        "lovely weather today",
        "the weather is horrendous",
        "let's go to the chippy",
    ],
)

# we place both of our decisions together into single list
routes = [politics, chitchat]

Next we pick an encoder, the model that turns text into vectors. We use a local FastEmbed model here; OpenAI, Cohere, Hugging Face and many more work the same way.

from semantic_router.encoders import FastEmbedEncoder

encoder = FastEmbedEncoder(name="BAAI/bge-small-en-v1.5")

With our routes and encoder defined, we create an IndexedRouter. It embeds every utterance once and matches each query against them.

from semantic_router import IndexedRouter

router = IndexedRouter(encoder=encoder, routes=routes)

Now we can make super fast decisions based on user queries:

router("don't you love politics?").name
[Out]: 'politics'

Correct decision, let's try another:

router("how's the weather today?").name
[Out]: 'chitchat'

We get both decisions correct! By default the best route always wins, so to let the router say "none of these" we calibrate it on a few labelled queries it hasn't seen (None means no route should match) and set a confidence threshold:

router.fit(
    X=[
        "who should I vote for in the election?", "what do you think of the prime minister?", "is the government doing a good job?",
        "tell me your opinion on the new tax law", "are you left wing or right wing?", "the opposition party is a joke",
        "nice day out, isn't it?", "it's freezing outside", "how was your weekend?",
        "fancy grabbing some fish and chips?", "what a lovely sunny afternoon", "how have you been?",
        "how do I reset my password?", "what's the capital of australia?", "write me a python function to sort a list",
        "what is the boiling point of water?", "recommend a good sci-fi book", "how many legs does a spider have?",
    ],
    y=["politics"] * 6 + ["chitchat"] * 6 + [None] * 6,
)
router.confidence_threshold = 0.5  # now a probability: act only when it's more likely right than wrong

router("I'm interested in learning about llama 2").name
[Out]:

No route cleared the bar, so the router returned None!

Beyond embeddings

  • DecisionRouter asks a decision model (TypeSafe's Jev, Laya or Von) which route applies, and can answer several yes/no, choice and score questions about one message in a single call. New to decision models? Read Understanding Jev or watch the video.
  • Chain answers easy queries from a fast router and falls through to a slower one only when it isn't sure. Merge averages several routers.
  • Hybrid search: give IndexedRouter a sparse_encoder to weigh exact keywords alongside meaning.
  • Production indexes: keep your routes in Pinecone, Qdrant or Postgres.
  • Multi-modal: route on images as well as text.

📚 Resources

Docs

Notebook Description
Introduction Introduction to Semantic Router and the IndexedRouter
Save/Load Routers Save any router to YAML or JSON and load it back, calibration included
LangChain Integration How to integrate Semantic Router with LangChain Agents
Local Execution Fully local routing with FastEmbed, no API keys
Calibration Turn raw scores into probabilities with fit(), and set thresholds that mean what they say
Multi-Modal Routes Using multi-modal routes to identify Shrek vs. not-Shrek pictures
Healthcare Administrative Routing Fully local routing, calibration, and evaluation across seven synthetic healthcare administrative workflows

Online Course

Semantic Router Course

Community

Metadata

Release files for semantic-router 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for semantic-router 1.0.2
File Size Uploaded Provenance
semantic_router-1.0.2.tar.gz 84.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for semantic-router 1.0.2
File Interpreter ABI Platform
semantic_router-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 195.6 kB

Release files / semantic_router-1.0.2.tar.gz

Download URL semantic_router-1.0.2.tar.gz
Size 84.1 kB
Tags Source
SHA-256 checksum
How to use checksums
69778396c2e8e92771b5d05689769ba54f2b9439779603dc978d3a170115ea5f
BLAKE2b-256 checksum
How to use checksums
d81bed0b6b3d33486f3698c71c940d72e5953896f12b51aa34621ed0cefaf50e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / semantic_router-1.0.2-py3-none-any.whl

Download URL semantic_router-1.0.2-py3-none-any.whl
Size 111.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36933d3a57a0af32ffb2bf71047e984939c16dd919d6a86a4f74aa35b49987b8
BLAKE2b-256 checksum
How to use checksums
dd5c058ba50f6ff173d67bb5ef24abd3d8b6f28eaa27e8317968a66f4a693b8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for semantic-router 1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page