model-router-cli 1.0.2__tar.gz → 1.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. model_router_cli-1.1.0/LICENSE +209 -0
  2. {model_router_cli-1.0.2/backend/model_router_cli.egg-info → model_router_cli-1.1.0}/PKG-INFO +27 -9
  3. model_router_cli-1.0.2/PKG-INFO → model_router_cli-1.1.0/README.md +20 -43
  4. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/api/routes.py +143 -2
  5. model_router_cli-1.1.0/backend/app/cli/main.py +373 -0
  6. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/config/settings.py +45 -42
  7. model_router_cli-1.1.0/backend/app/fallback/circuit_breaker.py +65 -0
  8. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/fallback/handler.py +110 -104
  9. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/observability/events.py +52 -42
  10. model_router_cli-1.1.0/backend/app/providers/deepseek_provider.py +138 -0
  11. model_router_cli-1.1.0/backend/app/providers/groq_provider.py +132 -0
  12. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/providers/registry.py +38 -34
  13. model_router_cli-1.1.0/backend/app/providers/together_provider.py +138 -0
  14. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/router/engine.py +149 -149
  15. model_router_cli-1.0.2/backend/app/static/assets/index-CQFztymk.js → model_router_cli-1.1.0/backend/app/static/assets/index-Cw3aQx_F.js +1 -1
  16. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/static/index.html +1 -1
  17. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/storage/database.py +424 -365
  18. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/storage/models.py +202 -202
  19. model_router_cli-1.1.0/backend/app/storage/redis_client.py +38 -0
  20. model_router_cli-1.0.2/README.md → model_router_cli-1.1.0/backend/model_router_cli.egg-info/PKG-INFO +61 -5
  21. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/model_router_cli.egg-info/SOURCES.txt +8 -1
  22. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/model_router_cli.egg-info/requires.txt +3 -0
  23. model_router_cli-1.1.0/backend/tests/test_circuit_breaker.py +55 -0
  24. model_router_cli-1.1.0/backend/tests/test_cli.py +46 -0
  25. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/tests/test_e2e.py +17 -1
  26. model_router_cli-1.1.0/backend/tests/test_providers.py +100 -0
  27. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/pyproject.toml +8 -5
  28. model_router_cli-1.0.2/LICENSE +0 -22
  29. model_router_cli-1.0.2/backend/app/cli/main.py +0 -304
  30. model_router_cli-1.0.2/backend/tests/test_providers.py +0 -21
  31. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/analytics/service.py +0 -0
  32. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/analyzer/analyzer.py +0 -0
  33. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/analyzer/heuristics.py +0 -0
  34. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/budgets/manager.py +0 -0
  35. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/experiments/service.py +0 -0
  36. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/models/schemas.py +0 -0
  37. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/providers/base.py +0 -0
  38. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/providers/external_providers.py +0 -0
  39. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/providers/mock_provider.py +0 -0
  40. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/providers/ollama_provider.py +0 -0
  41. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/router/rules_engine.py +0 -0
  42. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/router/scoring.py +0 -0
  43. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/server.py +0 -0
  44. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/static/assets/index-DWa3sE4Y.css +0 -0
  45. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/static/favicon.png +0 -0
  46. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/static/favicon.svg +0 -0
  47. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/static/icons.svg +0 -0
  48. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/app/static/logo.png +0 -0
  49. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/model_router_cli.egg-info/dependency_links.txt +0 -0
  50. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/model_router_cli.egg-info/entry_points.txt +0 -0
  51. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/model_router_cli.egg-info/top_level.txt +0 -0
  52. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/tests/test_analyzer.py +0 -0
  53. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/backend/tests/test_router.py +0 -0
  54. {model_router_cli-1.0.2 → model_router_cli-1.1.0}/setup.cfg +0 -0
