localmind-sdk 1.0.0

Python SDK for LocalMind API - chat, documents, semantic search, and conversation management

LocalMind SDK for Python

Python SDK for integrating with the LocalMind API. Provides a simple client for chat, document management, semantic search, and conversation operations.

Requirements

• Python 3.9+
• requests library

Installation

pip install localmind-sdk

Install from source

cd localmind-sdk-python
pip install -e .

Quick Start

from localmind import LocalMindClient

# Create client (defaults to http://localhost:8080/api/v1)
client = LocalMindClient()

# Authenticate (if auth is configured on the server)
client.login("your-password")

# Simple chat
response = client.chat("Riassumi il documento...")
print(response["content"])

# Chat with provider/model selection
response = client.chat("Explain this concept", provider="OLLAMA", model="llama3")

# Chat with RAG enabled
response = client.chat(
    "What does the deployment guide say?",
    enable_rag=True,
    temperature=0.3,
)
print(response["content"])
if response.get("ragSources"):
    for source in response["ragSources"]:
        print(f"  Source: {source['filename']} (score: {source['score']:.2f})")

Document Management

# List all documents
documents = client.documents.list()

# Upload a document
doc = client.documents.upload("/path/to/report.pdf")
print(f"Uploaded: {doc['filename']} (status: {doc['status']})")

# Get document details
doc = client.documents.get("document-id")

# Delete a document
client.documents.delete("document-id")

Semantic Search

# Search with default topK (5)
results = client.search("deployment procedure")

# Search with custom topK
results = client.search("security policy", top_k=10)
for result in results:
    print(f"{result['score']:.2f} - {result['filename']}: {result['content'][:100]}")

Conversation Management

# List all conversations
conversations = client.conversations.list()

# List by tag
tagged = client.conversations.list(tag="project-x")

# Get full conversation with messages
convo = client.conversations.get("conversation-id")
for msg in convo["messages"]:
    print(f"{msg['role']}: {msg['content']}")

# Continue a conversation
reply = client.chat("Follow-up question", conversation_id=convo["id"])

# Rename a conversation
client.conversations.rename("conversation-id", "New Title")

# Update system prompt
client.conversations.update_system_prompt("conversation-id", "You are a helpful assistant.")

# Tag management
client.conversations.add_tag("conversation-id", "important")
client.conversations.remove_tag("conversation-id", "old-tag")

# Export to PDF
pdf_bytes = client.conversations.export("conversation-id", format="pdf")
with open("conversation.pdf", "wb") as f:
    f.write(pdf_bytes)

# Delete a conversation
client.conversations.delete("conversation-id")

Health Check

health = client.health()
print(f"Status: {health['status']}")          # UP or DEGRADED
print(f"Services: {health['services']}")      # {"api": "UP", "ollama": "UP"}

Configuration

client = LocalMindClient(
    base_url="http://my-server:8080/api/v1",   # Custom server URL
    auth_token="pre-existing-jwt-token",        # Pre-set auth token
    timeout=300,                                 # Request timeout in seconds (default: 120)
)

Error Handling

All API errors raise LocalMindException with the HTTP status code and response body:

from localmind import LocalMindClient, LocalMindException

client = LocalMindClient()
try:
    client.chat("Hello")
except LocalMindException as e:
    print(f"Status: {e.status_code}")          # e.g. 401, 500
    print(f"Body: {e.response_body}")          # Raw server response
    print(f"Message: {e}")

License

MIT