cerid-sdk 0.1.1__tar.gz

cerid_sdk-0.1.1/.gitignore

@@ -0,0 +1,150 @@
+# Secrets & keys
+.env
+.env.age
+.env.local
+.env*.local
+.env.meta.json
+.env.*.bak
+.env.*.backup
+.env.pre-live-*
+.env.post-live-*
+.env.public-sandbox
+.env.sandbox
+.env.*-sandbox
+!.env.example
+*.key
+OPENROUTER_API_KEY*
+OPENAI_API_KEY*
+
+# Environment dumps & inventory
+src/mcp/docs/inventory/
+
+# SQLite databases
+*.db
+*.db-shm
+*.db-wal
+*.db.backup
+*.db.latest
+*.db.new
+stacks/bifrost/config.db.*
+
+# Runtime data & volumes. data/* (not data/) so the eval-corpus
+# exception below can re-include a subtree — git cannot re-include
+# children of an excluded DIRECTORY, only of an excluded glob.
+data/*
+# Exception: the frozen synthetic eval corpus is CI input
+# (eval-exploratory seeds it on GH runners — gitignored data/
+# meant the workflow could never pass remotely; 2026-07-10).
+!data/eval-corpus/
+src/mcp/data/
+.cerid-state/
+src/mcp/.cerid-state/
+
+# contextplus MCP local index (Ollama-backed; regenerated by `npx -y contextplus init claude`)
+.contextplus/
+contextplus.db
+contextplus.db-*
+.mcp_data/
+# Bifrost provider config is safe to commit (uses env.OPENROUTER_API_KEY, no secrets)
+!stacks/bifrost/data/
+stacks/bifrost/data/*
+!stacks/bifrost/data/config.json
+uploads/
+logs/
+/neo4j/
+/chroma/
+/redis/
+stacks/infrastructure/data/
+artifacts/
+artifacts
+# Nested runtime data dirs (the old bare `data` rule matched any depth;
+# scoped to the known ones so the root data/eval-corpus carve-out works).
+src/mcp/app/data/
+src/mcp/tests/eval/longmemeval/data/
+
+# Node
+node_modules/
+
+# Next.js / Vercel build artifacts
+.next/
+.vercel/
+
+# Python / build
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+env/
+venv/
+.venv/
+src/mcp/VERSION
+
+# macOS / temp
+.DS_Store
+*.swp
+*~
+Thumbs.db
+
+# Runtime logs
+**/*.log
+**/diagnostic.data/
+**/journal/
+
+# User documents - never commit
+*.pdf
+*.docx
+*.xlsx
+*.csv
+/archive/
+cerid-archive/
+inbox/
+.worktrees/
+backups/
+
+# Electron build output
+packages/desktop/out/
+packages/desktop/release/
+
+# TypeScript SDK build output (regenerated by `npm run build`)
+packages/sdk/typescript/dist/
+
+# AI assistant artifacts
+.superpowers/
+.internal/
+tests/beta/reports/
+tests/beta/eval/reports/
+
+# Internal task tracking & plans (not for public repo)
+tasks/
+.claude/plans/
+# Claude Code session lock files — runtime artifacts, expire on session end
+.claude/*.lock
+# Agent worktrees — live `git worktree` checkouts (184MB as of 2026-07-30).
+# Registered in .git/worktrees, so they are real checkouts, never repo content.
+.claude/worktrees/
+
+# Runtime log artifacts
+src/mcp/rag-api-logs.txt
+
+# Working documents (not for public repo)
+tests/BUG_REPORT.md
+
+# Smoke test scratch directory (host path, outside repo)
+/tmp/cerid-smoke/
+test-results/
+
+# Playwright MCP runtime output
+.playwright-mcp/
+docker-compose.override.yml
+
+# Eval harness outputs (Phase 0 quality program)
+src/mcp/tests/eval/out/
+scripts/out/
+.mutation-check.lock
+.ci-artifacts/

cerid_sdk-0.1.1/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright (c) 2026 Cerid AI. All rights reserved.
+
+   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.

cerid_sdk-0.1.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: cerid-sdk
+Version: 0.1.1
+Summary: Python SDK for Cerid AI Knowledge Companion
+Author-email: Cerid AI <dev@cerid.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai,cerid,knowledge-base,rag,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.25
+Requires-Dist: pydantic>=2.0
+Provides-Extra: async
+Requires-Dist: httpx[http2]; extra == 'async'
+Provides-Extra: test
+Requires-Dist: jsonschema; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Description-Content-Type: text/markdown
+
+# cerid-sdk
+
+Python client for the [Cerid AI Knowledge Companion](https://github.com/Cerid-AI/cerid-ai) HTTP API.
+
+```bash
+pip install cerid-sdk
+```
+
+Sync and async clients with typed responses. Resource groups for the
+knowledge base, hallucination verification, semantic memory, and
+system endpoints. Built against the stable `/sdk/v1/` surface; protocol
+drift is enforced server-side by the `sdk-openapi-drift` CI gate.
+
+## Quickstart
+
+```python
+from cerid import CeridClient
+
+client = CeridClient(base_url="http://localhost:8888")
+
+# Search the knowledge base
+results = client.kb.query("what did I read about graph databases last week?")
+for chunk in results.chunks:
+    print(chunk.text, chunk.score)
+
+# Verify a generated answer against the KB
+report = client.verify.check(
+    response_text="Cerid uses Neo4j for graph storage.",
+    conversation_id="demo",
+)
+print(report.faithfulness, report.unsupported_claims)
+
+# Recall semantic memory
+memories = client.memory.recall("preferred deployment topology", top_k=5)
+```
+
+## Async client
+
+```python
+import asyncio
+from cerid import AsyncCeridClient
+
+async def main():
+    async with AsyncCeridClient(base_url="http://localhost:8888") as client:
+        results = await client.kb.query("graph databases")
+        print(results.total)
+
+asyncio.run(main())
+```
+
+## Resource groups
+
+| Group | Endpoint | Purpose |
+|---|---|---|
+| `client.kb` | `/sdk/v1/query`, `/ingest`, `/search`, `/collections`, `/taxonomy` | Search + ingest the personal knowledge base |
+| `client.verify` | `/sdk/v1/hallucination` | Streaming claim extraction + NLI-gated verification |
+| `client.memory` | `/sdk/v1/memory/extract` | Semantic memory recall + extraction |
+| `client.system` | `/sdk/v1/health`, `/health/detailed`, `/settings`, `/plugins` | Operational endpoints |
+
+## Authentication
+
+Cerid is local-first by default — `CeridClient(base_url=...)` connects
+to a self-hosted instance with no credentials. For deployments behind
+an authenticating proxy, pass headers via the underlying transport:
+
+```python
+client = CeridClient(
+    base_url="https://cerid.your-org.internal",
+    headers={"Authorization": "Bearer <token>"},
+)
+```
+
+## Compatibility
+
+- Python 3.9+ (3.11 / 3.12 actively tested)
+- httpx 0.25+ (transport)
+- pydantic 2.0+ (response models)
+
+## Stability contract
+
+The `/sdk/v1/` surface and this client's public types
+(`CeridClient`, `AsyncCeridClient`, `CeridSDKError`, response models)
+follow [semantic versioning](https://semver.org/). Any breaking
+change to a `/sdk/v1/` endpoint is enforced caught by the
+`sdk-openapi-drift` CI gate in the server repo.
+
+`SDK_PROTOCOL_VERSION` in `cerid.__version__` mirrors the server's
+expected wire-protocol version. Mismatched server / client versions
+will surface as a `CeridSDKError` rather than silent payload skew.
+
+## License
+
+Apache-2.0. Source at the [Cerid AI repository](https://github.com/Cerid-AI/cerid-ai).

cerid_sdk-0.1.1/README.md

@@ -0,0 +1,93 @@
+# cerid-sdk
+
+Python client for the [Cerid AI Knowledge Companion](https://github.com/Cerid-AI/cerid-ai) HTTP API.
+
+```bash
+pip install cerid-sdk
+```
+
+Sync and async clients with typed responses. Resource groups for the
+knowledge base, hallucination verification, semantic memory, and
+system endpoints. Built against the stable `/sdk/v1/` surface; protocol
+drift is enforced server-side by the `sdk-openapi-drift` CI gate.
+
+## Quickstart
+
+```python
+from cerid import CeridClient
+
+client = CeridClient(base_url="http://localhost:8888")
+
+# Search the knowledge base
+results = client.kb.query("what did I read about graph databases last week?")
+for chunk in results.chunks:
+    print(chunk.text, chunk.score)
+
+# Verify a generated answer against the KB
+report = client.verify.check(
+    response_text="Cerid uses Neo4j for graph storage.",
+    conversation_id="demo",
+)
+print(report.faithfulness, report.unsupported_claims)
+
+# Recall semantic memory
+memories = client.memory.recall("preferred deployment topology", top_k=5)
+```
+
+## Async client
+
+```python
+import asyncio
+from cerid import AsyncCeridClient
+
+async def main():
+    async with AsyncCeridClient(base_url="http://localhost:8888") as client:
+        results = await client.kb.query("graph databases")
+        print(results.total)
+
+asyncio.run(main())
+```
+
+## Resource groups
+
+| Group | Endpoint | Purpose |
+|---|---|---|
+| `client.kb` | `/sdk/v1/query`, `/ingest`, `/search`, `/collections`, `/taxonomy` | Search + ingest the personal knowledge base |
+| `client.verify` | `/sdk/v1/hallucination` | Streaming claim extraction + NLI-gated verification |
+| `client.memory` | `/sdk/v1/memory/extract` | Semantic memory recall + extraction |
+| `client.system` | `/sdk/v1/health`, `/health/detailed`, `/settings`, `/plugins` | Operational endpoints |
+
+## Authentication
+
+Cerid is local-first by default — `CeridClient(base_url=...)` connects
+to a self-hosted instance with no credentials. For deployments behind
+an authenticating proxy, pass headers via the underlying transport:
+
+```python
+client = CeridClient(
+    base_url="https://cerid.your-org.internal",
+    headers={"Authorization": "Bearer <token>"},
+)
+```
+
+## Compatibility
+
+- Python 3.9+ (3.11 / 3.12 actively tested)
+- httpx 0.25+ (transport)
+- pydantic 2.0+ (response models)
+
+## Stability contract
+
+The `/sdk/v1/` surface and this client's public types
+(`CeridClient`, `AsyncCeridClient`, `CeridSDKError`, response models)
+follow [semantic versioning](https://semver.org/). Any breaking
+change to a `/sdk/v1/` endpoint is enforced caught by the
+`sdk-openapi-drift` CI gate in the server repo.
+
+`SDK_PROTOCOL_VERSION` in `cerid.__version__` mirrors the server's
+expected wire-protocol version. Mismatched server / client versions
+will surface as a `CeridSDKError` rather than silent payload skew.
+
+## License
+
+Apache-2.0. Source at the [Cerid AI repository](https://github.com/Cerid-AI/cerid-ai).

cerid_sdk-0.1.1/examples/telegram-capture/README.md

@@ -0,0 +1,67 @@
+# Telegram Capture Bot — External Ingest Example
+
+A minimal Telegram bot that forwards every received message to Cerid via
+`POST /sdk/v1/ingest/external`.  This is a self-contained example that
+demonstrates the generic external ingest endpoint — it is **not** a Cerid
+feature and is **not** published to PyPI.
+
+---
+
+## Prerequisites
+
+- Python 3.11+
+- A running Cerid stack at `http://localhost:8888` (or override via `CERID_URL`)
+- A Telegram bot token from [@BotFather](https://t.me/BotFather)
+
+---
+
+## Setup
+
+```bash
+# 1. Create a dedicated venv (do NOT install into Cerid's .venv)
+cd packages/sdk/python/examples/telegram-capture
+python3 -m venv .venv
+.venv/bin/pip install -r requirements.txt
+
+# 2. Export environment variables
+export TELEGRAM_BOT_TOKEN="<your-bot-token>"
+export CERID_URL="http://localhost:8888"        # default
+export CERID_CLIENT_ID="telegram-capture-bot"  # optional
+
+# 3. Run
+.venv/bin/python bot.py
+```
+
+---
+
+## How it works
+
+Each Telegram message is translated into a Cerid `ExternalIngestRequest`
+using this `field_mappings` config:
+
+```json
+{
+  "content": "text",
+  "source_uri": "source_uri",
+  "ts": "ts_iso",
+  "id": "message_id"
+}
+```
+
+The bot injects two synthetic fields (`source_uri`, `ts_iso`) into the
+payload before sending so they resolve cleanly through the dotted-path
+mapper.  The resulting `NormalizedItem` is ingested into Cerid's `general`
+domain with `source_type="telegram-bot"` stored as provenance metadata.
+
+**The endpoint is generic.** No code in `bot.py` or in Cerid special-cases
+the `"telegram-bot"` source type — the `field_mappings` config is the only
+service-specific knowledge needed.
+
+---
+
+## Adapting for other services
+
+Replace the `FIELD_MAPPINGS` dict and `_make_payload` function to match
+the JSON shape your service produces, then post to the same endpoint.
+See `docs/INTEGRATION_GUIDE.md` in the Cerid repo for worked examples
+(Readwise, Pocket, Instapaper, Raindrop).