API Reference — Overview

On this page

Top-level exports (cache.__all__)
Supporting types not in __all__
Module responsibility summary

This section documents every public class, function, dataclass, and enum exported from the cache package (i.e. everything listed in cache.__all__ in cache/__init__.py, plus their directly-relevant supporting types). Names beginning with _ are private implementation details and are described only where they materially affect the behavior of a public API (e.g. CacheManager._run_sync, TenantManager._get_state).

Top-level exports (`cache.all`)

Name	Kind	Module	Page
`CacheEntry`	dataclass	`cache.cache_entry`	cache_entry.md
`CacheStrategy`	enum	`cache.cache_strategies`	multi_level_cache.md
`MultiLevelCache`	class	`cache.multi_level_cache`	multi_level_cache.md
`CacheMetrics`	dataclass	`cache.cache_metrics`	cache_metrics.md
`CacheConfig`	dataclass	`cache.config_cache`	config_cache.md
`EmbeddingIndex`	class	`cache.embedding_index`	embedding_index.md
`EmbeddingProvider`	enum	`cache.config_cache`	config_cache.md
`OllamaEmbeddingProvider`	class	`cache.embedding_index`	embedding_index.md
`OpenAIEmbeddingProvider`	class	`cache.embedding_index`	embedding_index.md
`HuggingFaceEmbeddingProvider`	class	`cache.embedding_index`	embedding_index.md
`EmbeddingConfig`	dataclass	`cache.config_cache`	config_cache.md
`CostModel`	class	`cache.cost_model`	cost_model.md
`CacheMetricsCollector`	class	`cache.metrics`	metrics.md
`RollingCounter`	class	`cache.metrics`	metrics.md
`IntelligentCacheEntry`	dataclass	`cache.models`	models.md
`TenantQuotaState`	dataclass	`cache.models`	models.md
`QueryNormalizer`	class	`cache.normalization`	normalization.md
`NormalizationConfig`	class	`cache.normalization`	normalization.md
`CachePolicyLearner`	class	`cache.policy_learner`	policy_learner.md
`SecurityGuard`	class	`cache.security`	security.md
`SecurityViolation`	exception	`cache.security`	security.md
`SecurityConfig`	dataclass	`cache.config_cache`	config_cache.md
`CostConfig`	dataclass	`cache.config_cache`	config_cache.md
`TenantManager`	class	`cache.tenant_manager`	tenant_manager.md
`TenantConfig`	dataclass	`cache.config_cache`	config_cache.md
`TenantRegistration`	dataclass	`cache.tenant_manager`	tenant_manager.md
`CacheManager`	class	`cache.cache_manager`	cache_manager.md
`CacheLookupResult`	dataclass	`cache.models`	models.md
`CachedEmbedder`	class	`cache.embedding_index`	embedding_index.md
`RedisStorage`	class	`cache.storage.redis`	storage/redis.md
`SQLiteStorage`	class	`cache.storage.sqlite`	storage/sqlite.md
`MemoryStorage`	class	`cache.storage.storage_memory`	storage/memory.md
`build_storage`	function	`cache.storage.factury_fun`	storage/factory.md
`RLConfig`	dataclass	`cache.config_cache`	config_cache.md
`SemanticConfig`	dataclass	`cache.config_cache`	config_cache.md
`StorageBackend`	enum	`cache.config_cache`	config_cache.md
`FeedbackSignal`	dataclass	`cache.policy_learner`	policy_learner.md
`RoutingDecision`	enum	`cache.config_cache`	config_cache.md
`RedisConfig`	dataclass	`cache.config_cache`	config_cache.md
`PerformanceConfig`	dataclass	`cache.config_cache`	config_cache.md
`DecisionEngine`	class	`cache.cost_model`	cost_model.md
`OperationCostEstimate`	dataclass	`cache.cost_model`	cost_model.md
`QuotaExceeded`	exception	`cache.tenant_manager`	tenant_manager.md

[!NOTE] Names imported but not re-exported cache/__init__.py also imports SQLiteConfig from config_cache but does not include it in __all__. It remains importable as cache.SQLiteConfig (or from zerda.cache.config_cache import SQLiteConfig) — see config_cache.md.

Supporting types not in `all`

These are used by / returned from the public API above and are documented alongside their owning module, but are not themselves exported from the top-level package:

Name	Module	Notes
`BanditArm`	`cache.models`	Field of `IntelligentCacheEntry.bandit_arm`
`CostRecord`	`cache.models`	Field of `IntelligentCacheEntry.cost_record`
`BaseStorage`	`cache.storage.base_storage`	Abstract base class; importable as `cache.storage.BaseStorage`
`BaseEmbeddingProvider`	`cache.embedding_index`	Abstract base class for all embedding providers
`MockEmbeddingProvider`	`cache.embedding_index`	Default provider (`EmbeddingProvider.MOCK`)
`EvictionCandidate`	`cache.policy_learner`	Return element type of `CachePolicyLearner.eviction_ranking`
`RoutingResult`	`cache.cost_model`	Return type of `DecisionEngine.decide`
`LatencyHistogram`	`cache.metrics`	Used internally by `CacheMetricsCollector`
`EvictionPolicy`	`cache.config_cache`	Type of `EvictionConfig.policy`

Module responsibility summary

Module	Type of component	Responsibility
`cache_manager`	Orchestrator	Ties every other subsystem together into `get`/`put`/`feedback`
`multi_level_cache`	Standalone cache	Generic 3-tier memory/memory/disk cache
`models`	Data models	Entry, lookup result, bandit arm, cost record, tenant quota state
`cache_entry`	Data model	Simple entry type for `MultiLevelCache`
`config_cache`	Configuration	All dataclasses/enums controlling behavior
`normalization`	Pipeline stage	Canonicalizes raw queries before hashing/embedding
`embedding_index`	Pipeline stage	Text → vector, vector similarity search
`cost_model`	Pipeline stage	USD cost estimation and cache-vs-LLM routing
`policy_learner`	Pipeline stage	Bayesian bandit ranking, eviction scoring, decay
`tenant_manager`	Pipeline stage	Multi-tenant quotas and isolation
`security`	Pipeline stage	Injection detection, PII scrubbing, integrity checks
`metrics`	Observability	Central metrics collector for the pipeline
`cache_metrics`	Observability	Simple hit-rate counters for `MultiLevelCache`
`storage`	Persistence	Pluggable backends behind a common `BaseStorage` contract

API Reference — Overview

Top-level exports (cache.__all__)

Supporting types not in __all__

Module responsibility summary

Related pages

Top-level exports (`cache.all`)

Supporting types not in `all`