Merge pull request #566 from aurelio-labs/james/enable-multi-routes

jamescalam · web-flow · commit 9331d3dd0d58 · 2025-03-21T18:14:51.000+04:00
feat: enable multi routes for v0.1
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,17 +2,30 @@ name: Test
 
 on:
   workflow_call:
+    secrets:
+      OPENAI_API_KEY:
+        required: false
+      COHERE_API_KEY:
+        required: false
+      CODECOV_TOKEN:
+        required: false
 
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY || '' }}
+      COHERE_API_KEY: ${{ secrets.COHERE_API_KEY || '' }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     services:
       pinecone:
         image: ghcr.io/pinecone-io/pinecone-local:latest
         env:
           PORT: 5080
           PINECONE_HOST: localhost
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY || '' }}
+          COHERE_API_KEY: ${{ secrets.COHERE_API_KEY || '' }}
         ports:
         - "5080-6000:5080-6000"
 
@@ -44,14 +57,10 @@ jobs:
       env:
         PINECONE_API_KEY: pclocal
         PINECONE_API_BASE_URL: http://localhost:5080
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-        COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
       run: |
         make test
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v2
-      env:
-        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
         file: ./coverage.xml
         fail_ci_if_error: false
diff --git a/.github/workflows/triggers_pr.yml b/.github/workflows/triggers_pr.yml
@@ -28,3 +28,7 @@ jobs:
     name: "Tests"
     if: ${{ fromJson(needs.diff.outputs.tags).code.changed }}
     uses: ./.github/workflows/test.yml
+    secrets:
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/docs/00-introduction.ipynb b/docs/00-introduction.ipynb
@@ -53,7 +53,7 @@
       },
       "outputs": [],
       "source": [
-        "!pip install -qU \"semantic-router==0.1.2\""
+        "!pip install -qU \"semantic-router>=0.1.3\""
       ]
     },
     {
diff --git a/docs/01-save-load-from-file.ipynb b/docs/01-save-load-from-file.ipynb
@@ -46,7 +46,7 @@
       },
       "outputs": [],
       "source": [
-        "!pip install -qU \"semantic-router==0.1.2\""
+        "!pip install -qU \"semantic-router>=0.1.3\""
       ]
     },
     {
diff --git a/docs/02-dynamic-routes.ipynb b/docs/02-dynamic-routes.ipynb
@@ -95,7 +95,7 @@
    ],
    "source": [
     "!pip install tzdata\n",
-    "!pip install -qU \"semantic-router==0.1.2\""
+    "!pip install -qU \"semantic-router>=0.1.3\""
    ]
   },
   {
diff --git a/docs/03-basic-langchain-agent.ipynb b/docs/03-basic-langchain-agent.ipynb
@@ -52,7 +52,7 @@
       "outputs": [],
       "source": [
         "!pip install -qU \\\n",
-        "    \"semantic-router==0.1.2\" \\\n",
+        "    \"semantic-router>=0.1.3\" \\\n",
         "    langchain==0.0.352 \\\n",
         "    openai>=1.6.1"
       ]
diff --git a/docs/06-threshold-optimization.ipynb b/docs/06-threshold-optimization.ipynb
@@ -37,7 +37,7 @@
       },
       "outputs": [],
       "source": [
-        "!pip install -qU \"semantic-router==0.1.2\""
+        "!pip install -qU \"semantic-router>=0.1.3\""
       ]
     },
     {
diff --git a/docs/08-async-dynamic-routes.ipynb b/docs/08-async-dynamic-routes.ipynb
@@ -78,7 +78,7 @@
    "outputs": [],
    "source": [
     "!pip install -qU \\\n",
-    "    \"semantic-router==0.1.2\" \\\n",
+    "    \"semantic-router>=0.1.3\" \\\n",
     "    tzdata"
    ]
   },
