Fix stale docs
This commit is contained in:
parent
339ff15018
commit
69083c8cb4
10 changed files with 11 additions and 29 deletions
|
|
@ -3,9 +3,10 @@
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- **RAG skill** (`haiku.rag.skills.rag`): haiku.skills integration with search, list_documents, get_document, ask, analyze, and research tools plus managed `RAGState`
|
- **RAG skill** (`haiku.rag.skills.rag`): haiku.skills integration with search, list_documents, get_document, ask, and research tools plus managed `RAGState`
|
||||||
|
- **RLM skill** (`haiku.rag.skills.rlm`): haiku.skills integration with analyze tool for computational analysis via code execution
|
||||||
- **`HaikuRAG.research()`**: Client method for multi-agent research
|
- **`HaikuRAG.research()`**: Client method for multi-agent research
|
||||||
- **haiku.skills entry point**: `rag = "haiku.rag.skills.rag:create_skill"`
|
- **haiku.skills entry points**: `rag = "haiku.rag.skills.rag:create_skill"`, `rag-rlm = "haiku.rag.skills.rlm:create_skill"`
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -137,7 +137,7 @@ Full documentation at: https://ggozad.github.io/haiku.rag/
|
||||||
- [Configuration](https://ggozad.github.io/haiku.rag/configuration/) - YAML configuration
|
- [Configuration](https://ggozad.github.io/haiku.rag/configuration/) - YAML configuration
|
||||||
- [CLI](https://ggozad.github.io/haiku.rag/cli/) - Command reference
|
- [CLI](https://ggozad.github.io/haiku.rag/cli/) - Command reference
|
||||||
- [Python API](https://ggozad.github.io/haiku.rag/python/) - Complete API docs
|
- [Python API](https://ggozad.github.io/haiku.rag/python/) - Complete API docs
|
||||||
- [Agents](https://ggozad.github.io/haiku.rag/agents/) - QA, chat, and research agents
|
- [Agents](https://ggozad.github.io/haiku.rag/agents/) - QA and research agents
|
||||||
- [RLM Agent](https://ggozad.github.io/haiku.rag/rlm/) - Complex analytical tasks via code execution
|
- [RLM Agent](https://ggozad.github.io/haiku.rag/rlm/) - Complex analytical tasks via code execution
|
||||||
- [Applications](https://ggozad.github.io/haiku.rag/apps/) - Chat TUI, web app, and inspector
|
- [Applications](https://ggozad.github.io/haiku.rag/apps/) - Chat TUI, web app, and inspector
|
||||||
- [Server](https://ggozad.github.io/haiku.rag/server/) - File monitoring and MCP
|
- [Server](https://ggozad.github.io/haiku.rag/server/) - File monitoring and MCP
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@ A conversational RAG interface built with [CopilotKit](https://copilotkit.ai/) a
|
||||||
|
|
||||||
### haiku.rag.yaml
|
### haiku.rag.yaml
|
||||||
|
|
||||||
Configure the chat agent's LLM, embeddings, and search settings:
|
Configure the LLM, embeddings, and search settings:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
qa:
|
qa:
|
||||||
|
|
@ -100,7 +100,7 @@ docker compose -f docker-compose.dev.yml up -d --build
|
||||||
|
|
||||||
## Chat Capabilities
|
## Chat Capabilities
|
||||||
|
|
||||||
The chat agent can:
|
The chat can:
|
||||||
|
|
||||||
- **Search** your documents with hybrid vector + full-text search
|
- **Search** your documents with hybrid vector + full-text search
|
||||||
- **Answer questions** with citations from your knowledge base
|
- **Answer questions** with citations from your knowledge base
|
||||||
|
|
|
||||||
17
docs/cli.md
17
docs/cli.md
|
|
@ -164,11 +164,6 @@ haiku-rag chat
|
||||||
haiku-rag chat --db /path/to/database.lancedb
|
haiku-rag chat --db /path/to/database.lancedb
|
||||||
```
|
```
|
||||||
|
|
||||||
Provide initial background context for the conversation:
|
|
||||||
```bash
|
|
||||||
haiku-rag chat --initial-context "Focus on Python programming concepts"
|
|
||||||
```
|
|
||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
Requires the `tui` extra: `pip install haiku.rag-slim[tui]` (included in full `haiku.rag` package)
|
Requires the `tui` extra: `pip install haiku.rag-slim[tui]` (included in full `haiku.rag` package)
|
||||||
|
|
||||||
|
|
@ -178,18 +173,6 @@ The chat interface provides:
|
||||||
- Expandable citations with source metadata
|
- Expandable citations with source metadata
|
||||||
- Session memory for context-aware follow-up questions
|
- Session memory for context-aware follow-up questions
|
||||||
- Visual grounding to inspect chunk source locations
|
- Visual grounding to inspect chunk source locations
|
||||||
- Initial context that can be edited before the first message
|
|
||||||
|
|
||||||
**Initial Context Behavior:**
|
|
||||||
|
|
||||||
- Edit initial context via command palette before sending your first message
|
|
||||||
- Once you send a message, initial context becomes read-only
|
|
||||||
- The agent uses initial context as a starting point for session summarization
|
|
||||||
- Clearing chat resets to the CLI-provided context and unlocks editing
|
|
||||||
|
|
||||||
Flags:
|
|
||||||
|
|
||||||
- `--initial-context`: Initial background context for the conversation (editable until first message)
|
|
||||||
|
|
||||||
See [Applications](apps.md#chat-tui) for keyboard shortcuts and features.
|
See [Applications](apps.md#chat-tui) for keyboard shortcuts and features.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -448,4 +448,4 @@ agent = Agent(
|
||||||
result = await agent.run("What are the main findings?")
|
result = await agent.run("What are the main findings?")
|
||||||
```
|
```
|
||||||
|
|
||||||
See [Tools & Skills](tools.md) for the full API reference.
|
See [Toolsets](tools.md) for the full API reference.
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@ class IterativePlanResult(BaseModel):
|
||||||
class Citation(BaseModel):
|
class Citation(BaseModel):
|
||||||
"""Resolved citation with full metadata for display/visual grounding.
|
"""Resolved citation with full metadata for display/visual grounding.
|
||||||
|
|
||||||
Used by both research graph and chat agent. The optional index field
|
Used by research graph and chat applications. The optional index field
|
||||||
supports UI display ordering in chat contexts.
|
supports UI display ordering in chat contexts.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -476,8 +476,6 @@ class HaikuRAGApp: # pragma: no cover
|
||||||
self.console.print(f"• {finding}")
|
self.console.print(f"• {finding}")
|
||||||
self.console.print()
|
self.console.print()
|
||||||
|
|
||||||
# (Themes section removed)
|
|
||||||
|
|
||||||
# Conclusions
|
# Conclusions
|
||||||
if report.conclusions:
|
if report.conclusions:
|
||||||
self.console.print("[bold cyan]Conclusions:[/bold cyan]")
|
self.console.print("[bold cyan]Conclusions:[/bold cyan]")
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ def run_chat(
|
||||||
db_path: Path to the LanceDB database. If None, uses default from config.
|
db_path: Path to the LanceDB database. If None, uses default from config.
|
||||||
read_only: Whether to open the database in read-only mode.
|
read_only: Whether to open the database in read-only mode.
|
||||||
before: Query database as it existed before this datetime.
|
before: Query database as it existed before this datetime.
|
||||||
model: Model to use for the chat agent.
|
model: Model to use for the chat.
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
from haiku.rag.chat.app import ChatApp
|
from haiku.rag.chat.app import ChatApp
|
||||||
|
|
|
||||||
|
|
@ -623,7 +623,7 @@ def chat( # pragma: no cover
|
||||||
model: str | None = typer.Option(
|
model: str | None = typer.Option(
|
||||||
None,
|
None,
|
||||||
"--model",
|
"--model",
|
||||||
help="Model to use for the chat agent (e.g. openai:gpt-4o)",
|
help="Model to use for the chat (e.g. openai:gpt-4o)",
|
||||||
),
|
),
|
||||||
):
|
):
|
||||||
"""Launch the chat TUI for conversational RAG."""
|
"""Launch the chat TUI for conversational RAG."""
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ class TestCitation:
|
||||||
assert citation.index is None
|
assert citation.index is None
|
||||||
|
|
||||||
def test_citation_with_index(self):
|
def test_citation_with_index(self):
|
||||||
"""Test Citation can be created with index (chat agent use case)."""
|
"""Test Citation can be created with index (chat use case)."""
|
||||||
citation = Citation(
|
citation = Citation(
|
||||||
index=1,
|
index=1,
|
||||||
document_id="doc-1",
|
document_id="doc-1",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue