coalent 0.2.0__tar.gz

coalent-0.2.0/.gitignore

@@ -0,0 +1,36 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+env/
+
+# Tooling
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# IDE / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+
+# Internal — NOT for publication (audits, planning, design, commercial strategy).
+# NOTE: this only keeps them out of a *fresh* repo. The existing repo's history
+# already contains them — publish from a clean repo (see RELEASING notes).
+/ARCHITECTURE_REVIEW.md
+/REMEDIATION_PLAN.md
+/INTELLIGENCE_CORE_CONTRACT.md
+/PHASE1_PLAN.md
+/OPEN_CORE.md
+/cognitive-cache-design.html
+# Review before publishing — likely internal:
+/RELEASING.md
+/brand/showcase.html

coalent-0.2.0/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project are documented here. This project adheres to
+[Semantic Versioning](https://semver.org/).
+
+## [0.2.0]
+
+First public release — a real-time, provenance-invalidated cognitive cache for AI
+agents and RAG. Framework-neutral, pluggable, and fully typed.
+
+### Added
+- **SemanticCache** — a `get(query)` read path: an embedding-keyed cache of
+  decision-ready understanding that retains the raw evidence with every unit, so it
+  can never return less than plain retrieval.
+- **Provenance invalidation** — each unit records the exact sources it used;
+  `source_changed` / `source_deleted` dirty only the units that used them and skip
+  no-op changes via a content-hash compare. Units re-materialize lazily on read.
+- **Retrievers** — `InMemoryRetriever`, `FunctionRetriever`, `CompositeRetriever`, a
+  `BaseVectorRetriever`, and shipped bring-your-own-client adapters for Qdrant,
+  Chroma, and pgvector (with pass-through search).
+- **Synthesizers** — `LLMSynthesizer` (structured, citation-grounded understanding;
+  user-owned instruction + fields) and `JSONPassthroughSynthesizer` (cache already
+  structured tool/API JSON with no LLM call). Providers for OpenAI, Anthropic, and a
+  deterministic stub.
+- **Context intelligence** — coverage gate with auto-escalation, minimum-context
+  projection, context strategies, and lazy cross-unit relationships.
+- **Freshness** — `FreshnessPolicy` (TTL + revalidate-by-hash) for feed-less
+  API/tool sources.
+- **Persistence** — durable, restart-safe stores: `InMemoryCognitionStore`,
+  `SQLiteCognitionStore` (stdlib, no server), and `RedisCognitionStore`. The
+  invalidation graph rebuilds on startup.
+- **Events** — GitHub / deploy / Jira / generic-CDC connectors with HMAC signature
+  verification and an event dispatcher.
+- **Integrations** — a graph-node helper (`make_cognition_node`) and MCP tool specs
+  (`build_mcp_tools`) over the one-call read API.
+- **CLI** — `coalent` inspects and manages a persistent cache (ls / show / dirty /
+  invalidate / evict / purge / stats).
+- **Eval harness** — measures accuracy, stale-rate, and token cost against naive RAG
+  and a no-invalidation cache.
+
+### Notes
+- The core installs with **zero required dependencies**. Optional extras add LLM
+  providers (`openai`, `anthropic`), vector adapters (`qdrant`, `chroma`,
+  `pgvector`), the distributed store (`redis`), and a webhook server (`server`).
+- Alpha: the public API may change before 1.0.

coalent-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Nisarg Pujara
+
+   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.

coalent-0.2.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: coalent
+Version: 0.2.0
+Summary: A real-time, provenance-invalidated cognitive cache layer for AI agents and RAG.
+Project-URL: Homepage, https://github.com/Vectorlink-Labs/coalent
+Project-URL: Repository, https://github.com/Vectorlink-Labs/coalent
+Project-URL: Documentation, https://github.com/Vectorlink-Labs/coalent#readme
+Project-URL: Issues, https://github.com/Vectorlink-Labs/coalent/issues
+Author-email: Nisarg Pujara <nisarg.pujara@vectorlinklabs.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,cache,context,context-engineering,crewai,langgraph,llm,mcp,provenance,rag
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.40; extra == 'anthropic'
+Provides-Extra: chroma
+Requires-Dist: chromadb>=0.4; extra == 'chroma'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: langgraph
+Requires-Dist: langgraph>=0.2; extra == 'langgraph'
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == 'mcp'
+Provides-Extra: openai
+Requires-Dist: openai>=1.0; extra == 'openai'
+Provides-Extra: pgvector
+Requires-Dist: psycopg[binary]>=3.1; extra == 'pgvector'
+Provides-Extra: qdrant
+Requires-Dist: qdrant-client>=1.7; extra == 'qdrant'
+Provides-Extra: redis
+Requires-Dist: redis>=5.0; extra == 'redis'
+Provides-Extra: server
+Requires-Dist: fastapi>=0.110; extra == 'server'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Vectorlink-Labs/coalent/main/brand/wordmark.png" alt="Coalent" width="320">
+</p>
+
+<p align="center">
+  <b>Real-time, provenance-invalidated context for AI agents &amp; RAG.</b><br>
+  <i>Build understanding once. Reuse it everywhere. Keep it fresh — automatically.</i>
+</p>
+
+<p align="center">
+  <img alt="pypi" src="https://img.shields.io/pypi/v/coalent?color=5145E5">
+  <img alt="python" src="https://img.shields.io/badge/python-3.10%2B-4F46E5">
+  <img alt="license" src="https://img.shields.io/badge/license-Apache%202.0-22D3EE">
+  <img alt="typed" src="https://img.shields.io/badge/mypy-strict-2DD4BF">
+  <img alt="tests" src="https://img.shields.io/badge/tests-passing-10B981">
+</p>
+
+<p align="center">
+  <b>📖 <a href="https://coalent.ai/docs">Documentation</a></b> &nbsp;·&nbsp; <a href="https://coalent.ai">coalent.ai</a>
+</p>
+
+<p align="center">
+  <a href="#quickstart">Quickstart</a> ·
+  <a href="#how-it-works">How it works</a> ·
+  <a href="#bring-your-own-stack">Bring your own stack</a> ·
+  <a href="#benchmark">Benchmark</a> ·
+  <a href="#cli">CLI</a>
+</p>
+
+---
+
+> **Your agent re-reads the same sources on every call — and the moment a source changes, every cached answer is silently wrong.**
+>
+> Coalent builds the *understanding* once, caches it by what the query **means**, and invalidates it **surgically** the instant an underlying source changes. As correct as re-reading everything, at a fraction of the cost — and never stale.
+
+## Why Coalent
+
+Every context layer is forced to trade off three things. Coalent is built to hold all three at once:
+
+- 🧠 **Understanding, not chunks.** It caches the decision-ready understanding your LLM produced — *and retains the raw evidence with every unit*, so it can never return less than plain retrieval.
+- ♻️ **Reuse across queries and agents.** A semantic cache keyed by query *meaning*: ask again, or from another agent, and it's a warm hit — no re-retrieval, no re-synthesis.
+- 🌿 **Fresh by provenance.** Every unit remembers the exact sources it used. When one changes, only the units that actually used it go stale — precisely, automatically, and lazily.
+
+Coalent sits **above retrieval** — bring any retriever (vector DB, hybrid search, GraphRAG, tools, APIs). It's the freshness-and-reuse layer, not another retriever.
+
+## Install
+
+```bash
+pip install coalent          # the core has zero required dependencies
+```
+
+## Quickstart
+
+Runs as-is — `StubSynthesizer` needs no API key, so you can feel the loop in ten seconds:
+
+```python
+from coalent import SemanticCache, InMemoryRetriever, StubSynthesizer
+
+# 1. Any retriever — a vector DB, a tool, an API. (In-memory here for the demo.)
+retriever = InMemoryRetriever()
+retriever.add("confluence:hr", "Leave policy: 21 days of annual leave per year.")
+
+# 2. Build the cache. Swap StubSynthesizer for a real LLM below.
+cache = SemanticCache(retriever, StubSynthesizer())
+
+# 3. Ask. The first call builds understanding and caches it; the next is a warm hit.
+result = cache.get("what is our leave policy?")
+print(result.context["understanding"])
+print(result.cache_hit)        # False (cold) -> True on the next call
+
+# 4. A source changed? Only the units that used it go stale — surgically.
+cache.source_changed("confluence:hr", text="Leave policy: now 25 days.")
+# the next matching read rebuilds just that one unit, lazily
+```
+
+Wire in a real model — any text-in / text-out LLM works:
+
+```python
+from coalent import SemanticCache, LLMSynthesizer, OpenAIProvider
+
+cache = SemanticCache(retriever, LLMSynthesizer(OpenAIProvider(), model="gpt-4o-mini"))
+```
+
+## How it works
+
+```
+        query ──► embed ──► semantic cache
+                               │  hit & fresh?  ──► serve cached understanding  (no retrieval, no LLM)
+                               │  miss / stale? ─┐
+                               ▼                 ▼
+                          your Retriever ──► your Synthesizer ──► Cognition unit
+                          (vector/tool/API)   (LLM or passthrough)  { understanding
+                               ▲                                      + raw evidence
+                               │                                      + provenance }
+   source changed ────────────┘   dirties ONLY the units that used that source
+```
+
+1. **Embed the query** and look for an existing unit with similar meaning.
+2. **Hit + fresh** → return the cached understanding (no retrieval, no LLM call).
+3. **Miss or stale** → retrieve, synthesize understanding, **retain the raw evidence**, record **provenance** (the exact sources used), and cache it.
+4. **A source changes** → `source_changed(id)` marks only the units whose provenance includes that id; they rebuild lazily on the next read.
+
+Unchanged content is skipped via a content-hash compare, so a no-op change costs nothing.
+
+## Bring your own stack
+
+Coalent owns a tiny contract and passes everything else through to your tools.
+
+**Retrievers** — a ladder from one-liner to full control:
+
+| You have… | Use |
+|---|---|
+| Qdrant / Chroma / pgvector | a shipped adapter (bring-your-own-client) |
+| another vector DB | extend `BaseVectorRetriever` |
+| an existing search function | `FunctionRetriever` |
+| several sources to fuse | `CompositeRetriever` |
+| anything else | implement `Retriever` (one method) |
+
+```python
+from coalent import QdrantRetriever
+
+retriever = QdrantRetriever(client=my_client, collection="docs", embed=my_embed)
+```
+
+**Synthesizers** — turn evidence into understanding:
+
+- `LLMSynthesizer` — structured, citation-grounded understanding via your LLM (OpenAI, Anthropic, or any provider). You own the `instruction` and `fields`; Coalent owns the source / strict-JSON / citation envelope, so provenance is captured no matter what you ask for.
+- `JSONPassthroughSynthesizer` — for already-structured tool/API JSON: caches it *as* the understanding, **no LLM call**.
+
+**Stores** — durable and restart-safe (the invalidation graph rebuilds on startup):
+
+```python
+from coalent import SemanticCache, SQLiteCognitionStore   # stdlib, no server
+from coalent import RedisCognitionStore                   # shared across processes / hosts
+
+cache = SemanticCache(retriever, synthesizer, store=SQLiteCognitionStore("coalent.db"))
+```
+
+**Any agent framework** — the read API is a single call, so it drops in anywhere. Shipped helpers for graph nodes and MCP tools:
+
+```python
+from coalent import make_cognition_node, build_mcp_tools
+
+node = make_cognition_node(cache)     # a graph node: state -> { context: fresh understanding }
+tools = build_mcp_tools(cache)        # expose the cache as an MCP tool
+```
+
+## Benchmark
+
+A real-LLM, quality-first benchmark (gpt-4o-mini, graded by an independent gpt-4o judge) on number-dense documents — answering from Coalent's *understanding* vs the full raw context, with a source change midway:
+
+| System | Accuracy | Stays fresh | Context tokens / read |
+|---|:---:|:---:|:---:|
+| Full-context RAG | 100% | ✓ | 283 |
+| Normal cache (raw chunks) | 86% | ✗ stale | 283 |
+| **Coalent** | **100%** | **✓** | **96** |
+
+Coalent **matches full-context RAG accuracy** (independently graded), **never goes stale** after a source change (a normal cache does), and sends **~66% fewer context tokens — up to 75% on large documents.** Cost optimization without trading away quality. *(gpt-4o corroborates within ~3%; full two-model breakdown in the [docs](https://coalent.ai/docs/benchmark).)*
+
+## CLI
+
+Installing Coalent gives you a `coalent` command — a `redis-cli` for your cognition cache (over a SQLite store):
+
+```console
+$ coalent ls
+STATUS  HITS  AGE SRC  ID                  QUERY
+fresh      6   2m   2  cog:c95a9d2897e0af  what is our leave policy?
+dirty      1  12m   1  cog:7f1a0b9c3d2e4f  remote work rules
+
+$ coalent show cog:c95a9d2897e0af      # understanding + provenance + raw evidence
+$ coalent invalidate confluence:98231  # fire a change event
+$ coalent stats
+```
+
+## Documentation
+
+📚 **Full docs: [coalent.ai/docs](https://coalent.ai/docs)** — concepts, provenance & freshness, retrievers, synthesizers, persistence, worked examples (vector search, MCP & tools, agents), and the complete `get()` / data-model reference.
+
+## Install options
+
+```bash
+pip install coalent                 # core, zero required deps
+pip install "coalent[openai]"       # OpenAI provider      (also: anthropic)
+pip install "coalent[qdrant]"       # vector adapters      (also: chroma, pgvector)
+pip install "coalent[redis]"        # distributed store
+pip install "coalent[dev]"          # tests + lint + types
+```
+
+## Contributing
+
+Issues and PRs welcome. Run the gate before pushing:
+
+```bash
+pip install -e ".[dev]"
+pytest && ruff check src && mypy src
+```
+
+## Status &amp; license
+
+**Alpha** — the API may change before 1.0. Fully typed (`mypy --strict`), linted, and tested.
+
+Licensed under [Apache-2.0](./LICENSE).
+
+<p align="center"><sub>Context that's trustworthy, not just cheap.</sub></p>