diff --git a/README.md b/README.md
index fe5db3433ebcaa5de5766e22923f1db43dc19629..fd4c12a2e5f441e8cb792d6705c976c7e67b55d4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
[](https://aurelio.ai)
# Semantic Router
+
<p>
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/semantic-router?logo=python&logoColor=gold" />
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/aurelio-labs/semantic-router" />
@@ -22,7 +23,7 @@ To get started with _semantic-router_ we install it like so:
pip install -qU semantic-router
```
-❗️ _If wanting to use local embeddings you can use `FastEmbedEncoder` (`pip install -qU semantic-router[fastembed]`). To use the `HybridRouteLayer` you must `pip install -qU semantic-router[hybrid]`._
+❗️ _If wanting to use local embeddings you can use `FastEmbedEncoder` (`pip install -qU "semantic-router[fastembed]`"). To use the `HybridRouteLayer` you must `pip install -qU "semantic-router[hybrid]"`._
We begin by defining a set of `Route` objects. These are the decision paths that the semantic router can decide to use, let's try two simple routes for now — one for talk on _politics_ and another for _chitchat_:
@@ -114,10 +115,3 @@ rl("I'm interested in learning about llama 2").name
In this case, no decision could be made as we had no matches — so our route layer returned `None`!
## 📚 [Resources](https://github.com/aurelio-labs/semantic-router/tree/main/docs)
-
-
-
-
-
-
-
diff --git a/coverage.xml b/coverage.xml
index 6726da20c0072e4a9458817d708f40d897fb84a3..9d15414547d067318bde70405fcee773c5d84140 100644
--- a/coverage.xml
+++ b/coverage.xml
@@ -1,12 +1,12 @@
<?xml version="1.0" ?>
-<coverage version="7.4.0" timestamp="1704449872184" lines-valid="676" lines-covered="592" line-rate="0.8757" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
+<coverage version="7.4.0" timestamp="1704797859261" lines-valid="813" lines-covered="707" line-rate="0.8696" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.4.0 -->
<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
<sources>
<source>/Users/jakit/customers/aurelio/semantic-router/semantic_router</source>
</sources>
<packages>
- <package name="." line-rate="0.9317" branch-rate="0" complexity="0">
+ <package name="." line-rate="0.9274" branch-rate="0" complexity="0">
<classes>
<class name="__init__.py" filename="__init__.py" complexity="0" line-rate="1" branch-rate="0">
<methods/>
@@ -23,104 +23,100 @@
<line number="1" hits="1"/>
<line number="2" hits="1"/>
<line number="4" hits="1"/>
- <line number="10" hits="1"/>
- <line number="11" hits="1"/>
+ <line number="8" hits="1"/>
+ <line number="9" hits="1"/>
+ <line number="12" hits="1"/>
+ <line number="13" hits="1"/>
<line number="14" hits="1"/>
<line number="15" hits="1"/>
<line number="16" hits="1"/>
- <line number="17" hits="1"/>
<line number="18" hits="1"/>
- <line number="20" hits="1"/>
+ <line number="21" hits="1"/>
+ <line number="22" hits="1"/>
<line number="23" hits="1"/>
<line number="24" hits="1"/>
- <line number="25" hits="1"/>
- <line number="27" hits="1"/>
- <line number="28" hits="1"/>
- <line number="29" hits="1"/>
+ <line number="26" hits="1"/>
<line number="30" hits="1"/>
<line number="32" hits="1"/>
+ <line number="33" hits="1"/>
<line number="34" hits="1"/>
- <line number="38" hits="1"/>
- <line number="40" hits="1"/>
+ <line number="35" hits="1"/>
+ <line number="36" hits="1"/>
+ <line number="37" hits="1"/>
+ <line number="39" hits="1"/>
<line number="41" hits="1"/>
<line number="42" hits="1"/>
- <line number="43" hits="1"/>
<line number="44" hits="1"/>
- <line number="45" hits="1"/>
+ <line number="46" hits="1"/>
<line number="47" hits="1"/>
- <line number="49" hits="1"/>
- <line number="50" hits="1"/>
<line number="52" hits="1"/>
+ <line number="53" hits="1"/>
<line number="54" hits="1"/>
- <line number="55" hits="1"/>
- <line number="60" hits="1"/>
- <line number="61" hits="1"/>
+ <line number="56" hits="1"/>
+ <line number="57" hits="1"/>
+ <line number="58" hits="1"/>
<line number="62" hits="1"/>
- <line number="64" hits="1"/>
+ <line number="63" hits="1"/>
<line number="65" hits="1"/>
- <line number="66" hits="1"/>
+ <line number="67" hits="1"/>
+ <line number="68" hits="1"/>
<line number="70" hits="1"/>
- <line number="71" hits="1"/>
- <line number="73" hits="1"/>
+ <line number="72" hits="1"/>
+ <line number="74" hits="1"/>
<line number="75" hits="1"/>
- <line number="76" hits="1"/>
<line number="78" hits="1"/>
- <line number="80" hits="1"/>
+ <line number="79" hits="1"/>
<line number="82" hits="1"/>
<line number="83" hits="1"/>
- <line number="86" hits="1"/>
- <line number="87" hits="1"/>
- <line number="90" hits="1"/>
+ <line number="84" hits="1"/>
<line number="91" hits="1"/>
- <line number="92" hits="1"/>
- <line number="99" hits="1"/>
- <line number="106" hits="1"/>
+ <line number="98" hits="1"/>
+ <line number="104" hits="1"/>
+ <line number="109" hits="1"/>
+ <line number="110" hits="1"/>
<line number="112" hits="1"/>
+ <line number="113" hits="1"/>
+ <line number="115" hits="1"/>
<line number="117" hits="1"/>
- <line number="118" hits="1"/>
+ <line number="119" hits="1"/>
<line number="120" hits="1"/>
<line number="121" hits="1"/>
<line number="123" hits="1"/>
+ <line number="124" hits="1"/>
<line number="125" hits="1"/>
- <line number="127" hits="1"/>
+ <line number="126" hits="1"/>
<line number="128" hits="1"/>
<line number="129" hits="1"/>
- <line number="131" hits="1"/>
+ <line number="130" hits="1"/>
<line number="132" hits="1"/>
<line number="133" hits="1"/>
- <line number="134" hits="1"/>
+ <line number="135" hits="1"/>
<line number="136" hits="1"/>
- <line number="137" hits="1"/>
<line number="138" hits="1"/>
<line number="140" hits="1"/>
<line number="141" hits="1"/>
- <line number="143" hits="1"/>
+ <line number="142" hits="1"/>
<line number="144" hits="1"/>
+ <line number="145" hits="1"/>
<line number="146" hits="1"/>
+ <line number="147" hits="1"/>
<line number="148" hits="1"/>
<line number="149" hits="1"/>
<line number="150" hits="1"/>
<line number="152" hits="1"/>
- <line number="153" hits="1"/>
- <line number="154" hits="1"/>
<line number="155" hits="1"/>
<line number="156" hits="1"/>
- <line number="157" hits="1"/>
- <line number="158" hits="1"/>
+ <line number="159" hits="1"/>
<line number="160" hits="1"/>
+ <line number="162" hits="1"/>
<line number="163" hits="1"/>
- <line number="164" hits="1"/>
+ <line number="165" hits="1"/>
+ <line number="166" hits="1"/>
<line number="167" hits="1"/>
- <line number="168" hits="1"/>
- <line number="170" hits="1"/>
- <line number="171" hits="1"/>
- <line number="173" hits="1"/>
- <line number="174" hits="1"/>
- <line number="175" hits="1"/>
- <line number="177" hits="1"/>
+ <line number="169" hits="1"/>
</lines>
</class>
- <class name="layer.py" filename="layer.py" complexity="0" line-rate="0.8836" branch-rate="0">
+ <class name="layer.py" filename="layer.py" complexity="0" line-rate="0.8769" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
@@ -128,190 +124,196 @@
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="7" hits="1"/>
+ <line number="8" hits="1"/>
+ <line number="9" hits="1"/>
+ <line number="10" hits="1"/>
+ <line number="11" hits="1"/>
<line number="12" hits="1"/>
- <line number="13" hits="1"/>
- <line number="14" hits="1"/>
<line number="15" hits="1"/>
+ <line number="16" hits="1"/>
+ <line number="17" hits="1"/>
<line number="18" hits="1"/>
- <line number="19" hits="1"/>
<line number="20" hits="1"/>
- <line number="21" hits="1"/>
- <line number="23" hits="1"/>
+ <line number="21" hits="0"/>
+ <line number="22" hits="0"/>
+ <line number="23" hits="0"/>
<line number="24" hits="0"/>
- <line number="25" hits="0"/>
- <line number="26" hits="0"/>
<line number="27" hits="0"/>
- <line number="30" hits="0"/>
- <line number="31" hits="0"/>
- <line number="33" hits="1"/>
- <line number="34" hits="1"/>
+ <line number="28" hits="0"/>
+ <line number="30" hits="1"/>
+ <line number="31" hits="1"/>
+ <line number="32" hits="0"/>
<line number="35" hits="0"/>
+ <line number="37" hits="1"/>
<line number="38" hits="0"/>
- <line number="40" hits="1"/>
- <line number="41" hits="0"/>
- <line number="42" hits="0"/>
- <line number="43" hits="0"/>
- <line number="46" hits="1"/>
- <line number="52" hits="1"/>
- <line number="54" hits="1"/>
- <line number="60" hits="1"/>
- <line number="61" hits="1"/>
+ <line number="39" hits="0"/>
+ <line number="40" hits="0"/>
+ <line number="43" hits="1"/>
+ <line number="49" hits="1"/>
+ <line number="51" hits="1"/>
+ <line number="57" hits="1"/>
+ <line number="58" hits="1"/>
+ <line number="62" hits="1"/>
<line number="63" hits="0"/>
- <line number="64" hits="0"/>
+ <line number="64" hits="1"/>
<line number="65" hits="0"/>
- <line number="66" hits="0"/>
+ <line number="66" hits="1"/>
<line number="67" hits="0"/>
- <line number="68" hits="0"/>
+ <line number="68" hits="1"/>
<line number="69" hits="0"/>
<line number="70" hits="1"/>
<line number="71" hits="1"/>
- <line number="73" hits="1"/>
+ <line number="72" hits="1"/>
<line number="74" hits="1"/>
- <line number="76" hits="1"/>
+ <line number="75" hits="1"/>
<line number="77" hits="1"/>
<line number="78" hits="1"/>
<line number="79" hits="1"/>
<line number="80" hits="1"/>
<line number="81" hits="1"/>
<line number="82" hits="1"/>
- <line number="84" hits="1"/>
- <line number="88" hits="1"/>
+ <line number="83" hits="1"/>
+ <line number="85" hits="1"/>
<line number="89" hits="1"/>
<line number="90" hits="1"/>
<line number="91" hits="1"/>
<line number="92" hits="1"/>
<line number="93" hits="1"/>
- <line number="97" hits="0"/>
- <line number="99" hits="1"/>
+ <line number="94" hits="1"/>
+ <line number="98" hits="0"/>
<line number="100" hits="1"/>
- <line number="106" hits="1"/>
- <line number="108" hits="1"/>
+ <line number="101" hits="1"/>
+ <line number="107" hits="1"/>
<line number="109" hits="1"/>
- <line number="112" hits="1"/>
+ <line number="110" hits="1"/>
<line number="113" hits="1"/>
- <line number="117" hits="1"/>
- <line number="120" hits="1"/>
- <line number="121" hits="0"/>
- <line number="123" hits="1"/>
+ <line number="114" hits="1"/>
+ <line number="118" hits="1"/>
+ <line number="121" hits="1"/>
+ <line number="122" hits="0"/>
<line number="124" hits="1"/>
<line number="125" hits="1"/>
<line number="126" hits="1"/>
<line number="127" hits="1"/>
- <line number="129" hits="1"/>
+ <line number="128" hits="1"/>
<line number="130" hits="1"/>
<line number="131" hits="1"/>
- <line number="133" hits="1"/>
+ <line number="132" hits="1"/>
<line number="134" hits="1"/>
<line number="135" hits="1"/>
<line number="136" hits="1"/>
<line number="137" hits="1"/>
<line number="138" hits="1"/>
- <line number="140" hits="1"/>
+ <line number="139" hits="1"/>
<line number="141" hits="1"/>
- <line number="142" hits="0"/>
- <line number="144" hits="1"/>
+ <line number="142" hits="1"/>
+ <line number="143" hits="0"/>
<line number="145" hits="1"/>
- <line number="148" hits="1"/>
+ <line number="146" hits="1"/>
<line number="149" hits="1"/>
<line number="150" hits="1"/>
<line number="151" hits="1"/>
+ <line number="152" hits="1"/>
<line number="153" hits="1"/>
- <line number="156" hits="1"/>
- <line number="157" hits="1"/>
- <line number="158" hits="1"/>
- <line number="159" hits="1"/>
- <line number="160" hits="1"/>
+ <line number="155" hits="1"/>
+ <line number="161" hits="1"/>
<line number="162" hits="1"/>
<line number="163" hits="1"/>
<line number="164" hits="1"/>
<line number="165" hits="1"/>
- <line number="167" hits="1"/>
<line number="169" hits="1"/>
<line number="171" hits="1"/>
+ <line number="172" hits="1"/>
<line number="173" hits="1"/>
<line number="174" hits="1"/>
- <line number="175" hits="1"/>
<line number="176" hits="1"/>
- <line number="177" hits="1"/>
- <line number="179" hits="1"/>
+ <line number="178" hits="1"/>
<line number="180" hits="1"/>
+ <line number="181" hits="1"/>
+ <line number="182" hits="1"/>
<line number="183" hits="1"/>
- <line number="185" hits="1"/>
- <line number="186" hits="0"/>
- <line number="192" hits="1"/>
- <line number="193" hits="1"/>
- <line number="194" hits="1"/>
- <line number="195" hits="1"/>
- <line number="196" hits="1"/>
+ <line number="184" hits="1"/>
+ <line number="186" hits="1"/>
+ <line number="187" hits="1"/>
+ <line number="188" hits="0"/>
+ <line number="189" hits="0"/>
+ <line number="194" hits="0"/>
+ <line number="195" hits="0"/>
+ <line number="197" hits="0"/>
<line number="198" hits="1"/>
- <line number="199" hits="1"/>
- <line number="200" hits="1"/>
<line number="201" hits="1"/>
- <line number="202" hits="1"/>
- <line number="204" hits="1"/>
- <line number="205" hits="1"/>
- <line number="206" hits="1"/>
- <line number="207" hits="1"/>
- <line number="209" hits="1"/>
+ <line number="203" hits="1"/>
+ <line number="204" hits="0"/>
<line number="210" hits="1"/>
+ <line number="211" hits="1"/>
<line number="212" hits="1"/>
- <line number="215" hits="1"/>
+ <line number="213" hits="1"/>
+ <line number="214" hits="1"/>
<line number="216" hits="1"/>
<line number="217" hits="1"/>
+ <line number="218" hits="1"/>
<line number="219" hits="1"/>
<line number="220" hits="1"/>
- <line number="221" hits="1"/>
+ <line number="222" hits="1"/>
<line number="223" hits="1"/>
<line number="224" hits="1"/>
<line number="225" hits="1"/>
<line number="227" hits="1"/>
<line number="228" hits="1"/>
- <line number="229" hits="1"/>
- <line number="231" hits="1"/>
+ <line number="230" hits="1"/>
<line number="233" hits="1"/>
- <line number="235" hits="1"/>
- <line number="238" hits="1"/>
- <line number="241" hits="1"/>
+ <line number="234" hits="1"/>
+ <line number="236" hits="1"/>
+ <line number="237" hits="1"/>
+ <line number="239" hits="1"/>
+ <line number="240" hits="1"/>
<line number="242" hits="1"/>
<line number="243" hits="1"/>
- <line number="250" hits="1"/>
- <line number="251" hits="1"/>
+ <line number="245" hits="1"/>
+ <line number="247" hits="1"/>
+ <line number="249" hits="1"/>
+ <line number="252" hits="1"/>
+ <line number="255" hits="1"/>
+ <line number="256" hits="1"/>
<line number="257" hits="1"/>
- <line number="262" hits="1"/>
- <line number="263" hits="1"/>
+ <line number="264" hits="1"/>
<line number="265" hits="1"/>
- <line number="267" hits="1"/>
- <line number="268" hits="1"/>
- <line number="270" hits="1"/>
<line number="271" hits="1"/>
- <line number="273" hits="1"/>
- <line number="274" hits="1"/>
<line number="276" hits="1"/>
<line number="277" hits="1"/>
- <line number="278" hits="1"/>
<line number="279" hits="1"/>
- <line number="280" hits="1"/>
<line number="281" hits="1"/>
<line number="282" hits="1"/>
<line number="284" hits="1"/>
+ <line number="285" hits="1"/>
<line number="287" hits="1"/>
<line number="288" hits="1"/>
+ <line number="290" hits="1"/>
<line number="291" hits="1"/>
<line number="292" hits="1"/>
+ <line number="293" hits="1"/>
<line number="294" hits="1"/>
<line number="295" hits="1"/>
- <line number="297" hits="1"/>
+ <line number="296" hits="1"/>
<line number="298" hits="1"/>
- <line number="299" hits="1"/>
<line number="301" hits="1"/>
- <line number="303" hits="1"/>
- <line number="304" hits="1"/>
- <line number="310" hits="1"/>
+ <line number="302" hits="1"/>
+ <line number="305" hits="1"/>
+ <line number="306" hits="1"/>
+ <line number="308" hits="1"/>
+ <line number="309" hits="1"/>
<line number="311" hits="1"/>
<line number="312" hits="1"/>
- <line number="314" hits="1"/>
+ <line number="313" hits="1"/>
<line number="315" hits="1"/>
- <line number="316" hits="1"/>
+ <line number="317" hits="1"/>
+ <line number="318" hits="1"/>
+ <line number="324" hits="1"/>
+ <line number="325" hits="1"/>
+ <line number="326" hits="1"/>
+ <line number="328" hits="1"/>
+ <line number="329" hits="1"/>
+ <line number="330" hits="1"/>
</lines>
</class>
<class name="linear.py" filename="linear.py" complexity="0" line-rate="1" branch-rate="0">
@@ -332,7 +334,7 @@
<line number="30" hits="1"/>
</lines>
</class>
- <class name="route.py" filename="route.py" complexity="0" line-rate="0.9275" branch-rate="0">
+ <class name="route.py" filename="route.py" complexity="0" line-rate="0.9333" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
@@ -367,90 +369,105 @@
<line number="43" hits="1"/>
<line number="44" hits="1"/>
<line number="45" hits="1"/>
- <line number="47" hits="1"/>
+ <line number="46" hits="1"/>
<line number="48" hits="1"/>
- <line number="50" hits="0"/>
- <line number="53" hits="0"/>
- <line number="56" hits="1"/>
- <line number="57" hits="1"/>
- <line number="59" hits="1"/>
- <line number="60" hits="1"/>
+ <line number="49" hits="1"/>
+ <line number="50" hits="1"/>
+ <line number="51" hits="1"/>
+ <line number="56" hits="0"/>
+ <line number="59" hits="0"/>
<line number="62" hits="1"/>
<line number="63" hits="1"/>
- <line number="64" hits="1"/>
+ <line number="65" hits="1"/>
<line number="66" hits="1"/>
- <line number="67" hits="1"/>
- <line number="71" hits="1"/>
+ <line number="68" hits="1"/>
+ <line number="69" hits="1"/>
+ <line number="70" hits="1"/>
<line number="72" hits="1"/>
<line number="73" hits="1"/>
- <line number="74" hits="1"/>
- <line number="76" hits="1"/>
<line number="77" hits="1"/>
+ <line number="78" hits="1"/>
<line number="79" hits="1"/>
<line number="80" hits="1"/>
<line number="82" hits="1"/>
<line number="83" hits="1"/>
- <line number="84" hits="1"/>
- <line number="86" hits="0"/>
+ <line number="85" hits="1"/>
+ <line number="86" hits="1"/>
<line number="88" hits="1"/>
<line number="89" hits="1"/>
<line number="90" hits="1"/>
- <line number="92" hits="1"/>
- <line number="117" hits="1"/>
- <line number="118" hits="1"/>
- <line number="119" hits="0"/>
- <line number="121" hits="1"/>
+ <line number="92" hits="0"/>
+ <line number="94" hits="1"/>
+ <line number="95" hits="1"/>
+ <line number="96" hits="1"/>
+ <line number="98" hits="1"/>
<line number="123" hits="1"/>
+ <line number="124" hits="1"/>
<line number="125" hits="1"/>
- <line number="126" hits="1"/>
- <line number="127" hits="0"/>
+ <line number="126" hits="0"/>
+ <line number="128" hits="1"/>
+ <line number="130" hits="1"/>
+ <line number="132" hits="1"/>
+ <line number="133" hits="1"/>
+ <line number="134" hits="1"/>
+ <line number="135" hits="1"/>
+ <line number="136" hits="0"/>
</lines>
</class>
- <class name="schema.py" filename="schema.py" complexity="0" line-rate="0.973" branch-rate="0">
+ <class name="schema.py" filename="schema.py" complexity="0" line-rate="0.9565" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
<line number="3" hits="1"/>
<line number="4" hits="1"/>
<line number="6" hits="1"/>
- <line number="11" hits="1"/>
- <line number="14" hits="1"/>
+ <line number="12" hits="1"/>
<line number="15" hits="1"/>
<line number="16" hits="1"/>
<line number="17" hits="1"/>
- <line number="20" hits="1"/>
- <line number="21" hits="1"/>
+ <line number="18" hits="1"/>
+ <line number="19" hits="1"/>
<line number="22" hits="1"/>
- <line number="25" hits="1"/>
- <line number="26" hits="1"/>
+ <line number="23" hits="1"/>
+ <line number="24" hits="1"/>
<line number="27" hits="1"/>
<line number="28" hits="1"/>
<line number="29" hits="1"/>
+ <line number="30" hits="1"/>
<line number="31" hits="1"/>
- <line number="32" hits="1"/>
<line number="33" hits="1"/>
<line number="34" hits="1"/>
<line number="35" hits="1"/>
<line number="36" hits="1"/>
<line number="37" hits="1"/>
<line number="38" hits="1"/>
- <line number="39" hits="1"/>
- <line number="41" hits="0"/>
+ <line number="39" hits="0"/>
+ <line number="40" hits="1"/>
+ <line number="41" hits="1"/>
+ <line number="42" hits="1"/>
<line number="43" hits="1"/>
- <line number="44" hits="1"/>
+ <line number="45" hits="0"/>
<line number="47" hits="1"/>
<line number="48" hits="1"/>
- <line number="49" hits="1"/>
+ <line number="51" hits="1"/>
<line number="52" hits="1"/>
<line number="53" hits="1"/>
<line number="55" hits="1"/>
+ <line number="56" hits="1"/>
+ <line number="57" hits="1"/>
+ <line number="58" hits="1"/>
+ <line number="60" hits="1"/>
<line number="61" hits="1"/>
- <line number="62" hits="1"/>
+ <line number="64" hits="1"/>
+ <line number="65" hits="1"/>
+ <line number="67" hits="1"/>
+ <line number="73" hits="1"/>
+ <line number="74" hits="1"/>
</lines>
</class>
</classes>
</package>
- <package name="encoders" line-rate="0.966" branch-rate="0" complexity="0">
+ <package name="encoders" line-rate="0.9545" branch-rate="0" complexity="0">
<classes>
<class name="__init__.py" filename="encoders/__init__.py" complexity="0" line-rate="1" branch-rate="0">
<methods/>
@@ -470,52 +487,58 @@
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="6" hits="1"/>
- <line number="8" hits="1"/>
+ <line number="7" hits="1"/>
<line number="9" hits="1"/>
- <line number="11" hits="1"/>
+ <line number="10" hits="1"/>
<line number="12" hits="1"/>
+ <line number="13" hits="1"/>
</lines>
</class>
- <class name="bm25.py" filename="encoders/bm25.py" complexity="0" line-rate="1" branch-rate="0">
+ <class name="bm25.py" filename="encoders/bm25.py" complexity="0" line-rate="0.9524" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
<line number="3" hits="1"/>
- <line number="5" hits="1"/>
+ <line number="4" hits="1"/>
+ <line number="7" hits="1"/>
<line number="8" hits="1"/>
<line number="9" hits="1"/>
<line number="10" hits="1"/>
- <line number="11" hits="1"/>
+ <line number="12" hits="1"/>
<line number="13" hits="1"/>
<line number="14" hits="1"/>
<line number="15" hits="1"/>
- <line number="17" hits="1"/>
- <line number="18" hits="1"/>
- <line number="19" hits="1"/>
- <line number="20" hits="1"/>
+ <line number="16" hits="0"/>
+ <line number="17" hits="0"/>
<line number="21" hits="1"/>
- <line number="23" hits="1"/>
+ <line number="22" hits="1"/>
+ <line number="24" hits="1"/>
<line number="25" hits="1"/>
<line number="26" hits="1"/>
<line number="27" hits="1"/>
<line number="28" hits="1"/>
- <line number="29" hits="1"/>
<line number="30" hits="1"/>
- <line number="31" hits="1"/>
+ <line number="32" hits="1"/>
<line number="33" hits="1"/>
+ <line number="34" hits="1"/>
<line number="35" hits="1"/>
<line number="36" hits="1"/>
<line number="37" hits="1"/>
<line number="38" hits="1"/>
- <line number="39" hits="1"/>
<line number="40" hits="1"/>
- <line number="41" hits="1"/>
<line number="42" hits="1"/>
<line number="43" hits="1"/>
+ <line number="44" hits="1"/>
<line number="45" hits="1"/>
<line number="46" hits="1"/>
<line number="47" hits="1"/>
<line number="48" hits="1"/>
+ <line number="49" hits="1"/>
+ <line number="50" hits="1"/>
+ <line number="52" hits="1"/>
+ <line number="53" hits="1"/>
+ <line number="54" hits="1"/>
+ <line number="55" hits="1"/>
</lines>
</class>
<class name="cohere.py" filename="encoders/cohere.py" complexity="0" line-rate="1" branch-rate="0">
@@ -528,7 +551,6 @@
<line number="9" hits="1"/>
<line number="10" hits="1"/>
<line number="12" hits="1"/>
- <line number="17" hits="1"/>
<line number="18" hits="1"/>
<line number="19" hits="1"/>
<line number="20" hits="1"/>
@@ -538,7 +560,7 @@
<line number="24" hits="1"/>
<line number="25" hits="1"/>
<line number="26" hits="1"/>
- <line number="28" hits="1"/>
+ <line number="27" hits="1"/>
<line number="29" hits="1"/>
<line number="30" hits="1"/>
<line number="31" hits="1"/>
@@ -546,40 +568,42 @@
<line number="33" hits="1"/>
<line number="34" hits="1"/>
<line number="35" hits="1"/>
+ <line number="36" hits="1"/>
</lines>
</class>
- <class name="fastembed.py" filename="encoders/fastembed.py" complexity="0" line-rate="0.8621" branch-rate="0">
+ <class name="fastembed.py" filename="encoders/fastembed.py" complexity="0" line-rate="0.8667" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
<line number="3" hits="1"/>
<line number="4" hits="1"/>
- <line number="7" hits="1"/>
- <line number="8" hits="1"/>
+ <line number="6" hits="1"/>
<line number="9" hits="1"/>
<line number="10" hits="1"/>
<line number="11" hits="1"/>
<line number="12" hits="1"/>
<line number="13" hits="1"/>
+ <line number="14" hits="1"/>
<line number="15" hits="1"/>
- <line number="16" hits="1"/>
<line number="17" hits="1"/>
- <line number="19" hits="1"/>
<line number="20" hits="1"/>
<line number="21" hits="1"/>
- <line number="22" hits="0"/>
- <line number="23" hits="0"/>
- <line number="28" hits="1"/>
- <line number="35" hits="1"/>
- <line number="37" hits="1"/>
- <line number="38" hits="1"/>
+ <line number="23" hits="1"/>
+ <line number="24" hits="1"/>
+ <line number="25" hits="1"/>
+ <line number="26" hits="0"/>
+ <line number="27" hits="0"/>
+ <line number="33" hits="1"/>
<line number="40" hits="1"/>
- <line number="41" hits="1"/>
<line number="42" hits="1"/>
<line number="43" hits="1"/>
- <line number="44" hits="1"/>
- <line number="45" hits="0"/>
- <line number="46" hits="0"/>
+ <line number="45" hits="1"/>
+ <line number="46" hits="1"/>
+ <line number="47" hits="1"/>
+ <line number="48" hits="1"/>
+ <line number="49" hits="1"/>
+ <line number="50" hits="0"/>
+ <line number="51" hits="0"/>
</lines>
</class>
<class name="openai.py" filename="encoders/openai.py" complexity="0" line-rate="0.9762" branch-rate="0">
@@ -596,22 +620,21 @@
<line number="13" hits="1"/>
<line number="14" hits="1"/>
<line number="16" hits="1"/>
- <line number="21" hits="1"/>
<line number="22" hits="1"/>
<line number="23" hits="1"/>
<line number="24" hits="1"/>
<line number="25" hits="1"/>
- <line number="26" hits="0"/>
- <line number="27" hits="1"/>
+ <line number="26" hits="1"/>
+ <line number="27" hits="0"/>
<line number="28" hits="1"/>
<line number="29" hits="1"/>
<line number="30" hits="1"/>
- <line number="32" hits="1"/>
+ <line number="31" hits="1"/>
<line number="33" hits="1"/>
<line number="34" hits="1"/>
<line number="35" hits="1"/>
<line number="36" hits="1"/>
- <line number="39" hits="1"/>
+ <line number="37" hits="1"/>
<line number="40" hits="1"/>
<line number="41" hits="1"/>
<line number="42" hits="1"/>
@@ -623,21 +646,162 @@
<line number="48" hits="1"/>
<line number="49" hits="1"/>
<line number="50" hits="1"/>
- <line number="52" hits="1"/>
- <line number="57" hits="1"/>
- <line number="59" hits="1"/>
+ <line number="51" hits="1"/>
+ <line number="53" hits="1"/>
+ <line number="58" hits="1"/>
<line number="60" hits="1"/>
+ <line number="61" hits="1"/>
+ </lines>
+ </class>
+ </classes>
+ </package>
+ <package name="llms" line-rate="0.9009" branch-rate="0" complexity="0">
+ <classes>
+ <class name="__init__.py" filename="llms/__init__.py" complexity="0" line-rate="1" branch-rate="0">
+ <methods/>
+ <lines>
+ <line number="1" hits="1"/>
+ <line number="2" hits="1"/>
+ <line number="3" hits="1"/>
+ <line number="4" hits="1"/>
+ <line number="6" hits="1"/>
+ </lines>
+ </class>
+ <class name="base.py" filename="llms/base.py" complexity="0" line-rate="1" branch-rate="0">
+ <methods/>
+ <lines>
+ <line number="1" hits="1"/>
+ <line number="3" hits="1"/>
+ <line number="6" hits="1"/>
+ <line number="7" hits="1"/>
+ <line number="9" hits="1"/>
+ <line number="10" hits="1"/>
+ <line number="12" hits="1"/>
+ <line number="13" hits="1"/>
+ </lines>
+ </class>
+ <class name="cohere.py" filename="llms/cohere.py" complexity="0" line-rate="0.9643" branch-rate="0">
+ <methods/>
+ <lines>
+ <line number="1" hits="1"/>
+ <line number="3" hits="1"/>
+ <line number="5" hits="1"/>
+ <line number="6" hits="1"/>
+ <line number="9" hits="1"/>
+ <line number="10" hits="1"/>
+ <line number="12" hits="1"/>
+ <line number="17" hits="1"/>
+ <line number="18" hits="1"/>
+ <line number="19" hits="1"/>
+ <line number="20" hits="1"/>
+ <line number="21" hits="1"/>
+ <line number="22" hits="1"/>
+ <line number="23" hits="1"/>
+ <line number="24" hits="1"/>
+ <line number="25" hits="1"/>
+ <line number="26" hits="1"/>
+ <line number="28" hits="1"/>
+ <line number="29" hits="1"/>
+ <line number="30" hits="1"/>
+ <line number="31" hits="1"/>
+ <line number="32" hits="1"/>
+ <line number="38" hits="1"/>
+ <line number="40" hits="1"/>
+ <line number="41" hits="0"/>
+ <line number="42" hits="1"/>
+ <line number="44" hits="1"/>
+ <line number="45" hits="1"/>
+ </lines>
+ </class>
+ <class name="openai.py" filename="llms/openai.py" complexity="0" line-rate="0.8529" branch-rate="0">
+ <methods/>
+ <lines>
+ <line number="1" hits="1"/>
+ <line number="3" hits="1"/>
+ <line number="5" hits="1"/>
+ <line number="6" hits="1"/>
+ <line number="7" hits="1"/>
+ <line number="10" hits="1"/>
+ <line number="11" hits="1"/>
+ <line number="12" hits="1"/>
+ <line number="13" hits="1"/>
+ <line number="15" hits="1"/>
+ <line number="22" hits="1"/>
+ <line number="23" hits="1"/>
+ <line number="24" hits="1"/>
+ <line number="25" hits="1"/>
+ <line number="26" hits="1"/>
+ <line number="27" hits="0"/>
+ <line number="28" hits="1"/>
+ <line number="29" hits="1"/>
+ <line number="30" hits="1"/>
+ <line number="31" hits="1"/>
+ <line number="32" hits="1"/>
+ <line number="33" hits="1"/>
+ <line number="35" hits="1"/>
+ <line number="36" hits="1"/>
+ <line number="37" hits="1"/>
+ <line number="38" hits="1"/>
+ <line number="39" hits="1"/>
+ <line number="46" hits="1"/>
+ <line number="48" hits="1"/>
+ <line number="49" hits="0"/>
+ <line number="50" hits="1"/>
+ <line number="51" hits="0"/>
+ <line number="52" hits="0"/>
+ <line number="53" hits="0"/>
+ </lines>
+ </class>
+ <class name="openrouter.py" filename="llms/openrouter.py" complexity="0" line-rate="0.8611" branch-rate="0">
+ <methods/>
+ <lines>
+ <line number="1" hits="1"/>
+ <line number="3" hits="1"/>
+ <line number="5" hits="1"/>
+ <line number="6" hits="1"/>
+ <line number="7" hits="1"/>
+ <line number="10" hits="1"/>
+ <line number="11" hits="1"/>
+ <line number="12" hits="1"/>
+ <line number="13" hits="1"/>
+ <line number="14" hits="1"/>
+ <line number="16" hits="1"/>
+ <line number="24" hits="1"/>
+ <line number="25" hits="1"/>
+ <line number="28" hits="1"/>
+ <line number="29" hits="1"/>
+ <line number="30" hits="1"/>
+ <line number="31" hits="1"/>
+ <line number="32" hits="0"/>
+ <line number="33" hits="1"/>
+ <line number="34" hits="1"/>
+ <line number="35" hits="1"/>
+ <line number="36" hits="1"/>
+ <line number="37" hits="1"/>
+ <line number="38" hits="1"/>
+ <line number="40" hits="1"/>
+ <line number="41" hits="1"/>
+ <line number="42" hits="1"/>
+ <line number="43" hits="1"/>
+ <line number="44" hits="1"/>
+ <line number="51" hits="1"/>
+ <line number="53" hits="1"/>
+ <line number="54" hits="0"/>
+ <line number="55" hits="1"/>
+ <line number="56" hits="0"/>
+ <line number="57" hits="0"/>
+ <line number="58" hits="0"/>
</lines>
</class>
</classes>
</package>
- <package name="utils" line-rate="0.5714" branch-rate="0" complexity="0">
+ <package name="utils" line-rate="0.5289" branch-rate="0" complexity="0">
<classes>
<class name="__init__.py" filename="utils/__init__.py" complexity="0" line-rate="1" branch-rate="0">
<methods/>
<lines/>
</class>
- <class name="function_call.py" filename="utils/function_call.py" complexity="0" line-rate="0.2545" branch-rate="0">
+ <class name="function_call.py" filename="utils/function_call.py" complexity="0" line-rate="0.2456" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
@@ -663,47 +827,49 @@
<line number="35" hits="1"/>
<line number="41" hits="1"/>
<line number="44" hits="1"/>
- <line number="45" hits="0"/>
<line number="47" hits="0"/>
- <line number="76" hits="0"/>
+ <line number="49" hits="0"/>
<line number="77" hits="0"/>
<line number="78" hits="0"/>
+ <line number="79" hits="0"/>
<line number="80" hits="0"/>
<line number="82" hits="0"/>
- <line number="83" hits="0"/>
<line number="84" hits="0"/>
<line number="85" hits="0"/>
- <line number="88" hits="1"/>
- <line number="90" hits="0"/>
+ <line number="86" hits="0"/>
+ <line number="87" hits="0"/>
+ <line number="90" hits="1"/>
<line number="92" hits="0"/>
- <line number="93" hits="0"/>
<line number="94" hits="0"/>
<line number="95" hits="0"/>
- <line number="99" hits="0"/>
- <line number="100" hits="0"/>
+ <line number="96" hits="0"/>
+ <line number="97" hits="0"/>
<line number="101" hits="0"/>
<line number="102" hits="0"/>
<line number="103" hits="0"/>
<line number="104" hits="0"/>
<line number="105" hits="0"/>
<line number="106" hits="0"/>
- <line number="110" hits="1"/>
- <line number="111" hits="0"/>
- <line number="113" hits="0"/>
- <line number="114" hits="0"/>
+ <line number="107" hits="0"/>
+ <line number="108" hits="0"/>
+ <line number="112" hits="1"/>
<line number="115" hits="0"/>
- <line number="116" hits="0"/>
+ <line number="117" hits="0"/>
<line number="118" hits="0"/>
<line number="119" hits="0"/>
+ <line number="120" hits="0"/>
+ <line number="122" hits="0"/>
+ <line number="123" hits="0"/>
+ <line number="124" hits="0"/>
</lines>
</class>
- <class name="llm.py" filename="utils/llm.py" complexity="0" line-rate="0.2857" branch-rate="0">
+ <class name="llm.py" filename="utils/llm.py" complexity="0" line-rate="0" branch-rate="0">
<methods/>
<lines>
- <line number="1" hits="1"/>
- <line number="3" hits="1"/>
- <line number="5" hits="1"/>
- <line number="8" hits="1"/>
+ <line number="1" hits="0"/>
+ <line number="3" hits="0"/>
+ <line number="5" hits="0"/>
+ <line number="8" hits="0"/>
<line number="9" hits="0"/>
<line number="10" hits="0"/>
<line number="15" hits="0"/>
@@ -746,34 +912,34 @@
<line number="1" hits="1"/>
<line number="3" hits="1"/>
<line number="6" hits="1"/>
- <line number="29" hits="1"/>
- <line number="30" hits="1"/>
<line number="31" hits="1"/>
<line number="32" hits="1"/>
+ <line number="33" hits="1"/>
<line number="34" hits="1"/>
- <line number="35" hits="1"/>
<line number="36" hits="1"/>
<line number="37" hits="1"/>
+ <line number="38" hits="1"/>
<line number="39" hits="1"/>
- <line number="40" hits="1"/>
<line number="41" hits="1"/>
<line number="42" hits="1"/>
<line number="43" hits="1"/>
+ <line number="44" hits="1"/>
<line number="45" hits="1"/>
- <line number="46" hits="1"/>
<line number="47" hits="1"/>
<line number="48" hits="1"/>
<line number="49" hits="1"/>
+ <line number="50" hits="1"/>
<line number="51" hits="1"/>
- <line number="52" hits="1"/>
+ <line number="53" hits="1"/>
<line number="54" hits="1"/>
- <line number="59" hits="1"/>
- <line number="60" hits="1"/>
- <line number="63" hits="1"/>
- <line number="64" hits="1"/>
- <line number="67" hits="1"/>
- <line number="71" hits="1"/>
- <line number="72" hits="1"/>
+ <line number="56" hits="1"/>
+ <line number="61" hits="1"/>
+ <line number="62" hits="1"/>
+ <line number="65" hits="1"/>
+ <line number="66" hits="1"/>
+ <line number="69" hits="1"/>
+ <line number="74" hits="1"/>
+ <line number="75" hits="1"/>
</lines>
</class>
</classes>
diff --git a/pyproject.toml b/pyproject.toml
index 5b0e1f304e1d57beec6c5454ef32e953add68338..5273afac8b39cb2b9acdb8ee79b4a398ed45ecfe 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -14,7 +14,7 @@ readme = "README.md"
packages = [{include = "semantic_router"}]
[tool.poetry.dependencies]
-python = ">=3.10,<3.12"
+python = "^3.9"
pydantic = "^1.8.2"
openai = "^1.3.9"
cohere = "^4.32"
diff --git a/semantic_router/encoders/bm25.py b/semantic_router/encoders/bm25.py
index 68150cb767faec1a8c3c5417f9d5f6db3a977cda..e96e4d7dadfcacda40cefcdd403bf9e2f8b70851 100644
--- a/semantic_router/encoders/bm25.py
+++ b/semantic_router/encoders/bm25.py
@@ -16,7 +16,7 @@ class BM25Encoder(BaseEncoder):
except ImportError:
raise ImportError(
"Please install pinecone-text to use BM25Encoder. "
- "You can install it with: `pip install semantic-router[hybrid]`"
+ "You can install it with: `pip install 'semantic-router[hybrid]'`"
)
logger.info("Downloading and initializing BM25 model parameters.")
self.model = encoder.default()
diff --git a/semantic_router/encoders/fastembed.py b/semantic_router/encoders/fastembed.py
index 413e3a6ada8e956fcbb8cbdfdd640a29883647df..98cfc6cc529ff4c06e0a3e7f0d0af779df7f71dd 100644
--- a/semantic_router/encoders/fastembed.py
+++ b/semantic_router/encoders/fastembed.py
@@ -27,7 +27,7 @@ class FastEmbedEncoder(BaseEncoder):
raise ImportError(
"Please install fastembed to use FastEmbedEncoder. "
"You can install it with: "
- "`pip install semantic-router[fastembed]`"
+ "`pip install 'semantic-router[fastembed]'`"
)
embedding_args = {