@@ -0,0 +1,209 @@
1
+ MIT License
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ Copyright (c) 2026 Model Router Contributors
7
+ Copyright (c) 2026 PicadoLabs
8
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+ 1. Definitions.
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+ "License" shall mean the terms and conditions for use, reproduction,
21
+ and distribution as defined by Sections 1 through 9 of this document.
22
+
23
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
+ SOFTWARE.
30
+ "Licensor" shall mean the copyright owner or entity authorized by
31
+ the copyright owner that is granting the License.
32
+
33
+ "Legal Entity" shall mean the union of the acting entity and all
34
+ other entities that control, are controlled by, or are under common
35
+ control with that entity. For the purposes of this definition,
36
+ "control" means (i) the power, direct or indirect, to cause the
37
+ direction or management of such entity, whether by contract or
38
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
39
+ outstanding shares, or (iii) beneficial ownership of such entity.
40
+
41
+ "You" (or "Your") shall mean an individual or Legal Entity
42
+ exercising permissions granted by this License.
43
+
44
+ "Source" form shall mean the preferred form for making modifications,
45
+ including but not limited to software source code, documentation
46
+ source, and configuration files.
47
+
48
+ "Object" form shall mean any form resulting from mechanical
49
+ transformation or translation of a Source form, including but
50
+ not limited to compiled object code, generated documentation,
51
+ and conversions to other media types.
52
+
53
+ "Work" shall mean the work of authorship, whether in Source or
54
+ Object form, made available under the License, as indicated by a
55
+ copyright notice that is included in or attached to the work
56
+ (an example is provided in the Appendix below).
57
+
58
+ "Derivative Works" shall mean any work, whether in Source or Object
59
+ form, that is based on (or derived from) the Work and for which the
60
+ editorial revisions, annotations, elaborations, or other modifications
61
+ represent, as a whole, an original work of authorship. For the purposes
62
+ of this License, Derivative Works shall not include works that remain
63
+ separable from, or merely link (or bind by name) to the interfaces of,
64
+ the Work and Derivative Works thereof.
65
+
66
+ "Contribution" shall mean any work of authorship, including
67
+ the original version of the Work and any modifications or additions
68
+ to that Work or Derivative Works thereof, that is intentionally
69
+ submitted to Licensor for inclusion in the Work by the copyright owner
70
+ or by an individual or Legal Entity authorized to submit on behalf of
71
+ the copyright owner. For the purposes of this definition, "submitted"
72
+ means any form of electronic, verbal, or written communication sent
73
+ to the Licensor or its representatives, including but not limited to
74
+ communication on electronic mailing lists, source code control systems,
75
+ and issue tracking systems that are managed by, or on behalf of, the
76
+ Licensor for the purpose of discussing and improving the Work, but
77
+ excluding communication that is conspicuously marked or otherwise
78
+ designated in writing by the copyright owner as "Not a Contribution."
79
+
80
+ "Contributor" shall mean Licensor and any individual or Legal Entity
81
+ on behalf of whom a Contribution has been received by Licensor and
82
+ subsequently incorporated within the Work.
83
+
84
+ 2. Grant of Copyright License. Subject to the terms and conditions of
85
+ this License, each Contributor hereby grants to You a perpetual,
86
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
87
+ copyright license to reproduce, prepare Derivative Works of,
88
+ publicly display, publicly perform, sublicense, and distribute the
89
+ Work and such Derivative Works in Source or Object form.
90
+
91
+ 3. Grant of Patent License. Subject to the terms and conditions of
92
+ this License, each Contributor hereby grants to You a perpetual,
93
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
94
+ (except as stated in this section) patent license to make, have made,
95
+ use, offer to sell, sell, import, and otherwise transfer the Work,
96
+ where such license applies only to those patent claims licensable
97
+ by such Contributor that are necessarily infringed by their
98
+ Contribution(s) alone or by combination of their Contribution(s)
99
+ with the Work to which such Contribution(s) was submitted. If You
100
+ institute patent litigation against any entity (including a
101
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
102
+ or a Contribution incorporated within the Work constitutes direct
103
+ or contributory patent infringement, then any patent licenses
104
+ granted to You under this License for that Work shall terminate
105
+ as of the date such litigation is filed.
106
+
107
+ 4. Redistribution. You may reproduce and distribute copies of the
108
+ Work or Derivative Works thereof in any medium, with or without
109
+ modifications, and in Source or Object form, provided that You
110
+ meet the following conditions:
111
+
112
+ (a) You must give any other recipients of the Work or
113
+ Derivative Works a copy of this License; and
114
+
115
+ (b) You must cause any modified files to carry prominent notices
116
+ stating that You changed the files; and
117
+
118
+ (c) You must retain, in the Source form of any Derivative Works
119
+ that You distribute, all copyright, patent, trademark, and
120
+ attribution notices from the Source form of the Work,
121
+ excluding those notices that do not pertain to any part of
122
+ the Derivative Works; and
123
+
124
+ (d) If the Work includes a "NOTICE" text file as part of its
125
+ distribution, then any Derivative Works that You distribute must
126
+ include a readable copy of the attribution notices contained
127
+ within such NOTICE file, excluding those notices that do not
128
+ pertain to any part of the Derivative Works, in at least one
129
+ of the following places: within a NOTICE text file distributed
130
+ as part of the Derivative Works; within the Source form or
131
+ documentation, if provided along with the Derivative Works; or,
132
+ within a display generated by the Derivative Works, if and
133
+ wherever such third-party notices normally appear. The contents
134
+ of the NOTICE file are for informational purposes only and
135
+ do not modify the License. You may add Your own attribution
136
+ notices within Derivative Works that You distribute, alongside
137
+ or as an addendum to the NOTICE text from the Work, provided
138
+ that such additional attribution notices cannot be construed
139
+ as modifying the License.
140
+
141
+ You may add Your own copyright statement to Your modifications and
142
+ may provide additional or different license terms and conditions
143
+ for use, reproduction, or distribution of Your modifications, or
144
+ for any such Derivative Works as a whole, provided Your use,
145
+ reproduction, and distribution of the Work otherwise complies with
146
+ the conditions stated in this License.
147
+
148
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
149
+ any Contribution intentionally submitted for inclusion in the Work
150
+ by You to the Licensor shall be under the terms and conditions of
151
+ this License, without any additional terms or conditions.
152
+ Notwithstanding the above, nothing herein shall supersede or modify
153
+ the terms of any separate license agreement you may have executed
154
+ with Licensor regarding such Contributions.
155
+
156
+ 6. Trademarks. This License does not grant permission to use the trade
157
+ names, trademarks, service marks, or product names of the Licensor,
158
+ except as required for reasonable and customary use in describing the
159
+ origin of the Work and reproducing the content of the NOTICE file.
160
+
161
+ 7. Disclaimer of Warranty. Unless required by applicable law or
162
+ agreed to in writing, Licensor provides the Work (and each
163
+ Contributor provides its Contributions) on an "AS IS" BASIS,
164
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
165
+ implied, including, without limitation, any warranties or conditions
166
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
167
+ PARTICULAR PURPOSE. You are solely responsible for determining the
168
+ appropriateness of using or redistributing the Work and assume any
169
+ risks associated with Your exercise of permissions under this License.
170
+
171
+ 8. Limitation of Liability. In no event and under no legal theory,
172
+ whether in tort (including negligence), contract, or otherwise,
173
+ unless required by applicable law (such as deliberate and grossly
174
+ negligent acts) or agreed to in writing, shall any Contributor be
175
+ liable to You for damages, including any direct, indirect, special,
176
+ incidental, or consequential damages of any character arising as a
177
+ result of this License or out of the use or inability to use the
178
+ Work (including but not limited to damages for loss of goodwill,
179
+ work stoppage, computer failure or malfunction, or any and all
180
+ other commercial damages or losses), even if such Contributor
181
+ has been advised of the possibility of such damages.
182
+
183
+ 9. Accepting Warranty or Additional Liability. While redistributing
184
+ the Work or Derivative Works thereof, You may choose to offer,
185
+ and charge a fee for, acceptance of support, warranty, indemnity,
186
+ or other liability obligations and/or rights consistent with this
187
+ License. However, in accepting such obligations, You may act only
188
+ on Your own behalf and on Your sole responsibility, not on behalf
189
+ of any other Contributor, and only if You agree to indemnify,
190
+ defend, and hold each Contributor harmless for any liability
191
+ incurred by, or claims asserted against, such Contributor by reason
192
+ of your accepting any such warranty or additional liability.
193
+
194
+ END OF TERMS AND CONDITIONS
195
+
196
+ Copyright 2026 Model Router Contributors
197
+ Copyright 2026 PicadoLabs
198
+
199
+ Licensed under the Apache License, Version 2.0 (the "License");
200
+ you may not use this file except in compliance with the License.
201
+ You may obtain a copy of the License at
202
+
203
+ http://www.apache.org/licenses/LICENSE-2.0
204
+
205
+ Unless required by applicable law or agreed to in writing, software
206
+ distributed under the License is distributed on an "AS IS" BASIS,
207
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
208
+ See the License for the specific language governing permissions and
209
+ limitations under the License.
@@ -1,17 +1,17 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: model-router-cli
3
- Version: 1.0.2
3
+ Version: 1.1.0
4
4
  Summary: Intelligent, explainable LLM request routing platform & AI Traffic Control Room
5
5
  Author-email: PicadoLabs <picadolabs@gmail.com>
6
- Maintainer-email: Kaap10 <picadolabs@gmail.com>
7
- License: MIT
6
+ Maintainer-email: PicadoLabs <picadolabs@gmail.com>
7
+ License: Apache-2.0
8
8
  Project-URL: Homepage, https://picadolabs.me
9
9
  Project-URL: Repository, https://github.com/PicadoLabs/ai-model-router
10
10
  Project-URL: Issues, https://github.com/PicadoLabs/ai-model-router/issues
11
11
  Keywords: llm,ai,router,fastapi,ollama,openai,cost-optimization
12
12
  Classifier: Development Status :: 4 - Beta
13
13
  Classifier: Intended Audience :: Developers
14
- Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.10
17
17
  Classifier: Programming Language :: Python :: 3.11
@@ -34,18 +34,34 @@ Requires-Dist: sse-starlette>=2.0.0
34
34
  Requires-Dist: python-multipart>=0.0.9
35
35
  Requires-Dist: python-dotenv>=1.0.1
36
36
  Requires-Dist: tiktoken>=0.6.0
37
+ Requires-Dist: redis>=5.0.0
38
+ Requires-Dist: asyncpg>=0.29.0
39
+ Requires-Dist: alembic>=1.13.0
37
40
  Dynamic: license-file
38
41
 
39
42
  # Model Router
40
43
 
41
44
  [![PyPI - Version](https://img.shields.io/pypi/v/model-router-cli?logo=pypi&logoColor=white&color=blue)](https://pypi.org/project/model-router-cli/)
42
45
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/model-router-cli?logo=python&logoColor=white)](https://pypi.org/project/model-router-cli/)
43
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
46
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
47
+ [![Downloads](https://static.pepy.tech/badge/model-router-cli)](https://pepy.tech/project/model-router-cli)
44
48
 
45
49
  Intelligent, explainable, cost- and latency-aware LLM request routing platform and AI Traffic Control Room.
46
50
 
47
51
  ---
48
52
 
53
+
54
+ ## The Real-World Problem
55
+ Companies building AI applications face ballooning API costs, rate limits, and latency spikes. They want to use large models (like GPT-4 or Claude 3.5 Sonnet) for complex reasoning, but cheaper/faster models (like Llama 3 or Haiku) for simple tasks. Manually writing logic to route these requests is brittle and hard to maintain.
56
+
57
+ ## Why it's Unique (The "Edge")
58
+ - **The "Traffic Control Room":** A stunning frontend UI that makes routing decisions transparent and explainable. You don't just route; you see *why* a request went to a specific model.
59
+ - **100% Local & Self-Hosted:** No data leaves the user's infrastructure.
60
+ - **A/B Policy Experimentation:** Built-in tools to test different routing policies (e.g., "lowest cost" vs "balanced") and see projected savings.
61
+ - **Dual-Mode Analyzer:** Uses both fast heuristics (regex/length) and LLM-based complexity scoring to route requests efficiently.
62
+ - **Production-Ready Scalability:** Database-agnostic (SQLite for local dev, PostgreSQL for production) with Redis Pub/Sub powering the real-time SSE traffic telemetry across distributed worker nodes.
63
+ - **Resilient Execution:** Built-in sliding-window circuit breaker dynamically bypasses failing upstream providers to prevent cascading latency spikes.
64
+
49
65
  ## Overview
50
66
 
51
67
  Model Router intercepts incoming AI requests, analyzes their task type and continuous complexity, evaluates available models against a configurable multi-criteria scoring objective, selects the optimal candidate, and dispatches the request with automatic fallback handling and budget guards.
@@ -217,7 +233,8 @@ npm run dev
217
233
 
218
234
  ## CLI Usage
219
235
 
220
- The built-in Typer CLI provides terminal commands for inspection, diagnostics, and testing (use `modelrouter` if installed via pip, or `python backend/app/cli/main.py` from source):
236
+ The built-in Typer CLI provides terminal commands for inspection, diagnostics, and testing (use `modelrouter` if installed via pip, or `python backend/app/cli/main.py` from source).
237
+ You can append `--json` or `-j` to most commands to output raw, pipeable JSON instead of Rich formatted tables:
221
238
 
222
239
  ```bash
223
240
  # Launch the AI Traffic Control Room Web UI and API Gateway
@@ -327,7 +344,7 @@ AI-Model-Router/
327
344
  │ │ ├── providers/ # Decoupled adapters (Mock, Ollama, Cloud)
328
345
  │ │ ├── router/ # Core scoring matrix, pruner, and rules engine
329
346
  │ │ └── storage/ # SQLAlchemy models and SQLite async database
330
- │ ├── tests/ # Pytest test suite (15 passing tests)
347
+ │ ├── tests/ # Pytest test suite (23 passing tests)
331
348
  │ ├── main.py # FastAPI application entrypoint
332
349
  │ └── requirements.txt # Python backend dependencies
333
350
  ├── frontend/
@@ -340,7 +357,8 @@ AI-Model-Router/
340
357
  ├── .gitignore # Git exclusions
341
358
  ├── CODE_OF_CONDUCT.md # Contributor Covenant Code of Conduct
342
359
  ├── CONTRIBUTING.md # Contribution guidelines and workflow
343
- ├── LICENSE # MIT License
360
+ ├── LICENSE # Apache 2.0 License
361
+ ├── milestone.md # Development milestone roadmap & issue tracker
344
362
  ├── README.md # Project documentation
345
363
  ├── requirements.txt # Root Python dependencies
346
364
  └── SECURITY.md # Vulnerability reporting and security policy
@@ -364,7 +382,7 @@ Security and privacy are core to Model Router. For vulnerability reporting proce
364
382
 
365
383
  ## License
366
384
 
367
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
385
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
368
386
 
369
387
  ---
370
388
 
@@ -1,51 +1,26 @@
1
- Metadata-Version: 2.4
2
- Name: model-router-cli
3
- Version: 1.0.2
4
- Summary: Intelligent, explainable LLM request routing platform & AI Traffic Control Room
5
- Author-email: PicadoLabs <picadolabs@gmail.com>
6
- Maintainer-email: Kaap10 <picadolabs@gmail.com>
7
- License: MIT
8
- Project-URL: Homepage, https://picadolabs.me
9
- Project-URL: Repository, https://github.com/PicadoLabs/ai-model-router
10
- Project-URL: Issues, https://github.com/PicadoLabs/ai-model-router/issues
11
- Keywords: llm,ai,router,fastapi,ollama,openai,cost-optimization
12
- Classifier: Development Status :: 4 - Beta
13
- Classifier: Intended Audience :: Developers
14
- Classifier: License :: OSI Approved :: MIT License
15
- Classifier: Programming Language :: Python :: 3
16
- Classifier: Programming Language :: Python :: 3.10
17
- Classifier: Programming Language :: Python :: 3.11
18
- Classifier: Programming Language :: Python :: 3.12
19
- Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
20
- Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
21
- Requires-Python: >=3.10
22
- Description-Content-Type: text/markdown
23
- License-File: LICENSE
24
- Requires-Dist: fastapi>=0.110.0
25
- Requires-Dist: uvicorn[standard]>=0.28.0
26
- Requires-Dist: pydantic>=2.6.0
27
- Requires-Dist: pydantic-settings>=2.2.0
28
- Requires-Dist: sqlalchemy>=2.0.28
29
- Requires-Dist: aiosqlite>=0.20.0
30
- Requires-Dist: httpx>=0.27.0
31
- Requires-Dist: typer>=0.12.0
32
- Requires-Dist: rich>=13.7.0
33
- Requires-Dist: sse-starlette>=2.0.0
34
- Requires-Dist: python-multipart>=0.0.9
35
- Requires-Dist: python-dotenv>=1.0.1
36
- Requires-Dist: tiktoken>=0.6.0
37
- Dynamic: license-file
38
-
39
1
  # Model Router
40
2
 
41
3
  [![PyPI - Version](https://img.shields.io/pypi/v/model-router-cli?logo=pypi&logoColor=white&color=blue)](https://pypi.org/project/model-router-cli/)
42
4
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/model-router-cli?logo=python&logoColor=white)](https://pypi.org/project/model-router-cli/)
43
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
6
+ [![Downloads](https://static.pepy.tech/badge/model-router-cli)](https://pepy.tech/project/model-router-cli)
44
7
 
45
8
  Intelligent, explainable, cost- and latency-aware LLM request routing platform and AI Traffic Control Room.
46
9
 
47
10
  ---
48
11
 
12
+
13
+ ## The Real-World Problem
14
+ Companies building AI applications face ballooning API costs, rate limits, and latency spikes. They want to use large models (like GPT-4 or Claude 3.5 Sonnet) for complex reasoning, but cheaper/faster models (like Llama 3 or Haiku) for simple tasks. Manually writing logic to route these requests is brittle and hard to maintain.
15
+
16
+ ## Why it's Unique (The "Edge")
17
+ - **The "Traffic Control Room":** A stunning frontend UI that makes routing decisions transparent and explainable. You don't just route; you see *why* a request went to a specific model.
18
+ - **100% Local & Self-Hosted:** No data leaves the user's infrastructure.
19
+ - **A/B Policy Experimentation:** Built-in tools to test different routing policies (e.g., "lowest cost" vs "balanced") and see projected savings.
20
+ - **Dual-Mode Analyzer:** Uses both fast heuristics (regex/length) and LLM-based complexity scoring to route requests efficiently.
21
+ - **Production-Ready Scalability:** Database-agnostic (SQLite for local dev, PostgreSQL for production) with Redis Pub/Sub powering the real-time SSE traffic telemetry across distributed worker nodes.
22
+ - **Resilient Execution:** Built-in sliding-window circuit breaker dynamically bypasses failing upstream providers to prevent cascading latency spikes.
23
+
49
24
  ## Overview
50
25
 
51
26
  Model Router intercepts incoming AI requests, analyzes their task type and continuous complexity, evaluates available models against a configurable multi-criteria scoring objective, selects the optimal candidate, and dispatches the request with automatic fallback handling and budget guards.
@@ -217,7 +192,8 @@ npm run dev
217
192
 
218
193
  ## CLI Usage
219
194
 
220
- The built-in Typer CLI provides terminal commands for inspection, diagnostics, and testing (use `modelrouter` if installed via pip, or `python backend/app/cli/main.py` from source):
195
+ The built-in Typer CLI provides terminal commands for inspection, diagnostics, and testing (use `modelrouter` if installed via pip, or `python backend/app/cli/main.py` from source).
196
+ You can append `--json` or `-j` to most commands to output raw, pipeable JSON instead of Rich formatted tables:
221
197
 
222
198
  ```bash
223
199
  # Launch the AI Traffic Control Room Web UI and API Gateway
@@ -327,7 +303,7 @@ AI-Model-Router/
327
303
  │ │ ├── providers/ # Decoupled adapters (Mock, Ollama, Cloud)
328
304
  │ │ ├── router/ # Core scoring matrix, pruner, and rules engine
329
305
  │ │ └── storage/ # SQLAlchemy models and SQLite async database
330
- │ ├── tests/ # Pytest test suite (15 passing tests)
306
+ │ ├── tests/ # Pytest test suite (23 passing tests)
331
307
  │ ├── main.py # FastAPI application entrypoint
332
308
  │ └── requirements.txt # Python backend dependencies
333
309
  ├── frontend/
@@ -340,7 +316,8 @@ AI-Model-Router/
340
316
  ├── .gitignore # Git exclusions
341
317
  ├── CODE_OF_CONDUCT.md # Contributor Covenant Code of Conduct
342
318
  ├── CONTRIBUTING.md # Contribution guidelines and workflow
343
- ├── LICENSE # MIT License
319
+ ├── LICENSE # Apache 2.0 License
320
+ ├── milestone.md # Development milestone roadmap & issue tracker
344
321
  ├── README.md # Project documentation
345
322
  ├── requirements.txt # Root Python dependencies
346
323
  └── SECURITY.md # Vulnerability reporting and security policy
@@ -364,7 +341,7 @@ Security and privacy are core to Model Router. For vulnerability reporting proce
364
341
 
365
342
  ## License
366
343
 
367
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
344
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
368
345
 
369
346
  ---
370
347
 
@@ -1,4 +1,4 @@
1
- import uuid
1
+ import uuid
2
2
  import time
3
3
  import asyncio
4
4
  import csv
@@ -6,11 +6,13 @@ import io
6
6
  from typing import List, Optional, Dict, Any
7
7
  from fastapi import APIRouter, Depends, HTTPException, Query
8
8
  from fastapi.responses import JSONResponse, StreamingResponse
9
+ from sse_starlette.sse import EventSourceResponse
9
10
  from pydantic import BaseModel, Field
10
11
  from sqlalchemy.ext.asyncio import AsyncSession
11
12
  from sqlalchemy import select, desc
12
13
 
13
14
  from app.storage.database import get_db
15
+ from app.storage.redis_client import get_redis
14
16
  from app.storage.models import (
15
17
  ModelRecord,
16
18
  RoutingPolicyRecord,
@@ -36,6 +38,7 @@ from app.budgets.manager import check_budget_threshold
36
38
  from app.observability.events import log_router_event
37
39
  from app.analytics.service import get_system_analytics, calculate_cost_savings
38
40
  from app.providers.registry import provider_registry
41
+ from app.fallback.circuit_breaker import circuit_breaker
39
42
  from app.config.settings import get_settings
40
43
 
41
44
  router = APIRouter()
@@ -56,6 +59,8 @@ class GenerateRequest(BaseModel):
56
59
  force_model: Optional[str] = None
57
60
  temperature: float = 0.7
58
61
  max_retries: int = 1
62
+ stream: bool = False
63
+ stream: bool = False
59
64
 
60
65
 
61
66
  class FeedbackSubmitRequest(BaseModel):
@@ -223,7 +228,122 @@ async def api_generate_response(req: GenerateRequest, db: AsyncSession = Depends
223
228
  target_meta = next((m for m in models if m.id == selected_model_id), None)
224
229
  selected_provider_id = target_meta.provider if target_meta else decision.provider
225
230
 
226
- # 5. Provider Execution with Fallback & Retries
231
+ if req.stream:
232
+ from app.storage.database import AsyncSessionLocal
233
+ import json
234
+
235
+ async def stream_generator():
236
+ p_id = selected_provider_id
237
+ m_id = selected_model_id
238
+ is_fallback = False
239
+
240
+ if not circuit_breaker.is_available(p_id):
241
+ p_id = "mock"
242
+ m_id = "mock-balanced"
243
+ is_fallback = True
244
+
245
+ provider = provider_registry.get_provider(p_id) or provider_registry.get_provider("mock")
246
+ full_content = ""
247
+ first_token_ms = None
248
+ t_stream_start = time.perf_counter()
249
+
250
+ yield {"event": "start", "data": json.dumps({"model": m_id, "provider": p_id})}
251
+
252
+ try:
253
+ async for chunk in provider.stream(
254
+ prompt=req.prompt,
255
+ model_id=m_id,
256
+ system_prompt=req.system_prompt,
257
+ temperature=req.temperature,
258
+ ):
259
+ if first_token_ms is None:
260
+ first_token_ms = (time.perf_counter() - t_stream_start) * 1000.0
261
+ full_content += chunk
262
+ yield {"event": "chunk", "data": json.dumps({"chunk": chunk})}
263
+ except Exception as e:
264
+ yield {"event": "error", "data": json.dumps({"error": str(e)})}
265
+
266
+ t_total = time.perf_counter() - t_start
267
+
268
+ async with AsyncSessionLocal() as stream_db:
269
+ in_tok = max(1, len(req.prompt) // 4)
270
+ out_tok = max(1, len(full_content) // 4)
271
+ cost_in = target_meta.cost_per_input_token if target_meta else 0.0
272
+ cost_out = target_meta.cost_per_output_token if target_meta else 0.0
273
+ actual_cost = round((in_tok * cost_in) + (out_tok * cost_out), 6)
274
+
275
+ res_base = await stream_db.execute(select(ModelRecord).filter_by(id=settings.BASELINE_MODEL_ID))
276
+ base_m = res_base.scalar_one_or_none()
277
+ base_cost = round((in_tok * base_m.cost_per_input_token) + (out_tok * base_m.cost_per_output_token), 6) if base_m else 0.0
278
+ saved_cost = max(0.0, round(base_cost - actual_cost, 6))
279
+
280
+ from app.budgets.manager import check_budget_threshold
281
+ await check_budget_threshold(stream_db, actual_cost)
282
+
283
+ req_record = RequestRecord(
284
+ request_id=req_id,
285
+ prompt=req.prompt,
286
+ task_type=analysis.task_type.value,
287
+ complexity=analysis.complexity,
288
+ context_size=analysis.context_size,
289
+ reasoning_required=analysis.reasoning_required,
290
+ coding_required=analysis.coding_required,
291
+ routing_policy=policy_name,
292
+ selected_model=m_id,
293
+ provider=p_id,
294
+ status="SUCCESS",
295
+ fallback_used=is_fallback,
296
+ input_tokens=in_tok,
297
+ output_tokens=out_tok,
298
+ total_tokens=in_tok + out_tok,
299
+ estimated_cost=actual_cost,
300
+ baseline_cost=base_cost,
301
+ cost_saved=saved_cost,
302
+ routing_latency_ms=round(routing_latency_ms, 2),
303
+ provider_latency_ms=round((time.perf_counter() - t_stream_start) * 1000.0, 2),
304
+ total_latency_ms=round(t_total * 1000.0, 2),
305
+ time_to_first_token_ms=round(first_token_ms, 2) if first_token_ms else 0.0,
306
+ )
307
+ stream_db.add(req_record)
308
+
309
+ decision_record = RoutingDecisionRecord(
310
+ decision_id=decision.decision_id,
311
+ request_id=req_id,
312
+ selected_model=decision.selected_model,
313
+ confidence=decision.confidence,
314
+ reasons=decision.reasons,
315
+ candidate_scores=[s.model_dump() for s in decision.candidate_scores],
316
+ rejected_candidates=decision.rejected_candidates,
317
+ policy_used=policy_name,
318
+ )
319
+ stream_db.add(decision_record)
320
+
321
+ resp_record = ResponseRecord(
322
+ response_id=f"resp_{uuid.uuid4().hex[:12]}",
323
+ request_id=req_id,
324
+ model_id=m_id,
325
+ provider=p_id,
326
+ content=full_content,
327
+ finish_reason="stop",
328
+ is_mock=(p_id == "mock"),
329
+ )
330
+ stream_db.add(resp_record)
331
+ await stream_db.commit()
332
+
333
+ log_router_event(
334
+ event_name="request_completed_stream",
335
+ request_id=req_id,
336
+ model=m_id,
337
+ provider=p_id,
338
+ duration_ms=round(t_total * 1000.0, 2),
339
+ metadata={"tokens": in_tok + out_tok, "cost": actual_cost, "fallback": is_fallback},
340
+ )
341
+
342
+ yield {"event": "done", "data": "[DONE]"}
343
+
344
+ return EventSourceResponse(stream_generator())
345
+
346
+ # 5. Provider Execution with Fallback & Retries (Non-stream)
227
347
  provider_resp, fallback_used, orig_model, fallback_reason = await execute_with_fallback(
228
348
  prompt=req.prompt,
229
349
  selected_model_id=selected_model_id,
@@ -334,6 +454,7 @@ async def api_generate_response(req: GenerateRequest, db: AsyncSession = Depends
334
454
  }
335
455
 
336
456
 
457
+
337
458
  # Models & Registry Endpoints
338
459
  @router.get("/api/models")
339
460
  async def list_models(db: AsyncSession = Depends(get_db)):
@@ -389,6 +510,26 @@ async def get_traffic_feed(limit: int = 50, db: AsyncSession = Depends(get_db)):
389
510
  return res.scalars().all()
390
511
 
391
512
 
513
+
514
+ @router.get("/api/traffic/stream")
515
+ async def traffic_stream():
516
+ redis = get_redis()
517
+ if not redis:
518
+ raise HTTPException(status_code=503, detail="Redis Pub/Sub not available")
519
+
520
+ async def event_generator():
521
+ pubsub = redis.pubsub()
522
+ await pubsub.subscribe("traffic_stream")
523
+ try:
524
+ async for message in pubsub.listen():
525
+ if message["type"] == "message":
526
+ yield {"event": "traffic", "data": message["data"]}
527
+ finally:
528
+ await pubsub.unsubscribe("traffic_stream")
529
+ await pubsub.close()
530
+
531
+ return EventSourceResponse(event_generator())
532
+
392
533
  @router.get("/api/traffic/export")
393
534
  async def export_traffic(
394
535
  format: str = Query("json", pattern="^(csv|json)$"),