laive-sdk 0.1.0

Python SDK for the Laive RAG API

Laive Python SDK

The Laive Python SDK provides a simple and convenient way to interact with the Laive RAG (Retrieval-Augmented Generation) API. This library allows you to easily upload documents, create vaults, and perform intelligent queries on your document collections.

Ressources

• laive Platform
• laive Python SDK
• laive Python SDK Cookbooks
• laive API Documentation
• laive API Reference

This SDK is still in beta. Please report any issues or feedback to [e-mail] or open an issue on GitHub

Installation

# Install via pip
pip install laive-sdk

# Or install from source
git clone https://github.com/laive/Python-SDK.git
cd Python-SDK
pip install -e .

Quick Start

import os
from laive import LaiveClient

# Initialize the client with your API key
client = LaiveClient(api_key=os.getenv("LAIVE_API_KEY"))

# Query a vault
results = client.query(
    query="What is the best way to implement RAG?",
    vault_id=123,
    top_k=5
)

print(f"Found {len(results.sources)} relevant documents")

Authentication

Set your API key as an environment variable:

export LAIVE_API_KEY="your_api_key_here"

Or pass it directly when creating the client:

client = LaiveClient(api_key="your_api_key_here")

API Reference

Client Initialization

from laive import LaiveClient

client = LaiveClient(
    api_key="your_api_key",
)

Query Documents

Retrieve relevant documents from a vault based on a search query.

response = client.query(
    query="What is retrieval augmented generation?",
    vault_id=123,  # Optional, if not provided searches across all accessible vaults
    top_k=4  # Optional, defaults to 4
)

# Access results
for source in response.sources:
    print(f"Document: {source['source_name']}")
    print(f"Content: {source['page_content'][:100]}...")
    print(f"Relevance score: {source['score']}")

Upload Files

Upload one or more files to a vault.

response = client.upload_files(
    files=["path/to/document1.pdf", "path/to/document2.docx"],
    source_names=["Document 1", "Document 2"],
    vault_id=123,
    source_urls=["https://example.com/doc1", "https://example.com/doc2"]  # Optional
)

print(f"Started processing {response.files_processed} files")
print(f"Task IDs: {response.task_ids}")

Check Task Status

Check the status of a file processing task.

task_status = client.get_task_status(task_id="task_id_from_upload_response")
print(f"Task state: {task_status['state']}")
print(f"Status: {task_status['status']}")

Jupyter Notebooks

Check out the notebooks/ directory for interactive Jupyter notebooks:

• 📓 notebooks/simple_query_example.ipynb - Simple querying example in notebook format
• 📚 notebooks/vault_management_workflow.ipynb - Complete vault management workflow

Development

Installing from Source

git clone https://github.com/laive/Python-SDK.git
cd Python-SDK
pip install -e .

Running Notebooks

# Copy environment template
cp .env.example .env
# Edit .env with your API key

# Install Jupyter and run notebooks
pip install jupyter
export LAIVE_API_KEY="your_api_key_here"
cd notebooks
jupyter notebook