483c0ec354
overview.md repeated the landing page: the same install-and-ask block and five of six identical links. It was positioning prose, where the docs had no page describing how the system works. Rewrite it as Architecture, following the data through: source adapter, converter, chunker, embedder, transaction; then storage and its versioning; then retrieval, with the 10x rerank fetch and section-bounded expansion; then the two capabilities; then laptop versus ingester. Retitled in the nav and on the landing page, filename kept so existing links resolve. Extras were listed in three places and none was complete. docs/installation.md now carries a table of all fifteen slim extras, what each provides, and which the full package already includes. haiku_rag_slim/README.md names them and links there. The claim that other providers need their own pydantic-ai extra was wrong: haiku.rag-slim defines anthropic, google, groq, mistral, bedrock and vertexai itself. configuration/storage.md opens with the four operational constraints, which were either buried in an S3 section or undocumented: one writer per URI, reader lag by read_consistency_interval_seconds, migrate after a schema-changing upgrade, and the fixed embedding dimension with what ConfigMismatchError means and which rebuild mode resolves it. The one-writer rule is stated as a haiku.rag constraint, which is what it is: the multi-table lock, version snapshot and rollback are process-local, so a second writer can commit inside another's transaction and be reverted by its rollback. storage.md and ingester.md both claimed it was a LanceDB property that corrupts manifests. The S3 deployment section now links to the constraint instead of restating it. Get started reads index, Quickstart, Installation, Architecture. The landing page's list was missing Installation.
60 lines
1.9 KiB
Markdown
60 lines
1.9 KiB
Markdown
# haiku.rag-slim
|
|
|
|
Opinionated agentic RAG powered by LanceDB, Pydantic AI, and Docling - Core package with minimal dependencies.
|
|
|
|
`haiku.rag-slim` is the core package for users who want to install only the dependencies they need. Document processing (docling), and reranker support are all optional extras.
|
|
|
|
**For most users, we recommend installing [`haiku.rag`](https://pypi.org/project/haiku.rag/) instead**, which includes all features out of the box.
|
|
|
|
## Installation
|
|
|
|
**Python 3.12 or newer required**
|
|
|
|
### Minimal Installation
|
|
|
|
```bash
|
|
uv pip install haiku.rag-slim
|
|
```
|
|
|
|
Core functionality with OpenAI/Ollama support, MCP server, and Logfire observability. Document processing (docling) is optional.
|
|
|
|
### With Document Processing
|
|
|
|
```bash
|
|
uv pip install haiku.rag-slim[docling]
|
|
```
|
|
|
|
Adds support for 40+ file formats including PDF, DOCX, HTML, and more.
|
|
|
|
### Available Extras
|
|
|
|
`docling`, `tui`, `voyageai`, `cohere`, `zeroentropy`, `cross-encoder`, `jina`,
|
|
`s3`, `ingester`, and one per model provider: `anthropic`, `google`, `groq`,
|
|
`mistral`, `bedrock`, `vertexai`. Ollama and any OpenAI-compatible endpoint need
|
|
no extra.
|
|
|
|
What each provides, and which ones the full `haiku.rag` package already
|
|
includes: [Installation](https://ggozad.github.io/haiku.rag/installation/).
|
|
|
|
```bash
|
|
# Common combinations
|
|
uv pip install 'haiku.rag-slim[docling,anthropic,cross-encoder]'
|
|
uv pip install 'haiku.rag-slim[docling,groq]'
|
|
```
|
|
|
|
## Usage
|
|
|
|
See the main [`haiku.rag`](https://github.com/ggozad/haiku.rag) repository for:
|
|
- Quick start guide
|
|
- CLI examples
|
|
- Python API usage
|
|
- MCP server setup
|
|
|
|
## Documentation
|
|
|
|
Full documentation: https://ggozad.github.io/haiku.rag/
|
|
|
|
- [Installation](https://ggozad.github.io/haiku.rag/installation/) - Provider setup
|
|
- [Configuration](https://ggozad.github.io/haiku.rag/configuration/) - YAML configuration
|
|
- [CLI](https://ggozad.github.io/haiku.rag/cli/) - Command reference
|
|
- [Python API](https://ggozad.github.io/haiku.rag/python/) - Complete API docs
|