72 lines
1.9 KiB
Markdown
72 lines
1.9 KiB
Markdown
# Enterprise Knowledge Platform
|
|
|
|
Enterprise internal knowledge infrastructure.
|
|
|
|
## Core capabilities
|
|
|
|
- Multi-format document ingestion
|
|
- OCR and document parsing
|
|
- Structure-aware chunking
|
|
- Multiple embedding providers
|
|
- Hybrid retrieval and reranking
|
|
- ACL-aware search
|
|
- Knowledge Compilation
|
|
- REST API
|
|
- MCP Server
|
|
- Admin Console
|
|
|
|
## Architecture baseline
|
|
|
|
- API First + Admin Console
|
|
- Modular Monolith + async workers + MCP gateway
|
|
- PostgreSQL + object storage as canonical source of truth
|
|
- Mochow as the initial retrieval index, behind a replaceable adapter
|
|
- Embedding / reranker / parser / LLM providers are replaceable
|
|
- Raw source is immutable
|
|
- Compiled Knowledge is derived and traceable
|
|
- ACL is enforced before or during retrieval, never after Top-K
|
|
|
|
## Start here
|
|
|
|
1. Read `AGENTS.md`
|
|
2. Read `CODEX_START_HERE.md`
|
|
3. Read `docs/product/PRD.md`
|
|
4. Read `docs/architecture/ARCHITECTURE.md`
|
|
5. Read `docs/plans/V1_EXECUTION_PLAN.md`
|
|
6. For the current milestone, read `docs/demo/DEMO_SCOPE.md` and pick exactly
|
|
one `DEMO-*` task. The V1 tasks in `docs/plans/TASKS.md` remain the deferred
|
|
product backlog.
|
|
|
|
## Demo development
|
|
|
|
The current implementation target is the retrieval demo defined in
|
|
`docs/demo/DEMO_SCOPE.md`.
|
|
|
|
Prerequisites:
|
|
|
|
- `uv`
|
|
- Docker (for PostgreSQL and later integration dependencies)
|
|
|
|
Install dependencies and run the API:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
make install
|
|
make run
|
|
```
|
|
|
|
The health endpoint is available at `http://localhost:8000/healthz`, and the
|
|
versioned OpenAPI document is available at
|
|
`http://localhost:8000/api/v1/openapi.json`.
|
|
|
|
Run the development checks with:
|
|
|
|
```bash
|
|
make format-check lint typecheck test migration-check eval
|
|
```
|
|
|
|
Document metadata is canonical in PostgreSQL. Demo source files use the local
|
|
`storage/` directory through the provider-neutral `ObjectStorage` interface;
|
|
existing objects cannot be overwritten. Upload endpoints are introduced by
|
|
DEMO-003, not by the current storage foundation.
|