Core API Reference¶
effero.core
¶
Cognition core: orchestrator/planner, memory, and model router.
This is the "brain" layer described in the project README's Architecture section. Submodules:
- agent -- the plan -> act -> observe -> replan loop
- memory -- working / episodic / semantic memory
- planner -- task decomposition and replanning
- router -- routes LLM calls to a local or cloud backend
EventBus
¶
High-performance asynchronous pub/sub event bus with compiled pattern routing.
Source code in src/effero/core/event_bus.py
subscribe(topic_pattern, handler)
¶
Subscribe handler to exact topic or wildcard pattern.
Source code in src/effero/core/event_bus.py
publish(event)
¶
Publish event and dispatch asynchronously to matched subscribers.
Source code in src/effero/core/event_bus.py
get_history(topic_pattern='*', limit=100)
¶
Retrieve recent chronological history filtered by topic.
Source code in src/effero/core/event_bus.py
EpisodicMemory
¶
Source code in src/effero/core/memory/episodic.py
load_history(limit=100)
¶
Load the most recent episodic events from disk without reading the full file into RAM.
Source code in src/effero/core/memory/episodic.py
SemanticMemory
¶
Vector-store backed semantic recall memory with spatial dimension indexing.
Stores knowledge chunks, actions, and observations, enabling nearest-neighbor semantic search to retrieve contextually relevant memories for planning.
Source code in src/effero/core/memory/semantic.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | |
store(text, metadata=None, record_id=None)
¶
Store a text snippet and its metadata in semantic vector memory.
Source code in src/effero/core/memory/semantic.py
search(query, top_k=5, min_score=0.0, filter_metadata=None)
¶
Search memory for records most similar to the query.
Source code in src/effero/core/memory/semantic.py
delete(record_id)
¶
Delete a record by ID.
Source code in src/effero/core/memory/semantic.py
clear()
¶
Clear all stored semantic memories.
Source code in src/effero/core/memory/semantic.py
count()
¶
save(path=None)
¶
Persist memory records to JSON file.
Source code in src/effero/core/memory/semantic.py
load(path=None)
¶
Load memory records from JSON file.
Source code in src/effero/core/memory/semantic.py
WorkingMemory
dataclass
¶
Source code in src/effero/core/memory/working.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
record_metric(metric_name, value, timestamp=None, max_capacity=500)
¶
Append a timestamped observation to named telemetry stream.
Source code in src/effero/core/memory/working.py
get_latest_metric(metric_name)
¶
Retrieve most recent observation for a named telemetry metric.
Source code in src/effero/core/memory/working.py
get_metric_series(metric_name, last_seconds=None)
¶
Retrieve chronological (timestamp, value) observations for a named metric.
Source code in src/effero/core/memory/working.py
interpolate_metric(metric_name, timestamp)
¶
Estimate numeric scalar value at specific historical timestamp.
Source code in src/effero/core/memory/working.py
rolling_metric(metric_name, seconds)
¶
Return a rolling window statistical view for a named metric.
Source code in src/effero/core/memory/working.py
effero.core.router.base
¶
Base interface for LLM backends.
LLMRequest
dataclass
¶
A request to an LLM backend.
Source code in src/effero/core/router/base.py
ToolCall
dataclass
¶
LLMResponse
dataclass
¶
A response from an LLM backend.
Source code in src/effero/core/router/base.py
LLMBackend
¶
Bases: ABC
Abstract base class for LLM backends.