{"version":1,"pages":[{"id":"a3rDLe8K0XHyBcm858j3","title":"Overview","pathname":"/","siteSpaceId":"sitesp_vIYrg","icon":"compass","description":"The on-device, offline-first vector-memory engine — a thin Python SDK over a signed native runtime. Install, sign in, and build your first collection here."},{"id":"hEmd6w4utW6sp4Em58IF","title":"What is Telys","pathname":"/start-here/what-is-telys","siteSpaceId":"sitesp_vIYrg","icon":"circle-info","description":"How Telys gives apps and agents durable, private semantic memory on-device — a thin public SDK over a closed, signed native runtime, with nothing leaving the machine.","breadcrumbs":[{"label":"Start here"}]},{"id":"P1GCNzSPvejoC1Cftn9l","title":"Install","pathname":"/start-here/install","siteSpaceId":"sitesp_vIYrg","icon":"download","description":"Install the Telys SDK with pipx or pip on Python 3.10+, then provision the signed native runtime for your platform with a single telys login.","breadcrumbs":[{"label":"Start here"}]},{"id":"jbtYRrlfm2suAHJekJo2","title":"Sign in","pathname":"/start-here/sign-in","siteSpaceId":"sitesp_vIYrg","icon":"right-to-bracket","description":"Run telys login to complete the device-code browser flow (or pass a token for CI), activate a license, and provision the signed runtime for your platform.","breadcrumbs":[{"label":"Start here"}]},{"id":"h4z9ZPSmvEnW3qsGotXt","title":"Verify install","pathname":"/start-here/verify-install","siteSpaceId":"sitesp_vIYrg","icon":"circle-check","description":"Confirm a healthy Telys install offline — check the SDK version, runtime readiness, and the release-signature and license verification that gate every native call.","breadcrumbs":[{"label":"Start here"}]},{"id":"3P7KO0CUnD1NfTy6KAyk","title":"First collection","pathname":"/quickstarts/quickstart-first-collection","siteSpaceId":"sitesp_vIYrg","icon":"bolt","description":"Install Telys, sign in, then create a collection, add text, search it, and persist it to disk — end to end in a few minutes.","breadcrumbs":[{"label":"Quickstarts"}]},{"id":"tZvLrbDjBo9peIumbpSE","title":"Semantic search","pathname":"/quickstarts/quickstart-semantic-search","siteSpaceId":"sitesp_vIYrg","icon":"magnifying-glass","description":"Build a small searchable text index with the on-device lexical embedder, run text queries, filter results with Eq, and read the scores.","breadcrumbs":[{"label":"Quickstarts"}]},{"id":"PAT4pDE2TcuVbgRbANvN","title":"Agent memory","pathname":"/quickstarts/quickstart-agent-memory","siteSpaceId":"sitesp_vIYrg","icon":"robot","description":"Give an AI agent durable, on-device memory — partition per user and session with scope_key, store conversation turns, and recall them on demand.","breadcrumbs":[{"label":"Quickstarts"}]},{"id":"4dMaM8DFGDPl772eoH6B","title":"How it works","pathname":"/understand-telys/how-telys-works","siteSpaceId":"sitesp_vIYrg","icon":"diagram-project","description":"The architecture of Telys — a thin public Python SDK that orchestrates a signed, closed native runtime, entirely on your machine.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"ZBd4ROKi3CD4dcp51PD4","title":"Collections","pathname":"/understand-telys/collections","siteSpaceId":"sitesp_vIYrg","icon":"layer-group","description":"What a Telys collection is — a named, partitioned vector store bound to a single embedding space — and its create → use → save → reopen lifecycle.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"25a92W1qdHq0jNswnnSy","title":"Records & IDs","pathname":"/understand-telys/records-ids-payloads","siteSpaceId":"sitesp_vIYrg","icon":"id-card","description":"Anatomy of a Telys record — your external id, a vector, an optional metadata payload, and a partition key — plus add vs upsert vs update semantics.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"Rv5cBr1GHyWvxVC7AeIF","title":"Partitions & scopes","pathname":"/understand-telys/partitions-scope-key","siteSpaceId":"sitesp_vIYrg","icon":"table-cells","description":"How Telys partitions a collection by a single key column, why partition_by is never composite, and how scope_key composes one string key from several parts.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"RzDIZEyqpor8emxw5SUJ","title":"Embeddings & spaces","pathname":"/understand-telys/embeddings-and-spaces","siteSpaceId":"sitesp_vIYrg","icon":"microchip","description":"How an embedder maps text to vectors in a space identified by EmbeddingProfile.space_id(), and how a collection is bound to exactly one space.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"xfD01rBgEwUqnMciY7oH","title":"Lexical vs dense","pathname":"/understand-telys/lexical-vs-dense","siteSpaceId":"sitesp_vIYrg","icon":"scale-balanced","description":"When to use Telys's built-in on-device lexical embedders versus bring-your-own dense embeddings, and the privacy, latency, and recall tradeoffs of each.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"34ekyTEaG3dG24136d0C","title":"Search internals","pathname":"/understand-telys/search-internals-ivf","siteSpaceId":"sitesp_vIYrg","icon":"gauge","description":"How Telys searches — exact brute force for small collections, an inverted-file (IVF) index for scale, and the target_recall knob that trades recall for latency.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"mCyhYY8XvfpJT4RScC5i","title":"Metadata & filtering","pathname":"/understand-telys/metadata-and-filtering","siteSpaceId":"sitesp_vIYrg","icon":"filter","description":"Attach metadata to records, declare filter_columns, and narrow results with Eq — the single equality filter Telys supports across search and ids.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"6OLpYuGrmMrjReVdWDhE","title":"Versioning & compaction","pathname":"/understand-telys/versioning-soft-delete-compaction","siteSpaceId":"sitesp_vIYrg","icon":"clock-rotate-left","description":"How Telys layers versioned updates and deletes over a sealed base image, why deletes are logical until you compact, and what save() commits.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"tVrk8vG4vvlGOMGKSaut","title":"Tuning & tradeoffs","pathname":"/understand-telys/tuning-tradeoffs","siteSpaceId":"sitesp_vIYrg","icon":"sliders","description":"The recall / latency / memory tradeoff behind Telys search, how exact-crossover and IVF knobs move it, and how a Tuner turns a workload into an applied TuningPlan.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"VmHkD0an28Ww8yTFnwpS","title":"Signed runtime & trust","pathname":"/understand-telys/signed-runtime-trust","siteSpaceId":"sitesp_vIYrg","icon":"shield-halved","description":"How Telys verifies a signed release manifest, hashes every runtime artifact, and checks an offline license before activating the native engine — fail-closed, native-only.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"8qFzJkRN9mhP0vZqJwZv","title":"On-device & offline","pathname":"/understand-telys/on-device-offline","siteSpaceId":"sitesp_vIYrg","icon":"laptop","description":"Why every Telys collection, embedding, and search runs on your machine, the short list of things that ever use the network, and how it works fully offline after first login.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"pDAqCOdYa0pJZlwE3c5A","title":"Local vs remote","pathname":"/understand-telys/local-vs-remote","siteSpaceId":"sitesp_vIYrg","icon":"network-wired","description":"When to run Telys in-process versus behind a shared server — and how RemoteCollection differs as a strict subset of the local Collection API.","breadcrumbs":[{"label":"Understand Telys"}]},{"id":"EIWgp0wPwoYMjxP37Daw","title":"Create a collection","pathname":"/working-with-data/create-a-collection","siteSpaceId":"sitesp_vIYrg","icon":"plus","description":"Create a Telys collection with a fixed dimension, a partition key, and an optional embedder, then commit it to disk with save().","breadcrumbs":[{"label":"Working with data"}]},{"id":"673hmQEbZWacJ4KiSdnW","title":"Add & upsert","pathname":"/working-with-data/add-and-upsert","siteSpaceId":"sitesp_vIYrg","icon":"circle-plus","description":"Insert records into a Telys collection with add / add_texts for new rows, or upsert / upsert_texts to insert-or-replace, then persist with save().","breadcrumbs":[{"label":"Working with data"}]},{"id":"9Xcdtx1OrsC118fTHJL0","title":"Text vs vectors","pathname":"/working-with-data/add-text-vs-vectors","siteSpaceId":"sitesp_vIYrg","icon":"font","description":"Decide between the text ingest/search path (needs an embedder) and the raw-vector path (bring your own precomputed float32 vectors) in Telys.","breadcrumbs":[{"label":"Working with data"}]},{"id":"CUaqwewsJTDVeNSsA5QJ","title":"Search by vector","pathname":"/working-with-data/search-by-vector","siteSpaceId":"sitesp_vIYrg","icon":"magnifying-glass","description":"Query a Telys collection with a precomputed query vector using search(), and read back ids, scores, optional metadata, and an explain trace.","breadcrumbs":[{"label":"Working with data"}]},{"id":"ljGcBbwv7A5FMTi0vZWR","title":"Search by text","pathname":"/working-with-data/search-by-text","siteSpaceId":"sitesp_vIYrg","icon":"magnifying-glass","description":"Query a Telys collection with a plain string using search_text(), which embeds your query with the collection's embedder and returns the nearest records.","breadcrumbs":[{"label":"Working with data"}]},{"id":"f1kH8mnLEAKBG7sEkDOZ","title":"Filter results","pathname":"/working-with-data/filter-results","siteSpaceId":"sitesp_vIYrg","icon":"filter","description":"Constrain Telys searches and id listings to a partition or filter column using Eq or a single-key dict — the only filter Telys supports.","breadcrumbs":[{"label":"Working with data"}]},{"id":"4W3Y4FFEy7tpVma7Bhvc","title":"List & fetch by ID","pathname":"/working-with-data/list-and-fetch-by-id","siteSpaceId":"sitesp_vIYrg","icon":"list","description":"List the live external IDs in a Telys collection, count rows, test membership, and page through one partition with a scoped search.","breadcrumbs":[{"label":"Working with data"}]},{"id":"IEihttmP8r8zxpFDyjgd","title":"Update records","pathname":"/working-with-data/update-records","siteSpaceId":"sitesp_vIYrg","icon":"pen","description":"Replace the contents of existing records with update_texts, and understand how it differs from add_texts and upsert_texts.","breadcrumbs":[{"label":"Working with data"}]},{"id":"RllSb4oFIVsEKxs8s4a3","title":"Delete & compact","pathname":"/working-with-data/delete-and-compact","siteSpaceId":"sitesp_vIYrg","icon":"trash","description":"Remove records with delete, reclaim their space with compact, and commit the result to disk with save.","breadcrumbs":[{"label":"Working with data"}]},{"id":"3IabEB7rmGWO2uCD2t8X","title":"Save & snapshots","pathname":"/working-with-data/snapshots-and-persistence","siteSpaceId":"sitesp_vIYrg","icon":"floppy-disk","description":"Persist a collection to disk with save, take a point-in-time copy with snapshot, and reopen it with open_collection.","breadcrumbs":[{"label":"Working with data"}]},{"id":"jIfXSkoz6iGxOICLxuFM","title":"Export a compact artifact","pathname":"/working-with-data/export-compact-artifact","siteSpaceId":"sitesp_vIYrg","icon":"box-archive","description":"Export a collection as an ultra-small read-only serve artifact (quantized slab + provenance) and open it on any device.","breadcrumbs":[{"label":"Working with data"}]},{"id":"vAtnT9NtTA0el7skR3vX","title":"Build IVF index","pathname":"/working-with-data/build-ivf-index","siteSpaceId":"sitesp_vIYrg","icon":"database","description":"Switch a large collection from exact to approximate IVF search with build_ivf, and confirm the change in the stats output.","breadcrumbs":[{"label":"Working with data"}]},{"id":"FPGAk4DeKXbjMI0gv0ue","title":"Build a lexical index","pathname":"/working-with-data/build-lexical-index","siteSpaceId":"sitesp_vIYrg","icon":"list-tree","description":"Add an on-device BM25 code index to a collection with lexical=True + build_lexical, then query it with search_text(mode=\"lexical\") — keyword/code search, no model, scoped by partition.","breadcrumbs":[{"label":"Working with data"}]},{"id":"WGHEJNj5Rltcfakhls3R","title":"Inspect stats","pathname":"/working-with-data/inspect-stats","siteSpaceId":"sitesp_vIYrg","icon":"chart-simple","description":"Read row counts, index state, and partitions from a collection's stats, alongside its name, key column, and external IDs.","breadcrumbs":[{"label":"Working with data"}]},{"id":"XuNwRcXB5hZbgTGaTAau","title":"Choosing an embedder","pathname":"/embeddings/choosing-an-embedder","siteSpaceId":"sitesp_vIYrg","icon":"scale-balanced","description":"Compare the on-device lexical embedders against the bring-your-own dense path and pick the right vector space for your collection.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"E19JU21tIIqARTaX8Wp4","title":"Bigram embedder","pathname":"/embeddings/bigram","siteSpaceId":"sitesp_vIYrg","icon":"cube","description":"Reference for AlgentaBigramEmbedder — the compact on-device lexical bigram-hash embedder in telys.embedding.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"SAD2qFASkTgunHaLDjQ6","title":"Multigram embedder","pathname":"/embeddings/multigram","siteSpaceId":"sitesp_vIYrg","icon":"cubes","description":"Reference for AlgentaMultigramEmbedder — the richer on-device lexical embedder and the default used by the Telys MCP server.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"xHAlwgdmOLQ516dGXyqf","title":"Pooled embedder","pathname":"/embeddings/pooled","siteSpaceId":"sitesp_vIYrg","icon":"layer-group","description":"Reference for AlgentaPooledEmbedder — a runtime-only embedder that resolves lazily from the closed native runtime and is absent in a runtime-free install.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"Xzd0BXJbxW07haNz0M1J","title":"Bring your own","pathname":"/embeddings/callable-byo","siteSpaceId":"sitesp_vIYrg","icon":"plug","description":"Reference for CallableEmbedder — wrap any embedding function (OpenAI, BGE, a local model) into a Telys embedder with a matching EmbeddingProfile.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"xwahgwdIzO1r8VFfN9l8","title":"Embedding profiles","pathname":"/embeddings/embedding-profile","siteSpaceId":"sitesp_vIYrg","icon":"fingerprint","description":"Reference for EmbeddingProfile — the frozen record that names a vector space and, via space_id(), gates which embedder can reopen or attach to a collection.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"osxpAbHUV1iJmzTnmdX3","title":"OpenAI recipe","pathname":"/embeddings/recipe-openai","siteSpaceId":"sitesp_vIYrg","icon":"cloud","description":"Integration recipe — wrap OpenAI text-embedding-3-small in a CallableEmbedder with a matching EmbeddingProfile, then create a collection, add text, and search.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"ygPCwb0JT95fwoRUVC1g","title":"BGE recipe","pathname":"/embeddings/recipe-bge","siteSpaceId":"sitesp_vIYrg","icon":"microchip","description":"Integration recipe — wrap a local BGE / sentence-transformers model in a CallableEmbedder for fully offline dense search, with no API keys and no network.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"MIVK3hfr15xmitNeowAz","title":"Dimensions & spaces","pathname":"/embeddings/dimensions-and-space-id","siteSpaceId":"sitesp_vIYrg","icon":"ruler","description":"How a collection's dimension and space_id lock it to one embedder — why changing model or dimension needs a new collection, and how to migrate by re-embedding.","breadcrumbs":[{"label":"Embeddings"}]},{"id":"dUb8SpYWDKmPq4apsKnQ","title":"Why tune","pathname":"/tuning/why-tune","siteSpaceId":"sitesp_vIYrg","icon":"circle-question","description":"Why and when to tune a Telys collection — trading recall, latency, and memory as it grows past a few tens of thousands of rows.","breadcrumbs":[{"label":"Tuning"}]},{"id":"NznoaOZPDT34Q6o79zU5","title":"Tuner & plans","pathname":"/tuning/tuner-and-plan","siteSpaceId":"sitesp_vIYrg","icon":"sliders","description":"Reference for the Tuner base class, the bundled HeuristicTuner and AlgentaTuner, and every field and method of the TuningPlan dataclass.","breadcrumbs":[{"label":"Tuning"}]},{"id":"oRgOGxUrNbTlcSvpJeau","title":"Run a pass","pathname":"/tuning/running-a-pass","siteSpaceId":"sitesp_vIYrg","icon":"play","description":"Run col.tune() to produce a TuningPlan, and control whether the pass applies its result with the dry_run flag.","breadcrumbs":[{"label":"Tuning"}]},{"id":"mF6vIx4U7cBS5NHpb70Y","title":"Apply & save","pathname":"/tuning/apply-and-save","siteSpaceId":"sitesp_vIYrg","icon":"floppy-disk","description":"Apply a TuningPlan with col.apply_tuning() to configure recall, crossover, and IVF, then persist the result with col.save().","breadcrumbs":[{"label":"Tuning"}]},{"id":"dVG4mjMMPwA41mVMfhqv","title":"Interpret results","pathname":"/tuning/interpreting-results","siteSpaceId":"sitesp_vIYrg","icon":"chart-line","description":"Read a TuningPlan's expected metrics and decision trace, then verify them against real searches with stats() and explain=True.","breadcrumbs":[{"label":"Tuning"}]},{"id":"E129AHO25QXeUCibzGbf","title":"Overview","pathname":"/cli/overview","siteSpaceId":"sitesp_vIYrg","icon":"terminal","description":"The telys command tree — login, version, runtime, serve, mcp, and mem — with global behavior and links to every subcommand reference.","breadcrumbs":[{"label":"CLI"}]},{"id":"lqyR9vNhJLnEmP9mfOBp","title":"telys login","pathname":"/cli/login","siteSpaceId":"sitesp_vIYrg","icon":"right-to-bracket","description":"Reference for telys login — the device-code sign-in that caches your credentials and installs the signed runtime, with interactive and CI examples.","breadcrumbs":[{"label":"CLI"}]},{"id":"rdScKqn65cFAk2fFscBn","title":"telys version","pathname":"/cli/version","siteSpaceId":"sitesp_vIYrg","icon":"hashtag","description":"Reference for telys version — how it prints the installed SDK version and the on-disk format version, and how to read each part.","breadcrumbs":[{"label":"CLI"}]},{"id":"5Vd47RwOO39CSEHoL96V","title":"telys runtime","pathname":"/cli/runtime","siteSpaceId":"sitesp_vIYrg","icon":"microchip","description":"Reference for telys runtime — check status, install (offline or hosted), and verify the signed native runtime. telys runtime update is a stub.","breadcrumbs":[{"label":"CLI"}]},{"id":"rXztcsfRWotUJ5Y3ETsD","title":"telys serve","pathname":"/cli/serve","siteSpaceId":"sitesp_vIYrg","icon":"server","description":"Reference for telys serve — expose a collection path over a trusted Unix socket or an authenticated TCP endpoint for RemoteTelys clients.","breadcrumbs":[{"label":"CLI"}]},{"id":"ybkX8RDOAgjAOVltcNoS","title":"telys mcp","pathname":"/cli/mcp","siteSpaceId":"sitesp_vIYrg","icon":"plug","description":"Reference for telys mcp — run the stdio MCP server (with optional traffic auditing), or install, uninstall, and inspect its configuration in Claude, Cursor, Codex, Claude Desktop, and Qwen Code.","breadcrumbs":[{"label":"CLI"}]},{"id":"0IG75CcA5vJXgpAltmmu","title":"telys mem","pathname":"/cli/mem","siteSpaceId":"sitesp_vIYrg","icon":"brain","description":"Reference for telys mem — an advanced, scriptable wrapper over a single local collection to create, add, search, list, and inspect it from the shell.","breadcrumbs":[{"label":"CLI"}]},{"id":"pnaayefJXBBFBA2KHufD","title":"Environment & exit codes","pathname":"/cli/environment-and-exit-codes","siteSpaceId":"sitesp_vIYrg","icon":"list-ol","description":"Reference for the environment variables the telys CLI honors and the exit codes every command returns — 0 ok, 1 not-ready, 2 usage or not-implemented.","breadcrumbs":[{"label":"CLI"}]},{"id":"ubMgZcamUs49e9HJGixL","title":"Overview","pathname":"/mcp/overview","siteSpaceId":"sitesp_vIYrg","icon":"plug","description":"Run Telys as a Model Context Protocol server so AI clients like Claude Desktop and Cursor can search and write on-device memory through 19 tools covering the full memory surface.","breadcrumbs":[{"label":"MCP"}]},{"id":"YhKfmMzkSFdHe5MaQYMG","title":"Install the server","pathname":"/mcp/install-server","siteSpaceId":"sitesp_vIYrg","icon":"download","description":"Wire the Telys MCP server into Claude Desktop, Cursor, Codex, Qwen Code, and other clients with one telys mcp install command, or configure it by hand.","breadcrumbs":[{"label":"MCP"}]},{"id":"ouxpwobSuCAZG78N8iU9","title":"Claude Desktop","pathname":"/mcp/client-claude-desktop","siteSpaceId":"sitesp_vIYrg","icon":"message","description":"Add the Telys MCP server to Claude Desktop on macOS or Windows so Claude gains an on-device memory it can search and add to.","breadcrumbs":[{"label":"MCP"}]},{"id":"Xi6UuKyPqX5ZPtarQnMw","title":"Cursor & VS Code","pathname":"/mcp/client-cursor-vscode","siteSpaceId":"sitesp_vIYrg","icon":"laptop-code","description":"Add the Telys MCP server to Cursor or VS Code so the editor's AI agent can search and write on-device memory while you work.","breadcrumbs":[{"label":"MCP"}]},{"id":"um8yppzglq28k2m65DiG","title":"Other clients","pathname":"/mcp/client-other","siteSpaceId":"sitesp_vIYrg","icon":"puzzle-piece","description":"Connect Codex or any MCP client to Telys with a generic stdio server config, and verify the server starts before wiring it into a client.","breadcrumbs":[{"label":"MCP"}]},{"id":"MCot2Px9N71YmDCmVoPk","title":"telys_search","pathname":"/mcp/tool-search","siteSpaceId":"sitesp_vIYrg","icon":"magnifying-glass","description":"Reference for the telys_search MCP tool — semantic and lexical search over a Telys memory collection, with an optional single-key equality filter.","breadcrumbs":[{"label":"MCP"}]},{"id":"7SvzDlAaeA3qddGl1gOl","title":"telys_add","pathname":"/mcp/tool-add","siteSpaceId":"sitesp_vIYrg","icon":"plus","description":"Reference for the telys_add MCP tool — add text documents to a Telys memory collection, auto-creating and saving it when the collection does not exist.","breadcrumbs":[{"label":"MCP"}]},{"id":"D5RaISGc7puAJ3d1WwEz","title":"telys_create_collection","pathname":"/mcp/tool-create-collection","siteSpaceId":"sitesp_vIYrg","icon":"layer-group","description":"Reference for the telys_create_collection MCP tool — create a named Telys memory collection, partitioned by scope, in the active memory store.","breadcrumbs":[{"label":"MCP"}]},{"id":"8i5abSvg010inWab2VmF","title":"telys_list_collections","pathname":"/mcp/tool-list-collections","siteSpaceId":"sitesp_vIYrg","icon":"list","description":"Reference for the telys_list_collections MCP tool — list the saved Telys memory collections in the active memory store.","breadcrumbs":[{"label":"MCP"}]},{"id":"eczmwgeQDFnqqdHa80ld","title":"telys_stats","pathname":"/mcp/tool-stats","siteSpaceId":"sitesp_vIYrg","icon":"chart-simple","description":"Reference for the telys_stats MCP tool — report row counts and index state for a Telys memory collection in the active store.","breadcrumbs":[{"label":"MCP"}]},{"id":"WSNXqM7PJEas18L3bBPP","title":"Config & scoping","pathname":"/mcp/configuration-and-scoping","siteSpaceId":"sitesp_vIYrg","icon":"gear","description":"Reference for the Telys MCP server — environment configuration, user vs project install scope, result wrapping, the error shape, and the exact tool set.","breadcrumbs":[{"label":"MCP"}]},{"id":"GRqsH5DPQpYEB3ISZf53","title":"Overview","pathname":"/self-hosting/overview","siteSpaceId":"sitesp_vIYrg","icon":"server","description":"Run Telys as a local server so several processes or hosts share one memory store over a Unix socket or an access-token-protected TCP port.","breadcrumbs":[{"label":"Self-hosting"}]},{"id":"m2J97eu4yShN3lKTM7aN","title":"Run a server","pathname":"/self-hosting/running-a-server","siteSpaceId":"sitesp_vIYrg","icon":"play","description":"Start a long-lived Telys server on a Unix socket or an access-token-protected TCP port, from the CLI or from Python, with durability and supervision options.","breadcrumbs":[{"label":"Self-hosting"}]},{"id":"eM9bdGEBcTduuJ0KXZ1Y","title":"Connect remotely","pathname":"/self-hosting/connecting-remote","siteSpaceId":"sitesp_vIYrg","icon":"network-wired","description":"Connect to a running Telys server with connect() / RemoteTelys, create and open collections remotely, and ingest and search over the length-prefixed socket protocol.","breadcrumbs":[{"label":"Self-hosting"}]},{"id":"N6BRLlIY4N7N32k9EspF","title":"Auth & network","pathname":"/self-hosting/auth-and-network","siteSpaceId":"sitesp_vIYrg","icon":"lock","description":"How a Telys server decides who may connect — trusted Unix sockets, token-gated TCP with constant-time comparison, the length-prefixed JSON wire protocol, and the offline license gate.","breadcrumbs":[{"label":"Self-hosting"}]},{"id":"zSorEmAqBPcQflEp0TRl","title":"Deployment","pathname":"/self-hosting/deployment","siteSpaceId":"sitesp_vIYrg","icon":"rocket","description":"Run a Telys server durably in production — private networking, systemd or supervisor management, auto-restart, timed saves, and store backups on the self-host Team tier.","breadcrumbs":[{"label":"Self-hosting"}]},{"id":"QYbY40mZFZxkolWKKL7V","title":"Agent long-term memory","pathname":"/recipes/agent-long-term-memory","siteSpaceId":"sitesp_vIYrg","icon":"robot","description":"Give an AI agent durable, per-user memory with Telys — partition by user, write observations, and recall relevant history before every turn.","breadcrumbs":[{"label":"Recipes"}]},{"id":"3eE2RUN6Caqv3I5vLIpd","title":"RAG over a codebase","pathname":"/recipes/rag-over-a-codebase","siteSpaceId":"sitesp_vIYrg","icon":"code","description":"Index a codebase into Telys — chunk files, add them with path and line metadata, retrieve with natural-language search, and hand the results to an LLM.","breadcrumbs":[{"label":"Recipes"}]},{"id":"kFgHki3hX9gk8Key8GcJ","title":"Chat memory","pathname":"/recipes/chat-memory","siteSpaceId":"sitesp_vIYrg","icon":"comments","description":"Store chat turns in Telys, recall the most relevant history for the current message, and prune old turns with delete and compact to keep sessions bounded.","breadcrumbs":[{"label":"Recipes"}]},{"id":"omWERfy25S4dJh48glr5","title":"Batch ingestion","pathname":"/recipes/batch-ingestion","siteSpaceId":"sitesp_vIYrg","icon":"cubes","description":"Load large corpora into Telys efficiently — batch add_texts, precompute vectors with add for BYO models, build the IVF index after load, and save once.","breadcrumbs":[{"label":"Recipes"}]},{"id":"rqi1E0G8vx4MwH31ox8y","title":"OpenAI & Anthropic","pathname":"/recipes/with-openai-anthropic","siteSpaceId":"sitesp_vIYrg","icon":"cloud","description":"Pair Telys retrieval with an OpenAI or Anthropic chat model — embed with CallableEmbedder or a local Algenta embedder, retrieve, and augment the prompt.","breadcrumbs":[{"label":"Recipes"}]},{"id":"ru06pM16Rdc2PJTngxGP","title":"Framework bridge","pathname":"/recipes/framework-bridge","siteSpaceId":"sitesp_vIYrg","icon":"puzzle-piece","description":"Build your own thin adapter to use Telys as a retriever or vector store inside LangChain or LlamaIndex, using only the public SDK and CallableEmbedder.","breadcrumbs":[{"label":"Recipes"}]},{"id":"hGLr4vJ3ScfwXbJDIcyi","title":"Plans & licensing","pathname":"/licensing/tiers-and-pricing","siteSpaceId":"sitesp_vIYrg","icon":"tags","description":"The four Telys tiers — developer, pro, team, and enterprise — what each unlocks, how to activate it, and where to see current prices and sign up.","breadcrumbs":[{"label":"Licensing"}]},{"id":"OyOdiQaPDCqPas2F5xZ5","title":"Device-code sign-in","pathname":"/licensing/device-code-sign-in","siteSpaceId":"sitesp_vIYrg","icon":"mobile","description":"How telys login uses the RFC 8628 device-code flow to sign you in, register a device key, and fetch your offline license — with a headless path for CI.","breadcrumbs":[{"label":"Licensing"}]},{"id":"uRMcsbR2tREfJPlvdVTx","title":"Offline licenses","pathname":"/licensing/offline-licenses","siteSpaceId":"sitesp_vIYrg","icon":"file-shield","description":"The Telys license is a signed, offline-verifiable JWT — this page explains its claims, how telys.verify and telys runtime verify check it locally, and why it works with no network.","breadcrumbs":[{"label":"Licensing"}]},{"id":"KVMLT3N7ydzCjWYTpYrc","title":"Manage subscription","pathname":"/licensing/managing-subscription","siteSpaceId":"sitesp_vIYrg","icon":"credit-card","description":"Upgrade, downgrade, cancel, and manage devices for your Telys plan in the accounts.thyn.ai portal, then refresh the license on your machine.","breadcrumbs":[{"label":"Licensing"}]},{"id":"QId9O6LUKECM8BkqZLfg","title":"Seats & devices","pathname":"/licensing/seats-and-devices","siteSpaceId":"sitesp_vIYrg","icon":"users","description":"How Telys counts seats and devices — one device on the free plan, per-seat devices on pro and team, each with its own key and id — and how to sign in on a new machine.","breadcrumbs":[{"label":"Licensing"}]},{"id":"jLlQKGv5GwnJU5gn4Frl","title":"Overview","pathname":"/security/overview","siteSpaceId":"sitesp_vIYrg","icon":"shield-halved","description":"Telys's security posture at a docs level — on-device and offline-first, three cryptographic trust anchors, a precise list of what leaves the machine, and the threat model.","breadcrumbs":[{"label":"Security"}]},{"id":"IfZ7h0ml3OjlVuNi4tGX","title":"Trust anchors","pathname":"/security/trust-anchors","siteSpaceId":"sitesp_vIYrg","icon":"anchor","description":"The three cryptographic checks Telys runs before activating the native runtime — a signed release manifest, per-artifact SHA-256 hashes, and a strict offline license.","breadcrumbs":[{"label":"Security"}]},{"id":"0hje8J5hOfSb7uBhwgsG","title":"What leaves the machine","pathname":"/security/what-leaves-the-machine","siteSpaceId":"sitesp_vIYrg","icon":"wifi","description":"A precise accounting of every byte Telys sends over the network — login, control plane, and runtime download — and confirmation that vectors, text, and queries never leave.","breadcrumbs":[{"label":"Security"}]},{"id":"as3JvHboA5RxokqNHpAw","title":"Verify the runtime","pathname":"/security/runtime-signature-verification","siteSpaceId":"sitesp_vIYrg","icon":"file-signature","description":"Verify a Telys install offline — run telys runtime verify, then reproduce the release-manifest, artifact-hash, and license checks yourself with the telys.verify API.","breadcrumbs":[{"label":"Security"}]},{"id":"czd8vgdLG6PP6tkAwVVq","title":"Data residency","pathname":"/security/data-residency-privacy","siteSpaceId":"sitesp_vIYrg","icon":"user-shield","description":"Where Telys keeps your data — on your own disk under $TELYS_HOME, with no content telemetry — and why that makes it suitable for regulated and air-gapped deployments.","breadcrumbs":[{"label":"Security"}]},{"id":"51C3pUeevJC3K2vq5RRC","title":"Environment variables","pathname":"/operations/environment-variables","siteSpaceId":"sitesp_vIYrg","icon":"list","description":"Reference for every Telys environment variable — defaults, effects, precedence, and which commands read them.","breadcrumbs":[{"label":"Operations"}]},{"id":"2zslEGbkkXRBUP6ppFSD","title":"On-disk layout","pathname":"/operations/on-disk-layout","siteSpaceId":"sitesp_vIYrg","icon":"folder-tree","description":"Reference map of everything Telys stores under $TELYS_HOME — credentials, the verified runtime, and per-collection files.","breadcrumbs":[{"label":"Operations"}]},{"id":"8ZuBgRkr29CUHhibOPXT","title":"Supported platforms","pathname":"/operations/supported-platforms","siteSpaceId":"sitesp_vIYrg","icon":"desktop","description":"Reference for the platforms the Telys signed runtime supports, plus the reach of the pure-Python SDK.","breadcrumbs":[{"label":"Operations"}]},{"id":"yVB6wMEurT1jRXgd61kU","title":"Python support","pathname":"/operations/python-version-support","siteSpaceId":"sitesp_vIYrg","icon":"code","description":"Reference for the Python versions Telys supports (3.10+), why the pure-Python wheel runs on newer ones, and how to install.","breadcrumbs":[{"label":"Operations"}]},{"id":"BvKL8U29goZ89GkHi2nh","title":"Upgrade","pathname":"/operations/upgrading","siteSpaceId":"sitesp_vIYrg","icon":"arrow-up","description":"Upgrade the Telys SDK with pipx or pip, re-verify the signed runtime, and confirm the new version.","breadcrumbs":[{"label":"Operations"}]},{"id":"8DNyij8tbdwZCUAr1fyC","title":"Uninstall","pathname":"/operations/uninstalling","siteSpaceId":"sitesp_vIYrg","icon":"trash-can","description":"Remove the Telys package and, optionally, clear all on-disk state under ~/.telys.","breadcrumbs":[{"label":"Operations"}]},{"id":"VhMUJSC7eRdsdBaMUwba","title":"Overview","pathname":"/troubleshooting/overview","siteSpaceId":"sitesp_vIYrg","icon":"life-ring","description":"Start here when something breaks — a 60-second triage with telys runtime status, telys runtime verify, and telys version, then jump to the page for your problem.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"sTZH257W259P14bHy2EA","title":"Install & runtime","pathname":"/troubleshooting/install-and-runtime","siteSpaceId":"sitesp_vIYrg","icon":"triangle-exclamation","description":"Fix RuntimeNotInstalled, a missing or undownloaded signed runtime, an unsupported platform, and native-kernel-not-found (TELYS_KERNEL) errors.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"f5D2AxbBcG8bokGMGJNZ","title":"License & login","pathname":"/troubleshooting/license-and-login","siteSpaceId":"sitesp_vIYrg","icon":"key","description":"Fix a failed telys login, an expired or invalid license, a wrong-plan account, and headless sign-in with --token in CI or over SSH.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"0eykLEyLKnupmpNlVgH9","title":"Signature verification","pathname":"/troubleshooting/signature-verification","siteSpaceId":"sitesp_vIYrg","icon":"circle-xmark","description":"Fix VerificationError — runtime manifest or artifact hash mismatches and license claim failures (iss / aud / exp / ver) — including trusted key overrides.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"oKbcrBs3CQX8o02wjPZN","title":"No results / recall","pathname":"/troubleshooting/search-and-recall","siteSpaceId":"sitesp_vIYrg","icon":"circle-exclamation","description":"Fix empty search results (unsaved data, wrong partition or where filter, no embedder) and poor recall (wrong embedder, missing IVF, or a low target_recall).","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"cLf0cG2Rm2TZeyApGR9I","title":"Dimension mismatches","pathname":"/troubleshooting/dimension-mismatches","siteSpaceId":"sitesp_vIYrg","icon":"ruler","description":"Fix embedding dimension errors — dim vs profile.dimension at create, query length vs dim at search, and space_id incompatibility after changing models.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"oK1vZXEvrJ6ET1JcSX8G","title":"MCP client","pathname":"/troubleshooting/mcp-client","siteSpaceId":"sitesp_vIYrg","icon":"plug","description":"Fix an MCP client that won't connect to Telys — server not detected on PATH, env block not delivered, tools missing, or a stale virtualenv.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"1rwJMQiVqqVsvqlbVWbC","title":"Platform-specific","pathname":"/troubleshooting/platform-specific","siteSpaceId":"sitesp_vIYrg","icon":"desktop","description":"Fix platform-specific issues — macOS Gatekeeper and PATH for GUI clients, experimental Linux arm64, Windows via WSL2, and unsupported Intel Mac.","breadcrumbs":[{"label":"Troubleshooting"}]},{"id":"noudKEHV7DgrGM5qy5p6","title":"SDK API index","pathname":"/reference/sdk-api-index","siteSpaceId":"sitesp_vIYrg","icon":"book","description":"Complete index of the public Telys API — the Telys facade, every Collection method with its signature, scope_key, and the top-level exports.","breadcrumbs":[{"label":"Reference"}]},{"id":"XlOUsxzBZ8IfoM7UaPXr","title":"TypeScript SDK","pathname":"/reference/typescript-sdk","siteSpaceId":"sitesp_vIYrg","icon":"code","description":"Reference for the TypeScript SDK (npm `telys-ai`) — the encapsulated in-process runtime, the Telys/Collection surface, Eq filters, persistence shared with Python, and the runtime ops.","breadcrumbs":[{"label":"Reference"}]},{"id":"Gecj6sBExuNdfnjm5iOB","title":"Filters (Eq)","pathname":"/reference/filters","siteSpaceId":"sitesp_vIYrg","icon":"filter","description":"Reference for Eq — the single equality filter Telys supports on search, search_text, and ids, and how it maps to the single-key dict at the MCP boundary.","breadcrumbs":[{"label":"Reference"}]},{"id":"XX1QfZrdFzsjJ9XKpN80","title":"Embedders","pathname":"/reference/embedders-api","siteSpaceId":"sitesp_vIYrg","icon":"plug","description":"Reference for telys.embedding — the EmbeddingProvider base class, EmbeddingProfile, CallableEmbedder, and the Algenta bigram/multigram/pooled embedders.","breadcrumbs":[{"label":"Reference"}]},{"id":"jETLS0cQN8H09BgeQIXJ","title":"Tuner & plans","pathname":"/reference/tuner-api","siteSpaceId":"sitesp_vIYrg","icon":"sliders","description":"Reference for Tuner, TuningPlan, and the runtime-only HeuristicTuner — the objects that produce, describe, and apply a collection's index tuning.","breadcrumbs":[{"label":"Reference"}]},{"id":"UWvIgdnHL2WmqDcv9fMO","title":"Runtime","pathname":"/reference/runtime-api","siteSpaceId":"sitesp_vIYrg","icon":"microchip","description":"Reference for telys.runtime — load_runtime, runtime_available, the RuntimeHandle interface, FORMAT_VERSION, RuntimeNotInstalled, and the TELYS_RUNTIME switch.","breadcrumbs":[{"label":"Reference"}]},{"id":"UJxEHqp7LiaWT1dNSCDZ","title":"Remote","pathname":"/reference/remote-api","siteSpaceId":"sitesp_vIYrg","icon":"network-wired","description":"Reference for the remote surface — connect and RemoteTelys, the RemoteCollection subset, serve and TelysServer, address forms, and the wire protocol.","breadcrumbs":[{"label":"Reference"}]},{"id":"6XF5eSw2bmrtE5ICxHTM","title":"Exceptions & errors","pathname":"/reference/exceptions-and-errors","siteSpaceId":"sitesp_vIYrg","icon":"bug","description":"Reference for the exceptions Telys raises across the SDK, server, and verify APIs, plus what each CLI exit code means.","breadcrumbs":[{"label":"Reference"}]},{"id":"LyNuoA0FL3On8GMWH3Mf","title":"Glossary","pathname":"/reference/glossary","siteSpaceId":"sitesp_vIYrg","icon":"book-open","description":"One-line definitions of the core Telys terms — collection, partition, scope_key, embedder, space_id, IVF, nprobe, target_recall, runtime, kernel, license, and more.","breadcrumbs":[{"label":"Reference"}]},{"id":"OFwNepttmez6gJVpQkhE","title":"Design principles","pathname":"/resources/design-principles","siteSpaceId":"sitesp_vIYrg","icon":"lightbulb","description":"The constraints that shape Telys — on-device first, private by default, signed and verifiable, a thin SDK over a closed runtime, deterministic lexical, one space per collection.","breadcrumbs":[{"label":"Resources"}]},{"id":"f7dOUtKNN3UN5Fj5Ukxm","title":"Changelog","pathname":"/resources/changelog","siteSpaceId":"sitesp_vIYrg","icon":"clock-rotate-left","description":"Release history for the public Telys SDK — every shipped version, what changed, and the compatibility facts that go with it.","breadcrumbs":[{"label":"Resources"}]},{"id":"y4VfbYuWFvrlVHZMRXPS","title":"FAQ","pathname":"/resources/faq","siteSpaceId":"sitesp_vIYrg","icon":"circle-question","description":"Short, direct answers to the questions people ask most about Telys — privacy, offline use, GPUs and model downloads, bring-your-own embeddings, Windows, and pricing.","breadcrumbs":[{"label":"Resources"}]},{"id":"nKMNR2H1s7MmJon1xJCF","title":"Support","pathname":"/resources/support","siteSpaceId":"sitesp_vIYrg","icon":"headset","description":"Where to get help with Telys — the contact form, the accounts portal, and this documentation site — plus what to include so we can help fast.","breadcrumbs":[{"label":"Resources"}]},{"id":"FKMniEvrQU4SSPHfJNTS","title":"Links","pathname":"/resources/resources","siteSpaceId":"sitesp_vIYrg","icon":"link","description":"Every official Telys link in one place — the product site, pricing, the accounts portal, the PyPI package, and the MCP registry listing.","breadcrumbs":[{"label":"Resources"}]}]}