lazycontroller 0.1.0__tar.gz

lazycontroller-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lazycontroller-0.1.0/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: lazycontroller
+Version: 0.1.0
+Summary: A drop-in replacement for the openai Python client that sends structured-output calls to a fast decision model first, and to the LLM you already use whenever that model isn't confident or the call isn't a decision.
+Keywords: cost-optimization,decision-model,inference-optimization,llm-routing,model-routing,openai,structured-output
+Author: Nicola Sambin
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: openai>=3.44,<4
+Requires-Dist: typesafe-sdk>=0.7.5,<0.8
+Requires-Python: >=3.13
+Project-URL: Documentation, https://nicolasambin.github.io/lazycontroller/
+Project-URL: Repository, https://github.com/nicolasambin/lazycontroller
+Project-URL: Issues, https://github.com/nicolasambin/lazycontroller/issues
+Project-URL: Changelog, https://github.com/nicolasambin/lazycontroller/releases
+Description-Content-Type: text/markdown
+
+# lazycontroller
+
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/nicolasambin/lazycontroller/blob/main/LICENSE)
+![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue.svg)
+![Status: alpha](https://img.shields.io/badge/status-alpha-orange.svg)
+
+lazycontroller is a drop-in replacement for the `openai` Python client. When your code asks an
+LLM for structured output that is really a decision (a category, a yes/no, a score), it asks a
+fast decision model first and uses its answer if every field is confident enough; otherwise the
+call goes to your LLM, unchanged.
+
+## Why
+
+Codebases everywhere are full of `OpenAI()` clients asking GPT-class models to categorize a
+transaction, flag a message or pick a label, and paying LLM prices and latency for what is really
+a decision. Decision models now do that job in milliseconds, for a fraction of the cost, and
+tell you how sure they are. You don't need to rewrite anything to use them: change one import.
+
+```python
+# from openai import OpenAI
+from lazycontroller import OpenAI
+```
+
+When the decision model is confident, it answers. When it isn't, or when the call isn't a
+decision at all, the request goes to the model you were already calling, exactly as before.
+
+## Why "lazycontroller"
+
+In *Thinking, Fast and Slow*, Daniel Kahneman calls the deliberate mind, his System 2, a *lazy
+controller*: it is in charge, but it lets the fast, intuitive System 1 handle whatever it can,
+and steps in only when that isn't enough. lazycontroller works the same way. A fast decision
+model (a "System One" model) answers the calls it is sure about; the slow LLM you were already
+using is called only when it isn't.
+
+## Install
+
+```bash
+pip install lazycontroller
+```
+
+or `uv add lazycontroller`. Requires Python 3.13+.
+
+## Quickstart
+
+Your existing OpenAI client stays the slow side; the fast side here is Jev, a decision model,
+reached through OpenRouter.
+
+```python
+import os
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from lazycontroller import FastConfig, OpenAI
+
+client = OpenAI(  # the slow side, as before: reads OPENAI_API_KEY
+    fast=FastConfig(  # the fast side: a System One decision model
+        base_url="https://openrouter.ai/api",
+        api_key=os.environ["OPENROUTER_API_KEY"],
+        model="typesafe/jev-1.14",
+        min_confidence=0.9,  # every field must reach it, or the call goes to GPT
+    ),
+)
+
+
+class Transaction(BaseModel):
+    category: Literal[
+        "groceries",
+        "dining",
+        "transport",
+        "shopping",
+        "subscriptions",
+        "utilities",
+        "income",
+        "transfer",
+    ] = Field(description="What the money was spent on, or where it came from")
+
+
+for line in ["NETFLIX.COM 866-579-7172 CA", "GITHUB, INC. SAN FRANCISCO"]:
+    completion = client.chat.completions.parse(
+        model="gpt-6-luna",
+        messages=[
+            {"role": "system", "content": "Categorize this bank transaction."},
+            {"role": "user", "content": line},
+        ],
+        response_format=Transaction,
+    )
+    print(line, "->", completion.choices[0].message.parsed.category, "by", completion.model)
+
+# NETFLIX.COM 866-579-7172 CA -> subscriptions by typesafe/jev-1.14-20261014
+# GITHUB, INC. SAN FRANCISCO -> ... by gpt-6-luna-...
+```
+
+Jev is certain the first line is a subscription (confidence 1.00), so it answers and GPT is
+never called. The second could be a subscription or a one-off purchase; Jev is less sure
+(around 0.7–0.8, below the default `min_confidence` of 0.9), so the call goes to GPT as it always did.
+Either way you get the same `ParsedChatCompletion`.
+
+[`examples/transactions.ipynb`](https://nicolasambin.github.io/lazycontroller/examples/transactions/) goes further: shadow mode on ten
+transactions, a sweep over `min_confidence`, `with_fast`, a call that isn't a decision, and the same thing
+running locally with Ollama. It needs no Jupyter in your project:
+
+```bash
+uv run --with jupyterlab --with matplotlib --env-file .env jupyter lab examples/transactions.ipynb
+```
+
+## Choosing a fast model
+
+The fast side is any server speaking the System One API; the slow side is any OpenAI-compatible
+API (OpenAI, OpenRouter, Ollama, vLLM, ...).
+
+| Fast model server | `base_url` | `api_key` | Example `model` |
+|---|---|---|---|
+| TypeSafe | `"https://api.typesafe.ai"` | your TypeSafe key | `"jev-latest"` |
+| OpenRouter | `"https://openrouter.ai/api"` | your OpenRouter key | `"typesafe/jev-1.14"` |
+| Ollama (local) | `"http://localhost:11434"` | none | `"kev:0.8b-q8_0"` |
+
+Decision models don't all support the same questions: some answer yes/no only.
+More in [configuration](https://nicolasambin.github.io/lazycontroller/configuration/#fast-model-servers).
+
+## How it works
+
+For `chat.completions.create` / `parse` and `responses.create` / `parse`:
+
+1. **Is it a decision?** The schema must ask only for closed decisions: `Literal`/`Enum`
+   (Choice), `bool` (yes/no), small integer ranges (Score), optionally nested or `| None`. A
+   free-text field, tools, streaming, images and the like send the call to the slow model
+   untouched.
+2. **Ask the fast model.** All fields go in one request, with the conversation as structured
+   JSON state and each field's `description` as its question.
+3. **Gate on confidence.** If *every* field reaches `min_confidence`, lazycontroller builds a real
+   OpenAI response object from the fast answer. Otherwise the original request goes to the slow
+   model. It's all or nothing, so you never get a half-fast, half-slow answer.
+
+If the fast model errors or lazycontroller can't read a request, the call goes to the slow model
+as if lazycontroller weren't there: it can save you calls, never break them.
+
+Details, and how to write schemas a decision model answers well: [schemas and
+requests](https://nicolasambin.github.io/lazycontroller/schemas/).
+
+## Configuration
+
+`OpenAI` / `AsyncOpenAI` take every `openai` argument (the slow side) plus
+`fast=FastConfig(...)`:
+
+```python
+FastConfig(
+    base_url=None,  # the System One server; None turns the fast side off
+    api_key=None,  # key for base_url, sent nowhere else
+    model=None,  # the decision model; None means the server's default
+    min_confidence=0.9,  # every field must reach it, or the call goes to the slow model
+    enabled=True,  # False sends everything to the slow model
+    shadow=False,  # ask both, return the slow answer, report disagreements
+    on_route=None,  # called with a Route after every intercepted call
+)
+```
+
+To vary settings for part of your code, derive a copy, like `with_options`:
+
+```python
+refunds = client.with_fast(min_confidence=0.97)  # a wrong answer costs more here
+```
+
+All settings, keys and providers: [configuration](https://nicolasambin.github.io/lazycontroller/configuration/).
+
+## Monitoring and choosing `min_confidence`
+
+Every intercepted call produces a `Route`: who answered (`fast` or `slow`), why, and the
+confidence of each field. Collect them to see how much traffic the fast model takes.
+
+The default `min_confidence`, 0.9, is cautious. To choose yours, run with `shadow=True` on real
+traffic: both models answer, your users get the slow answer, and each route records whether the
+two agreed. A `ShadowReport` turns those routes into coverage and agreement for each `min_confidence`:
+
+```python
+from lazycontroller import ShadowReport
+
+report = ShadowReport(routes)
+print(report.table())
+report.suggest_min_confidence(min_agreement=0.98)  # lowest value keeping 98% agreement
+```
+
+Route fields, shadow mode and `ShadowReport`: [routing](https://nicolasambin.github.io/lazycontroller/routing/).
+
+## Data and privacy
+
+- With a hosted fast model, the conversation of every eligible call is also sent to that
+  provider (TypeSafe, OpenRouter, ...). Check that this fits your data agreements before
+  enabling it. A local fast model keeps everything on your machine.
+- In shadow mode, eligible calls go to both providers.
+- Free models on some platforms may use requests for training; don't send real data to them.
+- Keys go only where they belong: `FastConfig.api_key` is sent only to `FastConfig.base_url`, and no
+  key is picked up from the environment for the fast side.
+
+To report a security issue, see [SECURITY.md](https://nicolasambin.github.io/lazycontroller/security/).
+
+## Limitations
+
+- Forced tool calls (`tool_choice` with a function) aren't treated as structured output yet,
+  so they always go to the slow model.
+- Only OpenAI-style clients for now: no `from lazycontroller import Anthropic` yet.
+- `with_raw_response`, `with_streaming_response` and streaming always go to the slow model.
+- Answers from the fast model aren't stored by the slow model's provider (`store=True` has no
+  effect on them).
+
+## Development
+
+The project is managed with [uv](https://docs.astral.sh/uv/). CI runs lint and tests on Python
+3.13–3.15 for every pull request.
+
+```bash
+uv run pytest                              # tests (both models are faked, no keys needed)
+uv run --python 3.13 --isolated pytest     # tests on the minimum version
+uv run ruff check && uv run ruff format    # lint and format
+```
+
+The documentation site is built with [Zensical](https://zensical.org) from `docs/`:
+
+```bash
+uv run --group docs python scripts/notebooks_to_docs.py   # example notebooks -> pages
+uv run --group docs zensical serve                        # preview, reloads on changes
+```
+
+[`examples/transactions.ipynb`](https://nicolasambin.github.io/lazycontroller/examples/transactions/) is a runnable tour of the library;
+`uv run --with jupyterlab --with matplotlib` opens it without adding either to the project.
+
+## License
+
+[Apache License 2.0](https://github.com/nicolasambin/lazycontroller/blob/main/LICENSE).