116 lines
2.4 KiB
Markdown
116 lines
2.4 KiB
Markdown
# Python API
|
|
|
|
Use `haiku.rag` directly in your Python applications.
|
|
|
|
## Basic Usage
|
|
|
|
```python
|
|
from pathlib import Path
|
|
from haiku.rag.client import HaikuRAG
|
|
|
|
# Use as async context manager (recommended)
|
|
async with HaikuRAG("path/to/database.db") as client:
|
|
# Your code here
|
|
pass
|
|
```
|
|
|
|
## Document Management
|
|
|
|
### Creating Documents
|
|
|
|
From text:
|
|
```python
|
|
doc = await client.create_document(
|
|
content="Your document content here",
|
|
uri="doc://example",
|
|
metadata={"source": "manual", "topic": "example"}
|
|
)
|
|
```
|
|
|
|
From file:
|
|
```python
|
|
doc = await client.create_document_from_source("path/to/document.pdf")
|
|
```
|
|
|
|
From URL:
|
|
```python
|
|
doc = await client.create_document_from_source("https://example.com/article.html")
|
|
```
|
|
|
|
### Retrieving Documents
|
|
|
|
By ID:
|
|
```python
|
|
doc = await client.get_document_by_id(1)
|
|
```
|
|
|
|
By URI:
|
|
```python
|
|
doc = await client.get_document_by_uri("file:///path/to/document.pdf")
|
|
```
|
|
|
|
List all documents:
|
|
```python
|
|
docs = await client.list_documents(limit=10, offset=0)
|
|
```
|
|
|
|
### Updating Documents
|
|
|
|
```python
|
|
doc.content = "Updated content"
|
|
await client.update_document(doc)
|
|
```
|
|
|
|
### Deleting Documents
|
|
|
|
```python
|
|
await client.delete_document(doc.id)
|
|
```
|
|
|
|
### Rebuilding the Database
|
|
|
|
```python
|
|
async for doc_id in client.rebuild_database():
|
|
print(f"Processed document {doc_id}")
|
|
```
|
|
|
|
## Searching Documents
|
|
|
|
Basic search:
|
|
```python
|
|
results = await client.search("machine learning algorithms", limit=5)
|
|
for chunk, score in results:
|
|
print(f"Score: {score:.3f}")
|
|
print(f"Content: {chunk.content}")
|
|
print(f"Document ID: {chunk.document_id}")
|
|
```
|
|
|
|
With options:
|
|
```python
|
|
results = await client.search(
|
|
query="machine learning",
|
|
limit=5, # Maximum results to return
|
|
k=60 # RRF parameter for reciprocal rank fusion
|
|
)
|
|
|
|
# Process results
|
|
for chunk, relevance_score in results:
|
|
print(f"Relevance: {relevance_score:.3f}")
|
|
print(f"Content: {chunk.content}")
|
|
print(f"From document: {chunk.document_id}")
|
|
print(f"Document URI: {chunk.document_uri}")
|
|
print(f"Document metadata: {chunk.document_meta}")
|
|
```
|
|
|
|
## Question Answering
|
|
|
|
Ask questions about your documents:
|
|
|
|
```python
|
|
answer = await client.ask("Who is the author of haiku.rag?")
|
|
print(answer)
|
|
```
|
|
|
|
The QA agent will search your documents for relevant information and use the configured LLM to generate a comprehensive answer.
|
|
|
|
The QA provider and model can be configured via environment variables (see [Configuration](configuration.md)).
|