trisynapse-memory 0.1.0__tar.gz

trisynapse_memory-0.1.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 trisynapse-memory contributors
+
+   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.

trisynapse_memory-0.1.0/PKG-INFO

@@ -0,0 +1,456 @@
+Metadata-Version: 2.4
+Name: trisynapse-memory
+Version: 0.1.0
+Summary: Append-only, citation-first memory for AI agents using Trace & Recall.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/shanmukh05/trisynapse-memory
+Project-URL: Repository, https://github.com/shanmukh05/trisynapse-memory
+Project-URL: Documentation, https://github.com/shanmukh05/trisynapse-memory/tree/main/docs
+Project-URL: Issues, https://github.com/shanmukh05/trisynapse-memory/issues
+Keywords: ai,agents,memory,rag
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-genai>=1.0
+Requires-Dist: lancedb>=0.20
+Requires-Dist: numpy>=1.26
+Requires-Dist: pydantic>=2.6
+Requires-Dist: sentence-transformers>=3.0
+Requires-Dist: typer>=0.16
+Requires-Dist: rich>=13.9
+Requires-Dist: textual>=2.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: ruff<0.15,>=0.9; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Provides-Extra: server
+Requires-Dist: fastapi>=0.115; extra == "server"
+Requires-Dist: uvicorn>=0.34; extra == "server"
+Provides-Extra: files
+Requires-Dist: pypdf>=5.0; extra == "files"
+Provides-Extra: sources
+Requires-Dist: pypdf>=5.0; extra == "sources"
+Requires-Dist: python-docx>=1.1; extra == "sources"
+Requires-Dist: python-pptx>=1.0; extra == "sources"
+Requires-Dist: openpyxl>=3.1; extra == "sources"
+Requires-Dist: PyYAML>=6.0; extra == "sources"
+Requires-Dist: tree-sitter-language-pack>=0.9; extra == "sources"
+Provides-Extra: all
+Requires-Dist: fastapi>=0.115; extra == "all"
+Requires-Dist: uvicorn>=0.34; extra == "all"
+Requires-Dist: pypdf>=5.0; extra == "all"
+Requires-Dist: python-docx>=1.1; extra == "all"
+Requires-Dist: python-pptx>=1.0; extra == "all"
+Requires-Dist: openpyxl>=3.1; extra == "all"
+Requires-Dist: PyYAML>=6.0; extra == "all"
+Requires-Dist: tree-sitter-language-pack>=0.9; extra == "all"
+Dynamic: license-file
+
+<div align="center">
+  <a href="https://github.com/shanmukh05/trisynapse-memory">
+    <img
+      src="https://raw.githubusercontent.com/shanmukh05/trisynapse-memory/main/public/assets/logo.png"
+      alt="Trisynapse Memory logo"
+      width="440"
+    />
+  </a>
+
+  <h1>Trisynapse Memory</h1>
+
+  <p><strong>Store traces. Recall meaning.</strong></p>
+
+  <p>
+    <a href="https://github.com/shanmukh05/trisynapse-memory/actions/workflows/test.yml"><img alt="Tests" src="https://img.shields.io/github/actions/workflow/status/shanmukh05/trisynapse-memory/test.yml?branch=main&amp;style=flat-square&amp;label=tests" /></a>
+    <a href="https://pypi.org/project/trisynapse-memory/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/trisynapse-memory?style=flat-square&amp;logo=pypi&amp;logoColor=white&amp;color=3775A9" /></a>
+    <a href="https://pypi.org/project/trisynapse-memory/"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/trisynapse-memory?style=flat-square&amp;logo=python&amp;logoColor=white" /></a>
+    <a href="LICENSE"><img alt="Apache 2.0 license" src="https://img.shields.io/github/license/shanmukh05/trisynapse-memory?style=flat-square" /></a>
+    <img alt="Project status: alpha" src="https://img.shields.io/badge/status-alpha-CB912F?style=flat-square" />
+  </p>
+
+  <p>
+    <a href="#install">Install</a> ·
+    <a href="#start-in-the-terminal">CLI</a> ·
+    <a href="#python-in-five-minutes">Python</a> ·
+    <a href="#rest-api-and-memory-studio">REST &amp; Studio</a> ·
+    <a href="#javascript-and-typescript-sdk">TypeScript</a> ·
+    <a href="docs/architecture.md">Architecture</a> ·
+    <a href="docs/api.md">API</a> ·
+    <a href="docs/operations.md">Operations</a>
+  </p>
+</div>
+
+---
+
+Trisynapse Memory is a local-first memory layer for AI agents. It keeps original evidence in a verifiable **Trace**, builds replaceable **Recall** views for fast retrieval, and answers from the evidence with citations.
+
+> [!IMPORTANT]
+> **Project status: pre-1.0 alpha.** The Python engine, unified source ingestion, REST API, TypeScript client, Memory Studio, full terminal, durable jobs, provider adapters, and benchmark runners are implemented. APIs may still change before the first stable release.
+
+## Install
+
+macOS or Linux:
+
+```bash
+curl -LsSf https://github.com/shanmukh05/trisynapse-memory/releases/latest/download/install.sh | sh
+```
+
+Windows PowerShell:
+
+```powershell
+irm https://github.com/shanmukh05/trisynapse-memory/releases/latest/download/install.ps1 | iex
+```
+
+The installer uses `uv`, installs the PyPI package with all user-facing source loaders, adds the single `trisynapse-memory` command, records install metadata, and runs `check`. Re-run it to upgrade.
+
+Or install from PyPI:
+
+```bash
+pip install 'trisynapse-memory[all]'
+```
+
+Python 3.11+ is required. Uninstall with `uv tool uninstall trisynapse-memory` or the matching `pip uninstall` command.
+
+## Start in the terminal
+
+```bash
+trisynapse-memory init
+trisynapse-memory
+```
+
+With no arguments in a terminal, the interactive app opens. Ask a question as plain text, or use commands such as `/ingest`, `/sources`, `/search`, `/history`, `/forget`, `/remove`, `/jobs`, `/model`, and `/check`.
+
+Start typing `/` to see live command recommendations. The list narrows with every character, while a ghost completion appears in the prompt. Press **Tab** or **Right Arrow** to accept it. Commands that need an argument also recommend matching local paths or recent memory IDs.
+
+Scriptable commands remain available:
+
+```bash
+trisynapse-memory --project-id demo ingest ./docs ./src/service.py https://example.com/guide
+trisynapse-memory --project-id demo sources list
+trisynapse-memory --project-id demo query "How does the service work?"
+trisynapse-memory --json check
+```
+
+Global flags include `--json`, `--quiet`, `--no-color`, `--yes`, `--path`, namespace flags, and `--version`. Put global flags before the command. JSON mode never prints the logo or progress text.
+
+## Python in five minutes
+
+```python
+from trisynapse_memory import MemoryEngine, MemoryNamespace, SourceInput
+
+namespace = MemoryNamespace(user_id="maya", project_id="assistant")
+memory = MemoryEngine.from_env("~/.trisynapse-memory/store", namespace=namespace)
+
+memory.add("Maya prefers short weekly updates.", episode_id="chat:1")
+
+run = memory.ingest_many([
+    SourceInput(kind="file", path="./handbook.pdf"),
+    SourceInput(kind="directory", path="./src", source_key="app-source"),
+    SourceInput(kind="url", url="https://example.com/release-process"),
+])
+
+for item in run.results:
+    print(item.index, item.status, item.source_id, item.error)
+
+answer = memory.query("How should I write the weekly update?")
+print(answer.answer)
+for citation in answer.citations:
+    print(citation.delta_id, citation.locator)
+```
+
+Mixed imports are independent: a bad item is reported as failed while valid items commit. Repeating the same `source_key + content_hash` is a no-op. Updating a source creates a new version and retracts the previous version only after the new one succeeds.
+
+`add_batch()` still means “append already-normalized text observations.” Use `ingest_many()` for mixed files, URLs, repositories, archives, and images.
+
+## Sources
+
+The source pipeline accepts:
+
+- text, Markdown, HTML, PDF, JSON, JSONL, YAML, and CSV;
+- DOCX, PPTX, and XLSX with paragraph, slide, sheet, row, and cell-aware locations;
+- PNG, JPEG, and WebP through the configured vision-capable completion model;
+- code files, directories, safe ZIP/TAR archives, notebooks, and public HTTPS Git repositories;
+- one public web page per URL.
+
+Code is split around symbols with Tree-sitter when supported, with bounded line chunks as the fallback. Citations retain paths, languages, symbol names/types, line ranges, imports, hashes, and Git commit metadata. Repository imports honor `.gitignore` and `.trisynapseignore`; dependencies, builds, caches, secret files, binaries, and symlinks are skipped and reported.
+
+Accepted originals are deduplicated by SHA-256 under the memory store and included in backups. Store permissions are restricted, but **the source store is not encrypted**.
+
+Image ingestion does not silently switch to OCR. It fails clearly if no completion provider is configured or the selected model rejects images.
+
+## Forget versus remove
+
+```python
+memory.forget(delta_id=item.id, reason="no longer relevant")
+memory.remove(delta_ids=[item.id], reason="approved privacy deletion")
+memory.remove_source(source_id, reason="delete upload and derived memory")
+```
+
+- `forget()` appends a logical retraction. The old content remains available to authorized audit/history operations.
+- `remove()` physically redacts only the selected deltas, writes `[REMOVED]`, rebuilds the verifiable chain, clears derived caches, and records a `removal_audit` row.
+- `remove_source()` removes the retained original when it is no longer shared and redacts every delta derived from that source.
+
+There is intentionally no public `purge` alias. Historical `[PURGED]` rows from older stores remain unchanged and continue to verify.
+
+## One engine, four surfaces
+
+| Surface | Start | Best for |
+|---|---|---|
+| Python | `MemoryEngine.from_env(...)` | In-process applications |
+| Terminal/CLI | `trisynapse-memory` | Interactive use, scripts, and operations |
+| REST + Studio | `trisynapse-memory serve --studio` | Shared local service and inspection |
+| JavaScript/TypeScript | `@trisynapse/memory` | Node.js and web application backends |
+
+All surfaces call the same Trace & Recall engine. A source ingested through REST is visible from Python, the terminal, Studio, and TypeScript when they use the same store and namespace.
+
+## REST API and Memory Studio
+
+Install the server extra, initialize the store, and start the service:
+
+```bash
+pip install 'trisynapse-memory[server,sources]'
+trisynapse-memory init
+trisynapse-memory serve --studio
+```
+
+The default service address is `http://127.0.0.1:8765`. The root opens Memory Studio at [`/studio/`](http://127.0.0.1:8765/studio/), while OpenAPI is available at [`/openapi.json`](http://127.0.0.1:8765/openapi.json). The service binds to loopback unless `--host` is changed.
+
+Studio has five focused areas:
+
+- **Sources** is a searchable card inbox with mixed batch ingestion, safe previews, retained-original downloads, versions, and derived memory.
+- **Queries** streams each retrieval stage into a clickable workflow and keeps the same workflow in namespace-scoped history.
+- **Memory Viewer** switches between knowledge, source-lineage, and chronological Trace graphs.
+- **Configuration** manages completion, embeddings, and revisioned retrieval defaults.
+- **Connection** selects the server, bearer token, and active namespace without storing the token in memory SQLite.
+
+`init` creates the administrator bearer token at `<store>/.api-key`. Health is public; memory operations require the token when authentication is enabled:
+
+```bash
+export TRISYNAPSE_MEMORY_API_KEY="$(cat ~/.trisynapse-memory/store/.api-key)"
+
+curl http://127.0.0.1:8765/api/v1/health
+
+curl -X POST http://127.0.0.1:8765/api/v1/memory/observations \
+  -H "Authorization: Bearer $TRISYNAPSE_MEMORY_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "text": "Maya prefers three-bullet updates.",
+    "episode_id": "chat:updates",
+    "namespace": {"user_id": "maya", "project_id": "demo"}
+  }'
+
+curl -X POST http://127.0.0.1:8765/api/v1/query \
+  -H "Authorization: Bearer $TRISYNAPSE_MEMORY_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "question": "How should Maya receive updates?",
+    "namespace": {"user_id": "maya", "project_id": "demo"}
+  }'
+```
+
+### Ingest sources through REST
+
+Bulk source ingestion is asynchronous. The first response is `202 Accepted` with a durable run ID:
+
+```bash
+curl -X POST http://127.0.0.1:8765/api/v1/sources/ingest \
+  -H "Authorization: Bearer $TRISYNAPSE_MEMORY_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "namespace": {"user_id": "maya", "project_id": "demo"},
+    "sources": [
+      {"kind": "url", "url": "https://example.com/handbook"},
+      {"kind": "text", "source_key": "release-rule", "text": "Name an owner in every release note."}
+    ]
+  }'
+```
+
+Follow and manage the run using its returned ID:
+
+```bash
+curl -H "Authorization: Bearer $TRISYNAPSE_MEMORY_API_KEY" \
+  http://127.0.0.1:8765/api/v1/ingestion-runs/RUN_ID
+
+curl -X POST -H "Authorization: Bearer $TRISYNAPSE_MEMORY_API_KEY" \
+  http://127.0.0.1:8765/api/v1/ingestion-runs/RUN_ID/retry
+```
+
+Important REST routes:
+
+| Area | Routes |
+|---|---|
+| Add and retrieve | `POST /memory/observations`, `POST /search`, `POST /query`, `GET /memories` |
+| Query workflows | `POST/GET /query-runs`, `GET /query-runs/{id}/events`, confirmed history removal |
+| Sources | `POST /sources/ingest`, filtered `GET /sources`, preview/content routes |
+| Runs | `GET /ingestion-runs`, `GET /ingestion-runs/{id}`, retry |
+| Memory graph | `GET /memory-graph`, node-neighborhood expansion |
+| Lifecycle | corrections, `forget`, `POST /memory/remove`, `POST /sources/{id}/remove` |
+| Models and retrieval | provider catalogs, `GET/PUT /model-configuration`, `GET/PUT /retrieval-configuration` |
+| Operations | health, metrics, jobs, export, backups, benchmarks, and integration events |
+
+All routes above are under `/api/v1`. Uploaded bytes are sent as `content_base64`. REST deliberately rejects arbitrary server filesystem paths. Defaults include 25 MiB per uploaded file, 250 MiB per run, 100 descriptors, safe archive limits, URL timeouts, redirect limits, and private-network blocking.
+
+Use `trisynapse-memory serve --no-auth` only for trusted local development. See [API and Interfaces](docs/api.md) for complete request contracts and [Operations](docs/operations.md) for deployment guidance.
+
+## JavaScript and TypeScript SDK
+
+The dependency-free Fetch client lives in [`packages/js-sdk`](packages/js-sdk) and its package name is `@trisynapse/memory`. It requires Node.js 18+ or another runtime with a compatible Fetch API.
+
+```bash
+npm install @trisynapse/memory
+# or: pnpm add @trisynapse/memory
+```
+
+```ts
+import { TrisynapseMemory } from "@trisynapse/memory";
+
+const memory = new TrisynapseMemory({
+  baseUrl: "http://127.0.0.1:8765",
+  apiKey: process.env.TRISYNAPSE_MEMORY_API_KEY,
+  namespace: { project_id: "demo", user_id: "maya" },
+});
+
+await memory.add("Maya prefers short weekly updates.", {
+  episodeId: "chat:updates",
+});
+
+const run = await memory.ingest([
+  { kind: "url", url: "https://example.com/guide" },
+  {
+    kind: "file",
+    filename: "release-notes.md",
+    content_base64: markdownBase64,
+    source_key: "release-notes",
+  },
+]);
+
+let current = run;
+while (current.status === "pending" || current.status === "running") {
+  await new Promise(resolve => setTimeout(resolve, 500));
+  current = await memory.getIngestionRun(run.id);
+}
+
+const answer = await memory.query("What does the guide require?");
+console.log(answer.answer);
+for (const citation of answer.citations) {
+  console.log(citation.delta_id, citation.locator);
+}
+```
+
+The client covers:
+
+- `add()`, `addBatch()`, and the compatibility `addFile()`;
+- `ingest()`, `listSources()`, `getSource()`, and `removeSource()`;
+- `getIngestionRun()` and `retryIngestion()`;
+- `search()`, `query()`, `list()`, `get()`, and `history()`;
+- `correct()`, `forget()`, and physical `remove()`;
+- profiles, feedback, health, typed deltas, citations, retrieval traces, sources, and run results.
+- provider/model discovery, configuration, explicit connection tests, and embedding-rebuild status.
+
+Lifecycle example:
+
+```ts
+await memory.correct(memoryId, "Maya prefers at most three bullets.");
+await memory.forget(memoryId, "Preference expired");
+await memory.remove([sensitiveMemoryId], "Approved privacy deletion");
+await memory.removeSource(sourceId, "Delete the upload and derived memory");
+```
+
+The SDK contains no alternate memory algorithm; it is a typed client for the canonical Python REST service.
+
+## The memory idea
+
+```mermaid
+flowchart TD
+    S["Sources and conversations"] --> P["Safe preprocessing + privacy filter"]
+    P --> T["Trace: original, ordered evidence"]
+    T --> R["Recall: replaceable indexes and summaries"]
+    Q["Question"] --> R
+    R --> D["Drill back to Trace"]
+    D --> A["Answer or abstain with citations"]
+```
+
+Each Trace delta stores the hash of the previous delta plus its own content. Hashing does not hide the data. It answers a different question: “Was old evidence edited, deleted, reordered, or inserted outside the supported lifecycle?” Recall products can be rebuilt, so they never become the final evidence for an answer.
+
+Read [Architecture](docs/architecture.md) first, then [API and Interfaces](docs/api.md), [Operations](docs/operations.md), and the [Production release runbook](docs/release-and-production.md).
+
+Release versions are synchronized from `pyproject.toml` with one command:
+
+```bash
+uv run python scripts/version.py set 0.2.0
+uv run python scripts/version.py check --tag v0.2.0
+```
+
+## Models, providers, and benchmarks
+
+Model choices are saved per memory store. API keys stay in environment variables and are never written to SQLite. Running `/model` opens the searchable terminal selector:
+
+```bash
+export ANTHROPIC_API_KEY="your-key"
+trisynapse-memory
+# Enter /model completion
+```
+
+Scriptable equivalents are available:
+
+```bash
+trisynapse-memory models providers
+trisynapse-memory models list --role completion --provider anthropic
+trisynapse-memory models set completion anthropic claude-sonnet-4-5
+trisynapse-memory models test --role completion
+```
+
+Completion providers are OpenAI, OpenRouter, Gemini, Anthropic, DeepInfra, DeepSeek, Kimi, and custom OpenAI-compatible endpoints. Embeddings can use local SentenceTransformers, OpenAI, OpenRouter, Gemini, DeepInfra, or a custom OpenAI-compatible endpoint. Qwen models appear under OpenRouter or DeepInfra when those catalogs provide them.
+
+| Provider | Completion | Embedding | Credential variable |
+|---|:---:|:---:|---|
+| OpenAI | ✓ | ✓ | `OPENAI_API_KEY` |
+| OpenRouter | ✓ | ✓ | `OPENROUTER_API_KEY` |
+| Gemini | ✓ | ✓ | `GEMINI_API_KEY` |
+| Anthropic | ✓ | — | `ANTHROPIC_API_KEY` |
+| DeepInfra | ✓ | ✓ | `DEEPINFRA_API_TOKEN` |
+| DeepSeek | ✓ | — | `DEEPSEEK_API_KEY` |
+| Kimi | ✓ | — | `MOONSHOT_API_KEY` |
+| OpenAI-compatible | ✓ | ✓ | `OPENAI_COMPATIBLE_API_KEY` when required |
+| SentenceTransformers | — | ✓ | none |
+
+Changing completion affects future generation only. Changing embeddings requires confirmation and rebuilds a new vector index before switching away from the working index. See [Operations](docs/operations.md#completion-and-embedding-providers) for credentials and [API and Interfaces](docs/api.md#model-configuration) for every configuration surface.
+
+The same change from Python:
+
+```python
+from trisynapse_memory import ProviderSelection
+
+configuration = memory.get_model_configuration()
+configuration.completion = ProviderSelection(
+    provider="deepseek", model="deepseek-chat"
+)
+memory.set_model_configuration(configuration)
+```
+
+Benchmark modes stay explicit:
+
+- `retrieval` measures offline ingestion, retrieval, grounding, and extractive answers;
+- `end-to-end` adds provider-backed extraction, Recall generation, answering, and judging.
+
+Artifacts record provider/model and prompt version/hash provenance without credentials or provider URLs.
+
+```bash
+trisynapse-memory bench run locomo --mode retrieval --data-root data/locomo --max-questions 100
+trisynapse-memory bench gate --mode retrieval
+```
+
+## Development
+
+```bash
+pip install -e '.[dev,all]'
+pytest -q
+ruff check src tests scripts
+pnpm install --frozen-lockfile
+pnpm --filter @trisynapse/memory check
+```
+
+Trace & Recall is the only engine implementation. License: Apache-2.0.