diff --git a/docs/09-route-filter.ipynb b/docs/09-route-filter.ipynb
@@ -53,7 +53,7 @@
       },
       "outputs": [],
       "source": [
-        "!pip install -qU \"semantic-router==0.1.2\""
+        "!pip install -qU \"semantic-router>=0.1.3\""
       ]
     },
     {
diff --git a/docs/indexes/local.ipynb b/docs/indexes/local.ipynb
@@ -13,7 +13,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install -qU \"semantic-router==0.1.2\""
+    "!pip install -qU \"semantic-router>=0.1.3\""
    ]
   },
   {
diff --git a/docs/indexes/pinecone-local.ipynb b/docs/indexes/pinecone-local.ipynb
@@ -50,7 +50,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install -qU \"semantic-router[pinecone]==0.1.2\""
+    "!pip install -qU \"semantic-router[pinecone]>=0.1.3\""
    ]
   },
   {
diff --git a/docs/indexes/pinecone-sync-routes.ipynb b/docs/indexes/pinecone-sync-routes.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install -qU \"semantic-router[pinecone]==0.1.2\""
+    "!pip install -qU \"semantic-router[pinecone]>=0.1.3\""
    ]
   },
   {
diff --git a/docs/indexes/pinecone.ipynb b/docs/indexes/pinecone.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install -qU \"semantic-router[pinecone]==0.1.2\""
+    "!pip install -qU \"semantic-router[pinecone]>=0.1.3\""
    ]
   },
   {
diff --git a/docs/indexes/pinecone_async.ipynb b/docs/indexes/pinecone_async.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install -qU \"semantic-router[pinecone]==0.1.2\""
+    "!pip install -qU \"semantic-router[pinecone]>=0.1.3\""
    ]
   },
   {
diff --git a/docs/user-guide/features/dynamic-routes.md b/docs/user-guide/features/dynamic-routes.md
@@ -91,7 +91,7 @@ Then add the new route to a router.
 
 ```python
 !pip install tzdata
-!pip install -qU semantic-router==0.1.2
+!pip install -qU semantic-router>=0.1.3
 ```
 
 ### Initializing Routes and SemanticRouter
diff --git a/docs/user-guide/features/threshold-optimization.md b/docs/user-guide/features/threshold-optimization.md
@@ -7,7 +7,7 @@ Given that this one `score_threshold` parameter can define the choice of a route
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/aurelio-labs/semantic-router/blob/main/docs/06-threshold-optimization.ipynb) [![Open nbviewer](https://raw.githubusercontent.com/pinecone-io/examples/master/assets/nbviewer-shield.svg)](https://nbviewer.org/github/aurelio-labs/semantic-router/blob/main/docs/06-threshold-optimization)
 
 ```python
-!pip install -qU "semantic-router==0.1.2"
+!pip install -qU "semantic-router>=0.1.3"
 ```
 
 ## Define SemanticRouter
diff --git a/docs/user-guide/guides/migration-to-v1.md b/docs/user-guide/guides/migration-to-v1.md
@@ -26,6 +26,39 @@ The v0.1 release of semantic router introduces several breaking changes to impro
   semantic_router.add(route3)  # Still works for a single route
   ```
 
+- `RouteLayer.retrieve_multiple_routes()` → `SemanticRouter.__call__(limit=None)` or `SemanticRouter.acall(limit=None)`
+
+  The `retrieve_multiple_routes` method has been removed. If you need similar functionality:
+  
+  - In versions 0.1.0-0.1.2: You can use the deprecated `_semantic_classify_multiple_routes` method
+  - In version 0.1.3+: Use the `__call__` or `acall` methods with appropriate `limit` parameter
+  
+  ```python
+  # Before (v0.0.x)
+  route_layer = RouteLayer(encoder=encoder, routes=routes)
+  multiple_routes = route_layer.retrieve_multiple_routes(query_text)
+  
+  # Transitional (v0.1.0-0.1.2)
+  # Using deprecated method (not recommended)
+  semantic_router = SemanticRouter(encoder=encoder, routes=routes, auto_sync="local")
+  query_results = semantic_router._query(query_text)
+  multiple_routes = semantic_router._semantic_classify_multiple_routes(query_results)
+  
+  # After (v0.1.3+)
+  semantic_router = SemanticRouter(encoder=encoder, routes=routes, auto_sync="local")
+  # Return all routes that pass their score thresholds
+  all_routes = semantic_router(query_text, limit=None)
+  # Or return top N routes that pass their score thresholds
+  top_routes = semantic_router(query_text, limit=3)
+  
+  # To get scores for all routes regardless of threshold
+  semantic_router.set_threshold(threshold=0.0)  # Set all route thresholds to 0
+  all_route_scores = semantic_router(query_text, limit=None)
+  ```
+  
+  When `limit=1` (the default), a single `RouteChoice` object is returned.
+  When `limit=None` or `limit > 1`, a list of `RouteChoice` objects is returned.
+
 ### Synchronization Strategy
 
 - If expecting routes to sync between local and remote on initialization, use `SemanticRouter(..., auto_sync="local")`. 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "semantic-router"
-version = "0.1.2"
+version = "0.1.3"
 description = "Super fast semantic router for AI decision making"
 authors = [{ name = "Aurelio AI", email = "hello@aurelio.ai" }]
 requires-python = ">=3.9,<3.14"
@@ -72,6 +72,7 @@ all = [
     "semantic-router[postgres]",
     "semantic-router[fastembed]",
     "semantic-router[cohere]",
+    "semantic-router[dev]",
 ]
 
 [tool.uv.sources]
diff --git a/semantic_router/encoders/bm25.py b/semantic_router/encoders/bm25.py
@@ -70,7 +70,7 @@ def __init__(
         self._avg_doc_len = np.float64(avg_doc_len) if avg_doc_len else None
         if use_default_params and not tokenizer:
             logger.info("Initializing default BM25 model parameters.")
-            self._tokenizer = PretrainedTokenizer("bert-base-uncased")
+            self._tokenizer = PretrainedTokenizer("google-bert/bert-base-uncased")
         elif tokenizer is not None:
             self._tokenizer = tokenizer
         else:
diff --git a/semantic_router/encoders/openai.py b/semantic_router/encoders/openai.py
@@ -95,8 +95,8 @@ def __init__(
         api_key = openai_api_key or os.getenv("OPENAI_API_KEY")
         base_url = openai_base_url or os.getenv("OPENAI_BASE_URL")
         openai_org_id = openai_org_id or os.getenv("OPENAI_ORG_ID")
-        if api_key is None:
-            raise ValueError("OpenAI API key cannot be 'None'.")
+        if api_key is None or api_key.strip() == "":
+            raise ValueError("OpenAI API key cannot be 'None' or empty.")
         if max_retries is not None:
             self.max_retries = max_retries
         try:
diff --git a/semantic_router/routers/base.py b/semantic_router/routers/base.py
diff --git a/semantic_router/routers/hybrid.py b/semantic_router/routers/hybrid.py
diff --git a/tests/functional/encoders/test_bm25_functional.py b/tests/functional/encoders/test_bm25_functional.py
diff --git a/tests/integration/encoders/test_openai_integration.py b/tests/integration/encoders/test_openai_integration.py
diff --git a/tests/unit/encoders/test_bm25.py b/tests/unit/encoders/test_bm25.py
diff --git a/tests/unit/test_router.py b/tests/unit/test_router.py
diff --git a/tests/unit/test_tokenizers.py b/tests/unit/test_tokenizers.py
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@`
`53`	`53`	`},`
`54`	`54`	`"outputs": [],`
`55`	`55`	`"source": [`
`56`		`- "!pip install -qU \"semantic-router==0.1.2\""`
	`56`	`+ "!pip install -qU \"semantic-router>=0.1.3\""`
`57`	`57`	`]`
`58`	`58`	`},`
`59`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@`
`46`	`46`	`},`
`47`	`47`	`"outputs": [],`
`48`	`48`	`"source": [`
`49`		`- "!pip install -qU \"semantic-router==0.1.2\""`
	`49`	`+ "!pip install -qU \"semantic-router>=0.1.3\""`
`50`	`50`	`]`
`51`	`51`	`},`
`52`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@`
`95`	`95`	`],`
`96`	`96`	`"source": [`
`97`	`97`	`"!pip install tzdata\n",`
`98`		`- "!pip install -qU \"semantic-router==0.1.2\""`
	`98`	`+ "!pip install -qU \"semantic-router>=0.1.3\""`
