Operate
For the complete BrainAPI documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.
What's new
Track documented BrainAPI V2 behavior and documentation changes
This page records changes verified in the current source tree. It is not a promise that unreleased behavior is available on every deployed instance.
Documented through 2.20.1-dev.5
- Covered staged ingestion cancellation, worker and publisher recovery, and callback rejection after cancellation.
- Covered URL ingestion and section activity for hosted progressive imports.
- Covered brain clear and delete operations and progressive graph exploration on the PostgreSQL graph driver.
- Refreshed the core API reference from the released source.
2.17.0-dev
Search and retrieval
- Added opt-in ranked Search with BM25, dense, graph, catalog, plugin, reranking, personalization, facets, and stage profiling controls.
- Added Search Rerank, Search SPLADE, and Search ColBERT plugin documentation and author hooks.
- Clarified that
/retrieve/context,/retrieve/search,/retrieve/recommend, graph APIs, and MCP are distinct surfaces over one knowledge base. - Added query-gated catalog personalization and documented safe fallback behavior.
Ingestion and recommendations
- Documented direct and event-centric structured triples, deterministic/hybrid/enrich modes, and
skip_enrichment. - Documented behavior weights and the additive Features Rec and RecSys GNN plugin paths.
Developer experience
- Reorganized V2 into task-first Start, Build, Retrieve, Extend, Operate, and Reference groups without changing established URLs.
- Added a complete quickstart, authentication/brain-scoping guide, retrieval chooser, configuration guide, troubleshooting hub, and grouped core API reference.
- Kept benchmark and incomplete placeholder pages unpublished across HTML and machine-readable surfaces.
Earlier V2 tags
The repository contains earlier development tags. Their source history remains available in BrainAPI releases and tags. This page does not reconstruct release notes that were not recorded at the time.
Maintenance policy
- Put upcoming verified behavior under Unreleased.
- Move it to a dated version only when that version is tagged or released.
- Link changed public contracts to their canonical reference pages.
- Label experimental architecture demonstrations and unshipped research explicitly.