haiku.rag 0.10.2__py3-none-any.whl → 0.19.3__py3-none-any.whl

README.md

@@ -0,0 +1,172 @@
+# Haiku RAG
+
+Retrieval-Augmented Generation (RAG) library built on LanceDB.
+
+`haiku.rag` is a Retrieval-Augmented Generation (RAG) library built to work with LanceDB as a local vector database. It uses LanceDB for storing embeddings and performs semantic (vector) search as well as full-text search combined through native hybrid search with Reciprocal Rank Fusion. Both open-source (Ollama) as well as commercial (OpenAI, VoyageAI) embedding providers are supported.
+
+## Features
+
+- **Local LanceDB**: No external servers required, supports also LanceDB cloud storage, S3, Google Cloud & Azure
+- **Multiple embedding providers**: Ollama, LM Studio, VoyageAI, OpenAI, vLLM
+- **Multiple QA providers**: Any provider/model supported by Pydantic AI (Ollama, LM Studio, OpenAI, Anthropic, etc.)
+- **Native hybrid search**: Vector + full-text search with native LanceDB RRF reranking
+- **Reranking**: Default search result reranking with MixedBread AI, Cohere, Zero Entropy, or vLLM
+- **Question answering**: Built-in QA agents on your documents
+- **Research graph (multi‑agent)**: Plan → Search → Evaluate → Synthesize with agentic AI
+- **File monitoring**: Auto-index files when run as server
+- **CLI & Python API**: Use from command line or Python
+- **MCP server**: Expose as tools for AI assistants
+- **Flexible document processing**: Local (docling) or remote (docling-serve) processing
+
+## Installation
+
+**Python 3.12 or newer required**
+
+### Full Package (Recommended)
+
+```bash
+uv pip install haiku.rag
+```
+
+Includes all features: document processing, all embedding providers, and rerankers.
+
+### Slim Package (Minimal Dependencies)
+
+```bash
+uv pip install haiku.rag-slim
+```
+
+Install only the extras you need. See the [Installation](https://ggozad.github.io/haiku.rag/installation/) documentation for available options
+
+## Quick Start
+
+```bash
+# Add documents
+haiku-rag add "Your content here"
+haiku-rag add "Your content here" --meta author=alice --meta topic=notes
+haiku-rag add-src document.pdf --meta source=manual
+
+# Search
+haiku-rag search "query"
+
+# Search with filters
+haiku-rag search "query" --filter "uri LIKE '%.pdf' AND title LIKE '%paper%'"
+
+# Ask questions
+haiku-rag ask "Who is the author of haiku.rag?"
+
+# Ask questions with citations
+haiku-rag ask "Who is the author of haiku.rag?" --cite
+
+# Deep QA (multi-agent question decomposition)
+haiku-rag ask "Who is the author of haiku.rag?" --deep --cite
+
+# Deep QA with verbose output
+haiku-rag ask "Who is the author of haiku.rag?" --deep --verbose
+
+# Multi‑agent research (iterative plan/search/evaluate)
+haiku-rag research \
+  "What are the main drivers and trends of global temperature anomalies since 1990?" \
+  --max-iterations 2 \
+  --confidence-threshold 0.8 \
+  --max-concurrency 3 \
+  --verbose
+
+# Rebuild database (re-chunk and re-embed all documents)
+haiku-rag rebuild
+
+# Start server with file monitoring
+haiku-rag serve --monitor
+```
+
+To customize settings, create a `haiku.rag.yaml` config file (see [Configuration](https://ggozad.github.io/haiku.rag/configuration/)).
+
+## Python Usage
+
+```python
+from haiku.rag.client import HaikuRAG
+from haiku.rag.config import Config
+from haiku.rag.graph.agui import stream_graph
+from haiku.rag.graph.research import (
+    ResearchContext,
+    ResearchDeps,
+    ResearchState,
+    build_research_graph,
+)
+
+async with HaikuRAG("database.lancedb") as client:
+    # Add document
+    doc = await client.create_document("Your content")
+
+    # Search (reranking enabled by default)
+    results = await client.search("query")
+    for chunk, score in results:
+        print(f"{score:.3f}: {chunk.content}")
+
+    # Ask questions
+    answer = await client.ask("Who is the author of haiku.rag?")
+    print(answer)
+
+    # Ask questions with citations
+    answer = await client.ask("Who is the author of haiku.rag?", cite=True)
+    print(answer)
+
+    # Multi‑agent research pipeline (Plan → Search → Evaluate → Synthesize)
+    # Graph settings (provider, model, max_iterations, etc.) come from config
+    graph = build_research_graph(config=Config)
+    question = (
+        "What are the main drivers and trends of global temperature "
+        "anomalies since 1990?"
+    )
+    context = ResearchContext(original_question=question)
+    state = ResearchState.from_config(context=context, config=Config)
+    deps = ResearchDeps(client=client)
+
+    # Blocking run (final result only)
+    report = await graph.run(state=state, deps=deps)
+    print(report.title)
+
+    # Streaming progress (AG-UI events)
+    async for event in stream_graph(graph, state, deps):
+        if event["type"] == "STEP_STARTED":
+            print(f"Starting step: {event['stepName']}")
+        elif event["type"] == "ACTIVITY_SNAPSHOT":
+            print(f"  {event['content']}")
+        elif event["type"] == "RUN_FINISHED":
+            print("\nResearch complete!\n")
+            result = event["result"]
+            print(result["title"])
+            print(result["executive_summary"])
+```
+
+## MCP Server
+
+Use with AI assistants like Claude Desktop:
+
+```bash
+haiku-rag serve --stdio
+```
+
+Provides tools for document management and search directly in your AI assistant.
+
+## Examples
+
+See the [examples directory](examples/) for working examples:
+
+- **[Interactive Research Assistant](examples/ag-ui-research/)** - Full-stack research assistant with Pydantic AI and AG-UI featuring human-in-the-loop approval and real-time state synchronization
+- **[Docker Setup](examples/docker/)** - Complete Docker deployment with file monitoring and MCP server
+- **[A2A Server](examples/a2a-server/)** - Self-contained A2A protocol server package with conversational agent interface
+
+## Documentation
+
+Full documentation at: 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
+- [Agents](https://ggozad.github.io/haiku.rag/agents/) - QA agent and multi-agent research
+- [MCP Server](https://ggozad.github.io/haiku.rag/mcp/) - Model Context Protocol integration
+- [Benchmarks](https://ggozad.github.io/haiku.rag/benchmarks/) - Performance Benchmarks
+
+mcp-name: io.github.ggozad/haiku-rag

{haiku_rag-0.10.2.dist-info → haiku_rag-0.19.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: haiku.rag
-Version: 0.10.2
+Version: 0.19.3
 Summary: Agentic Retrieval Augmented Generation (RAG) with LanceDB
 Author-email: Yiorgis Gozadinos <ggozadinos@gmail.com>
 License: MIT
@@ -13,27 +13,13 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows :: Windows 10
 Classifier: Operating System :: Microsoft :: Windows :: Windows 11
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.12
-Requires-Dist: docling>=2.52.0
-Requires-Dist: fastmcp>=2.12.3
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: lancedb>=0.25.0
-Requires-Dist: pydantic-ai>=1.0.8
-Requires-Dist: pydantic-graph>=1.0.8
-Requires-Dist: pydantic>=2.11.9
-Requires-Dist: python-dotenv>=1.1.1
-Requires-Dist: rich>=14.1.0
-Requires-Dist: tiktoken>=0.11.0
-Requires-Dist: typer>=0.16.1
-Requires-Dist: watchfiles>=1.1.0
-Provides-Extra: mxbai
-Requires-Dist: mxbai-rerank>=0.1.6; extra == 'mxbai'
-Provides-Extra: voyageai
-Requires-Dist: voyageai>=0.3.5; extra == 'voyageai'
+Requires-Dist: haiku-rag-slim[cohere,docling,inspector,mxbai,voyageai,zeroentropy]==0.19.3
+Provides-Extra: inspector
+Requires-Dist: textual>=1.0.0; extra == 'inspector'
 Description-Content-Type: text/markdown
 
 # Haiku RAG
@@ -42,28 +28,43 @@ Retrieval-Augmented Generation (RAG) library built on LanceDB.
 
 `haiku.rag` is a Retrieval-Augmented Generation (RAG) library built to work with LanceDB as a local vector database. It uses LanceDB for storing embeddings and performs semantic (vector) search as well as full-text search combined through native hybrid search with Reciprocal Rank Fusion. Both open-source (Ollama) as well as commercial (OpenAI, VoyageAI) embedding providers are supported.
 
-> **Note**: Starting with version 0.7.0, haiku.rag uses LanceDB instead of SQLite. If you have an existing SQLite database, use `haiku-rag migrate old_database.sqlite` to migrate your data safely.
-
 ## Features
 
 - **Local LanceDB**: No external servers required, supports also LanceDB cloud storage, S3, Google Cloud & Azure
-- **Multiple embedding providers**: Ollama, VoyageAI, OpenAI, vLLM
-- **Multiple QA providers**: Any provider/model supported by Pydantic AI
-- **Research graph (multi‑agent)**: Plan → Search → Evaluate → Synthesize with agentic AI
+- **Multiple embedding providers**: Ollama, LM Studio, VoyageAI, OpenAI, vLLM
+- **Multiple QA providers**: Any provider/model supported by Pydantic AI (Ollama, LM Studio, OpenAI, Anthropic, etc.)
 - **Native hybrid search**: Vector + full-text search with native LanceDB RRF reranking
-- **Reranking**: Default search result reranking with MixedBread AI, Cohere, or vLLM
+- **Reranking**: Default search result reranking with MixedBread AI, Cohere, Zero Entropy, or vLLM
 - **Question answering**: Built-in QA agents on your documents
+- **Research graph (multi‑agent)**: Plan → Search → Evaluate → Synthesize with agentic AI
 - **File monitoring**: Auto-index files when run as server
-- **40+ file formats**: PDF, DOCX, HTML, Markdown, code files, URLs
-- **MCP server**: Expose as tools for AI assistants
 - **CLI & Python API**: Use from command line or Python
+- **MCP server**: Expose as tools for AI assistants
+- **Flexible document processing**: Local (docling) or remote (docling-serve) processing
 
-## Quick Start
+## Installation
+
+**Python 3.12 or newer required**
+
+### Full Package (Recommended)
 
 ```bash
-# Install
 uv pip install haiku.rag
+```
+
+Includes all features: document processing, all embedding providers, and rerankers.
+
+### Slim Package (Minimal Dependencies)
+
+```bash
+uv pip install haiku.rag-slim
+```
+
+Install only the extras you need. See the [Installation](https://ggozad.github.io/haiku.rag/installation/) documentation for available options
 
+## Quick Start
+
+```bash
 # Add documents
 haiku-rag add "Your content here"
 haiku-rag add "Your content here" --meta author=alice --meta topic=notes
@@ -72,12 +73,21 @@ haiku-rag add-src document.pdf --meta source=manual
 # Search
 haiku-rag search "query"
 
+# Search with filters
+haiku-rag search "query" --filter "uri LIKE '%.pdf' AND title LIKE '%paper%'"
+
 # Ask questions
 haiku-rag ask "Who is the author of haiku.rag?"
 
 # Ask questions with citations
 haiku-rag ask "Who is the author of haiku.rag?" --cite
 
+# Deep QA (multi-agent question decomposition)
+haiku-rag ask "Who is the author of haiku.rag?" --deep --cite
+
+# Deep QA with verbose output
+haiku-rag ask "Who is the author of haiku.rag?" --deep --verbose
+
 # Multi‑agent research (iterative plan/search/evaluate)
 haiku-rag research \
   "What are the main drivers and trends of global temperature anomalies since 1990?" \
@@ -89,24 +99,23 @@ haiku-rag research \
 # Rebuild database (re-chunk and re-embed all documents)
 haiku-rag rebuild
 
-# Migrate from SQLite to LanceDB
-haiku-rag migrate old_database.sqlite
-
 # Start server with file monitoring
-export MONITOR_DIRECTORIES="/path/to/docs"
-haiku-rag serve
+haiku-rag serve --monitor
 ```
 
+To customize settings, create a `haiku.rag.yaml` config file (see [Configuration](https://ggozad.github.io/haiku.rag/configuration/)).
+
 ## Python Usage
 
 ```python
 from haiku.rag.client import HaikuRAG
-from haiku.rag.research import (
+from haiku.rag.config import Config
+from haiku.rag.graph.agui import stream_graph
+from haiku.rag.graph.research import (
     ResearchContext,
     ResearchDeps,
     ResearchState,
     build_research_graph,
-    PlanNode,
 )
 
 async with HaikuRAG("database.lancedb") as client:
@@ -127,23 +136,31 @@ async with HaikuRAG("database.lancedb") as client:
     print(answer)
 
     # Multi‑agent research pipeline (Plan → Search → Evaluate → Synthesize)
-    graph = build_research_graph()
-    state = ResearchState(
-        question=(
-            "What are the main drivers and trends of global temperature "
-            "anomalies since 1990?"
-        ),
-        context=ResearchContext(original_question="…"),
-        max_iterations=2,
-        confidence_threshold=0.8,
-        max_concurrency=3,
+    # Graph settings (provider, model, max_iterations, etc.) come from config
+    graph = build_research_graph(config=Config)
+    question = (
+        "What are the main drivers and trends of global temperature "
+        "anomalies since 1990?"
     )
+    context = ResearchContext(original_question=question)
+    state = ResearchState.from_config(context=context, config=Config)
     deps = ResearchDeps(client=client)
-    start = PlanNode(provider=None, model=None)
-    result = await graph.run(start, state=state, deps=deps)
-    report = result.output
+
+    # Blocking run (final result only)
+    report = await graph.run(state=state, deps=deps)
     print(report.title)
-    print(report.executive_summary)
+
+    # Streaming progress (AG-UI events)
+    async for event in stream_graph(graph, state, deps):
+        if event["type"] == "STEP_STARTED":
+            print(f"Starting step: {event['stepName']}")
+        elif event["type"] == "ACTIVITY_SNAPSHOT":
+            print(f"  {event['content']}")
+        elif event["type"] == "RUN_FINISHED":
+            print("\nResearch complete!\n")
+            result = event["result"]
+            print(result["title"])
+            print(result["executive_summary"])
 ```
 
 ## MCP Server
@@ -156,13 +173,24 @@ haiku-rag serve --stdio
 
 Provides tools for document management and search directly in your AI assistant.
 
+## Examples
+
+See the [examples directory](examples/) for working examples:
+
+- **[Interactive Research Assistant](examples/ag-ui-research/)** - Full-stack research assistant with Pydantic AI and AG-UI featuring human-in-the-loop approval and real-time state synchronization
+- **[Docker Setup](examples/docker/)** - Complete Docker deployment with file monitoring and MCP server
+- **[A2A Server](examples/a2a-server/)** - Self-contained A2A protocol server package with conversational agent interface
+
 ## Documentation
 
 Full documentation at: https://ggozad.github.io/haiku.rag/
 
 - [Installation](https://ggozad.github.io/haiku.rag/installation/) - Provider setup
-- [Configuration](https://ggozad.github.io/haiku.rag/configuration/) - Environment variables
+- [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
 - [Agents](https://ggozad.github.io/haiku.rag/agents/) - QA agent and multi-agent research
+- [MCP Server](https://ggozad.github.io/haiku.rag/mcp/) - Model Context Protocol integration
 - [Benchmarks](https://ggozad.github.io/haiku.rag/benchmarks/) - Performance Benchmarks
+
+mcp-name: io.github.ggozad/haiku-rag

haiku_rag-0.19.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+README.md,sha256=3Y4bUYJ-gnWPH_zeCdHK_NZcej9JvA2JdnKoSY0eu6o,6377
+haiku_rag-0.19.3.dist-info/METADATA,sha256=BUpAqkIkKsZTQ1mGopYaSKlvlUC6cRBQtpvLfz-5h5M,7338
+haiku_rag-0.19.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+haiku_rag-0.19.3.dist-info/entry_points.txt,sha256=G1U3nAkNd5YDYd4v0tuYFbriz0i-JheCsFuT9kIoGCI,48
+haiku_rag-0.19.3.dist-info/licenses/LICENSE,sha256=eXZrWjSk9PwYFNK9yUczl3oPl95Z4V9UXH7bPN46iPo,1065
+haiku_rag-0.19.3.dist-info/RECORD,,

{haiku_rag-0.10.2.dist-info → haiku_rag-0.19.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any