Semcache Python SDK

Installation

pip install semcache

Quick Start

from semcache import Semcache
# Initialize the client
client = Semcache(base_url="http://localhost:8080")
# Store a key-data pair
client.put("What is the capital of France?", "Paris")
# Retrieve data by semantic similarity
response = client.get("What's the capital city of France?")
print(response) # "Paris"

docker run -p 8080:8080 ghcr.io/sensoris/semcache:latest

Configuration

client = Semcache(
 base_url="http://localhost:8080", # Semcache server URL
 timeout=30, # Request timeout in seconds
)

Usage Examples

Basic Usage

from semcache import Semcache
# Create a client instance
client = Semcache()
# Store some key-data pairs
client.put("What is Python?", "Python is a high-level programming language")
client.put("What is machine learning?", "Machine learning is a subset of AI that enables systems to learn from data")
# Retrieve data - exact match not required
response = client.get("Tell me about Python")
print(response) # "Python is a high-level programming language"

Error Handling

from semcache import Semcache, SemcacheConnectionError, SemcacheTimeoutError
client = Semcache(base_url="http://localhost:8080", timeout=5)
try:
 client.put("test query", "test response")
except SemcacheConnectionError:
 print("Failed to connect to Semcache server")
except SemcacheTimeoutError:
 print("Request timed out")

API Reference

Semcache(base_url="http://localhost:8080", timeout=30)

put(key: str, data: str) -> None

get(key: str) -> Optional[str]

Exceptions

Development

Setup Development Environment

# Create a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install development dependencies
pip install -e ".[dev]"

Run Tests

pytest

Format Code

black src tests

License

Contributing