`99`	`99`	`]`
`100`	`100`	`},`
`101`	`101`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@`
`52`	`52`	`"outputs": [],`
`53`	`53`	`"source": [`
`54`	`54`	`"!pip install -qU \\\n",`
`55`		`- " \"semantic-router==0.1.2\" \\\n",`
	`55`	`+ " \"semantic-router>=0.1.3\" \\\n",`
`56`	`56`	`" langchain==0.0.352 \\\n",`
`57`	`57`	`" openai>=1.6.1"`
`58`	`58`	`]`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`},`
`38`	`38`	`"outputs": [],`
`39`	`39`	`"source": [`
`40`		`- "!pip install -qU \"semantic-router==0.1.2\""`
	`40`	`+ "!pip install -qU \"semantic-router>=0.1.3\""`
`41`	`41`	`]`
`42`	`42`	`},`
`43`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@`
`78`	`78`	`"outputs": [],`
`79`	`79`	`"source": [`
`80`	`80`	`"!pip install -qU \\\n",`
`81`		`- " \"semantic-router==0.1.2\" \\\n",`
	`81`	`+ " \"semantic-router>=0.1.3\" \\\n",`
`82`	`82`	`" tzdata"`
`83`	`83`	`]`
`84`	`84`	`},`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`"metadata": {},`
`14`	`14`	`"outputs": [],`
`15`	`15`	`"source": [`
`16`		`- "!pip install -qU \"semantic-router==0.1.2\""`
	`16`	`+ "!pip install -qU \"semantic-router>=0.1.3\""`
`17`	`17`	`]`
`18`	`18`	`},`
`19`	`19`	`{`