API Reference¶
Complete reference for the HyperBinder Python SDK.
Overview¶
The SDK is organized into these areas:
| Module | Purpose |
|---|---|
| Client | Main entry points (HyperBinder, AsyncHyperBinder) |
| Collection | Fluent API for collection operations |
| Compose | Schema system (Molecules, Compounds, Fields) |
| Semantic Cache | LLM response caching with semantic matching |
| Models | Result types (SearchResult, Context, etc.) |
| Exceptions | Error handling |
Quick Links¶
Client¶
- HyperBinder - Synchronous client
- AsyncHyperBinder - Async client
- Collection - Collection fluent API
Compose (Schema System)¶
- Molecules - Pair, Triple, Bundle, etc.
- Compounds - KnowledgeGraph, Catalog, etc.
- Fields & Encoding - Field configuration
- Query Builder - ComposeQuery methods
Semantic Cache¶
- SemanticCache - LLM response caching with context isolation
Results & Errors¶
- Models - SearchResult, Context, Answer, etc.
- Exceptions - Error handling
Import Patterns¶
# Main client
from hybi import HyperBinder, AsyncHyperBinder
# Result types
from hybi import SearchResult, Context, Answer
# Compose schemas
from hybi.compose import Triple, Field, Encoding
from hybi.compose import KnowledgeGraph, Catalog
# Semantic Cache
from hyperbinder import SemanticCache, CacheHit
# Exceptions
from hybi import HyperBinderError, CollectionNotFoundError