memoir package¶
memoir ¶
Memoir High-performance semantic memory system for AI agents.
ClassificationResult ¶
Bases: BaseModel
Result of semantic classification.
Source code in src/memoir/classifier/semantic.py
SemanticClassifier ¶
Classifies memories into semantic taxonomy paths. Optimized for low-latency classification with caching.
Source code in src/memoir/classifier/semantic.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 | |
__init__ ¶
__init__(llm: Any | None = None, taxonomy: TaxonomyInterface | None = None, cache_size: int = DEFAULT_CACHE_SIZE, use_examples: bool = True, fallback_path: str | None = None)
Initialize the semantic classifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
llm
|
Any | None
|
Language model for classification (optional, will use default) |
None
|
taxonomy
|
TaxonomyInterface | None
|
Taxonomy instance implementing TaxonomyInterface If None, uses default SemanticTaxonomy |
None
|
cache_size
|
int
|
Size of the classification cache |
DEFAULT_CACHE_SIZE
|
use_examples
|
bool
|
Whether to include examples in prompts |
True
|
fallback_path
|
str | None
|
Custom fallback path when classification fails |
None
|
Source code in src/memoir/classifier/semantic.py
classify_async
async
¶
classify_async(memory_content: str, context: dict | None = None, use_cache: bool = True) -> ClassificationResult
Classify memory content into taxonomy path asynchronously.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
memory_content
|
str
|
The memory content to classify |
required |
context
|
dict | None
|
Optional context information |
None
|
use_cache
|
bool
|
Whether to use cached results |
True
|
Returns:
| Type | Description |
|---|---|
ClassificationResult
|
ClassificationResult with path and metadata |
Source code in src/memoir/classifier/semantic.py
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 | |
classify ¶
classify(memory_content: str, context: dict | None = None, use_cache: bool = True) -> ClassificationResult
Synchronous version of classify_async.
Source code in src/memoir/classifier/semantic.py
batch_classify ¶
Classify multiple memories in batch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
memories
|
list[str]
|
List of memory contents to classify |
required |
context
|
dict | None
|
Optional shared context |
None
|
Returns:
| Type | Description |
|---|---|
list[ClassificationResult]
|
List of ClassificationResults |
Source code in src/memoir/classifier/semantic.py
get_statistics ¶
Get classifier statistics.
Source code in src/memoir/classifier/semantic.py
LangGraphMemoryStore ¶
Bases: BaseStore, BaseIntegration
LangGraph-compatible memory store implementation using Memoir.
This adapter allows LangGraph agents to use Memoir's Git-like versioned memory system as a drop-in replacement for the standard memory store.
Source code in src/memoir/integration/langgraph/memory_store.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 | |
__init__ ¶
Initialize the LangGraph memory store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
MemoryConfig | None
|
Memory configuration settings |
None
|
llm
|
Any | None
|
Optional LLM instance for intelligent features |
None
|
Source code in src/memoir/integration/langgraph/memory_store.py
initialize
async
¶
Initialize the store for async operations.
Source code in src/memoir/integration/langgraph/memory_store.py
close
async
¶
__exit__ ¶
abatch
async
¶
Execute a batch of operations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ops
|
Sequence[Op]
|
Sequence of operations to execute |
required |
Returns:
| Type | Description |
|---|---|
list[Result]
|
List of operation results |
Source code in src/memoir/integration/langgraph/memory_store.py
batch ¶
aget
async
¶
Get a single item by key.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
NamespacePath
|
Namespace containing the item |
required |
key
|
str
|
Item key |
required |
Returns:
| Type | Description |
|---|---|
Item | None
|
The item if found, None otherwise |
Source code in src/memoir/integration/langgraph/memory_store.py
get ¶
asearch
async
¶
asearch(namespace: NamespacePath, *, query: str | None = None, limit: int = 10, offset: int = 0) -> list[Item]
Async search for items.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
NamespacePath
|
Namespace to search in |
required |
query
|
str | None
|
Optional search query |
None
|
limit
|
int
|
Maximum results |
10
|
offset
|
int
|
Result offset |
0
|
Returns:
| Type | Description |
|---|---|
list[Item]
|
List of matching items |
Source code in src/memoir/integration/langgraph/memory_store.py
search ¶
search(namespace: NamespacePath, *, query: str | None = None, limit: int = 10, offset: int = 0) -> list[Item]
Synchronous search (delegates to async).
Source code in src/memoir/integration/langgraph/memory_store.py
aput
async
¶
aput(namespace: NamespacePath, key: str, value: Any, metadata: dict[str, Any] | None = None) -> None
Store a single item.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
NamespacePath
|
Namespace for the item |
required |
key
|
str
|
Item key |
required |
value
|
Any
|
Item value |
required |
metadata
|
dict[str, Any] | None
|
Optional metadata |
None
|
Source code in src/memoir/integration/langgraph/memory_store.py
put ¶
Synchronous put (delegates to async).
Source code in src/memoir/integration/langgraph/memory_store.py
adelete
async
¶
Delete a single item.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
NamespacePath
|
Namespace containing the item |
required |
key
|
str
|
Item key |
required |
Source code in src/memoir/integration/langgraph/memory_store.py
delete ¶
MemoryConfig
dataclass
¶
Configuration for LangGraph memory integration.
Source code in src/memoir/integration/langgraph/types.py
to_dict ¶
Convert config to dictionary.
Source code in src/memoir/integration/langgraph/types.py
LocationMemento ¶
Manages user location data and generates geographic event summaries.
Source code in src/memoir/memento/location.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | |
__init__ ¶
apply_location_events
async
¶
apply_location_events(location_events: list[dict[str, str]], metadata: dict | None = None, namespace: str = 'default') -> None
Apply location events to the memory store.
For same-location events, retrieves existing content and merges with new event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
location_events
|
list[dict[str, str]]
|
List of location events with location and description |
required |
metadata
|
dict | None
|
Optional metadata to include with events |
None
|
namespace
|
str
|
Namespace to store location events in (default: "default") |
'default'
|
Source code in src/memoir/memento/location.py
get_location_summary
async
¶
Generate a summary of all location events.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
llm
|
Any | None
|
Optional LLM for generating narrative summaries |
None
|
namespace
|
str
|
Namespace to search for location data (default: "default") |
'default'
|
Returns:
| Type | Description |
|---|---|
str
|
String summary of location events |
Source code in src/memoir/memento/location.py
get_location_events_for_search
async
¶
Get location events relevant to a search query.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
location_query
|
str
|
Search query for locations |
required |
namespace
|
str
|
Namespace to search for location data (default: "default") |
'default'
|
Returns:
| Type | Description |
|---|---|
list[dict]
|
List of relevant location events |
Source code in src/memoir/memento/location.py
ProfileMemento ¶
Manages user profile data and generates profile summaries.
Source code in src/memoir/memento/profile.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
__init__ ¶
apply_profile_updates
async
¶
apply_profile_updates(profile_updates: list[dict[str, str]], metadata: dict | None = None, namespace: str = 'default') -> None
Apply profile updates to the memory store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
profile_updates
|
list[dict[str, str]]
|
List of profile updates with path and value |
required |
metadata
|
dict | None
|
Optional metadata to include with updates |
None
|
namespace
|
str
|
Namespace to store the profile updates in (default: "default") |
'default'
|
Source code in src/memoir/memento/profile.py
get_profile_summary
async
¶
Generate a comprehensive profile summary from stored profile data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
llm
|
Optional LLM for generating narrative summary |
None
|
|
namespace
|
str
|
Namespace to search for profile data (default: "default") |
'default'
|
Returns:
| Type | Description |
|---|---|
str
|
Profile summary string |
Source code in src/memoir/memento/profile.py
TimelineMemento ¶
Manages user timeline data and generates chronological event summaries.
Source code in src/memoir/memento/timeline.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | |
__init__ ¶
apply_timeline_events
async
¶
apply_timeline_events(timeline_events: list[dict[str, str]], metadata: dict | None = None, original_content: str | None = None, namespace: str = 'default') -> None
Apply timeline events to the memory store.
For same-day events, retrieves existing content and merges with new event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeline_events
|
list[dict[str, str]]
|
List of timeline events with date and description |
required |
metadata
|
dict | None
|
Optional metadata to include with events |
None
|
namespace
|
str
|
Namespace to store timeline events in (default: "default") |
'default'
|
Source code in src/memoir/memento/timeline.py
get_timeline_summary
async
¶
get_timeline_summary(start_date: str | None = None, end_date: str | None = None, llm=None, namespace: str = 'default') -> str
Generate a comprehensive timeline summary from stored timeline data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date
|
str | None
|
Optional start date (YYYYMMDD format) |
None
|
end_date
|
str | None
|
Optional end date (YYYYMMDD format) |
None
|
llm
|
Optional LLM for generating narrative summary |
None
|
Returns:
| Type | Description |
|---|---|
str
|
Timeline summary string |
Source code in src/memoir/memento/timeline.py
IntelligentSearchEngine ¶
LLM-powered search engine that intelligently selects relevant memory paths.
Two selection pipelines are available via the mode argument on
:meth:search:
mode="single"(default) - one LLM call picks 1-3 paths from the full path inventory (with content samples). Lowest latency; signal-to-noise degrades as the store grows.-
mode="tiered"- staged drill-down that mirrors the caller-driven[mode=drill]flow used by thememory-recallskill: -
Pure-compute L1 histogram over stored paths.
- LLM #1 picks 2-4 L1 prefixes likely to hold the answer.
- Optional LLM #1.5 picks L2 prefixes when any picked L1 exceeds
:data:
L2_ESCALATION_THRESHOLDkeys. - LLM #2 picks 3-7 exact keys from the descended subset.
- Batched memory fetch via :meth:
_extract_memories_from_data.
Both pipelines share path-discovery pre-work and emit comparable
step_timings / llm_prompts metadata. Prompt caching markers in the
single-stage prompt ([STATIC_SECTION_START] / [STATIC_SECTION_END])
are also applied to the tiered key-pick stage, which reuses
:meth:_select_relevant_paths.
Source code in src/memoir/search/intelligent.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 | |
__init__ ¶
Initialize the intelligent search engine.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
llm
|
Any
|
Language model for path selection |
required |
store
|
Any
|
Memory store (ProllyTreeStore) |
required |
taxonomy_loader
|
TaxonomyLoader | None
|
Optional TaxonomyLoader for loading taxonomy from store. When provided, taxonomy data is loaded from the store's taxonomy namespace. When None, falls back to hardcoded TaxonomyPresets. |
None
|
Source code in src/memoir/search/intelligent.py
search
async
¶
search(query: str, namespace: str, limit: int = 10, return_prompts: bool = False, person_filter: str | None = None, mode: str = 'single') -> list[IntelligentSearchResult]
Search for relevant memories using LLM path selection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
query
|
str
|
Natural language search query |
required |
namespace
|
str
|
User namespace to search in |
required |
limit
|
int
|
Maximum number of results |
10
|
return_prompts
|
bool
|
Whether to capture and return LLM prompts |
False
|
person_filter
|
str | None
|
Optional person name to filter paths (e.g., "john") |
None
|
mode
|
str
|
"single" (default, one LLM call) or "tiered" (multi-stage drill-down: L1 pick → optional L2 pick → key pick). Unknown values raise ValueError. |
'single'
|
Returns:
| Type | Description |
|---|---|
list[IntelligentSearchResult]
|
List of IntelligentSearchResult objects |
Source code in src/memoir/search/intelligent.py
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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 | |
IntelligentSearchResult
dataclass
¶
Simple search result containing memory content and metadata.
Source code in src/memoir/search/intelligent.py
MemoryItem ¶
Bases: BaseModel
Represents a memory item in the store.
Source code in src/memoir/store/prolly_adapter.py
ProllyTreeStore ¶
Bases: BaseStore
High-performance semantic memory store using ProllyTree. Implements LangGraph's BaseStore interface following the reference pattern.
Source code in src/memoir/store/prolly_adapter.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 | |
__init__ ¶
__init__(path: str, enable_versioning: bool = True, auto_commit: bool = True, cache_size: int = 10000)
Initialize ProllyTree store.
Storage layer is responsible only for storing and retrieving data. Classification is handled by higher layers (memory manager).
ProllyTreeStore is strict: it opens an existing memoir store and
refuses paths that aren't one yet. Use StoreService.create_store
(or memoir new) to bootstrap a fresh store. Single init path =
no surprise side-effects from running memoir remember in a random
cwd.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str
|
Path to an existing memoir store (must contain a |
required |
enable_versioning
|
bool
|
Whether to enable git-like versioning |
True
|
auto_commit
|
bool
|
Whether to automatically commit on each put/delete operation |
True
|
cache_size
|
int
|
Size of internal caches |
10000
|
Source code in src/memoir/store/prolly_adapter.py
103 104 105 106 107 108 109 110 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 | |
batch ¶
Batch operations - required by BaseStore.
Source code in src/memoir/store/prolly_adapter.py
abatch ¶
search ¶
Search for items in a namespace.
Source code in src/memoir/store/prolly_adapter.py
put ¶
Store a value in a namespace.
Source code in src/memoir/store/prolly_adapter.py
get ¶
Retrieve a value from a namespace.
Source code in src/memoir/store/prolly_adapter.py
delete ¶
Delete a key from a namespace.
Source code in src/memoir/store/prolly_adapter.py
commit ¶
Manually commit pending changes to the versioned store.
This is useful when auto_commit is disabled and you want to batch multiple operations before committing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
Commit message |
'Manual commit'
|
Returns:
| Type | Description |
|---|---|
str | None
|
Commit hash if versioning is enabled, None otherwise |
Source code in src/memoir/store/prolly_adapter.py
get_key_history ¶
Get commit history for a specific key.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
tuple
|
Namespace tuple |
required |
key
|
str
|
Key to get history for |
required |
limit
|
int
|
Maximum number of commits to return |
10
|
Returns:
| Type | Description |
|---|---|
list[dict]
|
List of commit dictionaries with id, timestamp, message, author, committer |
Source code in src/memoir/store/prolly_adapter.py
get_key_at_commit ¶
Get the value of a key at a specific commit.
Note: Current implementation returns None since VersionedKvStore doesn't support direct commit checkout. This is a placeholder for future enhancement.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
tuple
|
Namespace tuple |
required |
key
|
str
|
Key to retrieve |
required |
commit_id
|
str
|
Commit ID to retrieve from |
required |
Returns:
| Type | Description |
|---|---|
dict | None
|
None (historical content retrieval not yet implemented) |
Source code in src/memoir/store/prolly_adapter.py
create_time_snapshot ¶
Create a branch snapshot at the current point in time.
When auto_commit=False, this will first commit any pending changes before creating the snapshot to ensure all recent changes are included.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
snapshot_name
|
str
|
Name for the snapshot branch |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if snapshot created successfully |
Source code in src/memoir/store/prolly_adapter.py
get_state_at_snapshot ¶
Get all keys in a namespace at a specific snapshot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
tuple
|
Namespace tuple |
required |
snapshot_name
|
str
|
Name of the snapshot branch |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dictionary of key -> value at that snapshot |
Source code in src/memoir/store/prolly_adapter.py
store_memory_async
async
¶
Store a memory at the given semantic key.
Note: Classification must be done by the caller (memory manager). Storage layer is responsible only for storing, not classifying.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User/agent namespace |
required |
content
|
Any
|
Memory content to store |
required |
key
|
str
|
Semantic key where to store (REQUIRED - no classification here) |
required |
Returns:
| Type | Description |
|---|---|
MemoryItem
|
MemoryItem with storage results |
Source code in src/memoir/store/prolly_adapter.py
asearch
async
¶
Async search for items with a given path prefix. Used by HierarchicalSearchEngine.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace |
required |
path_prefix
|
str
|
Path prefix to search for |
required |
Returns:
| Type | Description |
|---|---|
list[tuple[str, Any]]
|
List of (semantic_key, data) tuples |
Source code in src/memoir/store/prolly_adapter.py
retrieve_memories_async
async
¶
Retrieve memories using semantic search (async version).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User/agent namespace |
required |
query
|
str
|
Search query |
required |
limit
|
int
|
Maximum number of results |
10
|
Returns:
| Type | Description |
|---|---|
list[MemoryItem]
|
List of matching memory items |
Source code in src/memoir/store/prolly_adapter.py
retrieve_memories ¶
Retrieve memories using semantic search (sync fallback).
Note: This is a simple fallback. For proper semantic search, use retrieve_memories_async() which leverages the HierarchicalSearchEngine.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User/agent namespace |
required |
query
|
str
|
Search query |
required |
limit
|
int
|
Maximum number of results |
10
|
Returns:
| Type | Description |
|---|---|
list[MemoryItem]
|
List of matching memory items |
Source code in src/memoir/store/prolly_adapter.py
get_statistics ¶
Get store statistics.
Source code in src/memoir/store/prolly_adapter.py
export_namespace ¶
Export all memories from a namespace to JSON.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
Namespace to export |
required |
output_path
|
str
|
Path to save JSON file |
required |
Source code in src/memoir/store/prolly_adapter.py
SemanticTaxonomy ¶
Bases: BaseTaxonomy
Fixed semantic taxonomy with predefined paths. Provides hierarchical organization for AI memory classification. Implements TaxonomyInterface for standardized access.
Source code in src/memoir/taxonomy/semantic.py
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 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 | |
__init__ ¶
Initialize semantic taxonomy with flexible data loading.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
taxonomy_loader
|
Any | None
|
Optional TaxonomyLoader for loading taxonomy from store. If None, uses TaxonomyPresets as fallback. |
None
|
Source code in src/memoir/taxonomy/semantic.py
get_all_paths ¶
get_children ¶
Get immediate children of a path.
Source code in src/memoir/taxonomy/semantic.py
get_descendants ¶
is_valid_path ¶
get_path_depth ¶
get_category ¶
Get the top-level category for a path.
get_related_paths ¶
Get paths related to the given path within a certain distance.
Source code in src/memoir/taxonomy/semantic.py
get_statistics ¶
Get statistics about the taxonomy.
Source code in src/memoir/taxonomy/semantic.py
TaxonomyCategory ¶
Bases: Enum
Top-level taxonomy categories.
Source code in src/memoir/taxonomy/semantic.py
get_taxonomy ¶
Get the thread-safe singleton taxonomy instance.
Source code in src/memoir/taxonomy/semantic.py
Subpackages¶
Core Module¶
memoir.core.memory module¶
memoir.core.memory ¶
Provides high-performance semantic memory with versioning capabilities.
Memory ¶
Bases: BaseModel
Represents a memory object compatible with LangMem.
Source code in src/memoir/core/memory.py
MemoryVersion ¶
ProllyTreeMemoryStoreManager ¶
Bases: MemoryStoreManager
Enhanced MemoryStoreManager with ProllyTree backend. Provides semantic classification, hierarchical search, and versioning.
Source code in src/memoir/core/memory.py
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 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 | |
__init__ ¶
__init__(prolly_store: Any | None = None, prolly_path: str | None = None, model: str | Any = 'gpt-3.5-turbo', classifier: Any | None = None, search_engine: Any | None = None, enable_versioning: bool = True, auto_commit: bool = True, enable_fast_classification: bool = True, cache_size: int = 10000, **kwargs)
Initialize enhanced memory manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prolly_store
|
Any | None
|
ProllyTreeStore instance (preferred - allows proper dependency injection) |
None
|
prolly_path
|
str | None
|
Path to create ProllyTree database (fallback if store not provided) |
None
|
classifier
|
Any | None
|
SemanticClassifier or IntelligentClassifier instance |
None
|
search_engine
|
Any | None
|
Search engine instance (IntelligentSearchEngine, etc.) |
None
|
enable_versioning
|
bool
|
Enable git-like versioning |
True
|
auto_commit
|
bool
|
Whether to automatically commit on each memory operation |
True
|
enable_fast_classification
|
bool
|
Use optimized classifier |
True
|
cache_size
|
int
|
Size of internal caches |
10000
|
**kwargs
|
Additional arguments for MemoryStoreManager |
{}
|
Source code in src/memoir/core/memory.py
search_memories
async
¶
Search memories using the provided search engine.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
query
|
str
|
Natural language search query |
required |
namespace
|
str
|
User namespace |
required |
limit
|
int
|
Maximum results to return |
10
|
Returns:
| Type | Description |
|---|---|
list[Memory]
|
List of Memory objects |
Source code in src/memoir/core/memory.py
store_memory
async
¶
store_memory(content: Any, namespace: str, metadata: dict | None = None, auto_classify: bool = True) -> str
Store a memory with automatic semantic classification.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
content
|
Any
|
Memory content to store |
required |
namespace
|
str
|
User namespace |
required |
metadata
|
dict | None
|
Optional metadata |
None
|
auto_classify
|
bool
|
Whether to auto-classify the content |
True
|
Returns:
| Type | Description |
|---|---|
str
|
Semantic key where memory was stored |
Source code in src/memoir/core/memory.py
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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | |
store_commit ¶
Commit all pending memory operations to the versioned store.
This is used when auto_commit=False is set on the ProllyTreeStore to batch multiple memory operations into a single commit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
Commit message describing the batch of operations |
'Batch memory operations'
|
Returns:
| Type | Description |
|---|---|
str | None
|
Commit hash if versioning is enabled, None otherwise |
Source code in src/memoir/core/memory.py
get_memory_versions
async
¶
Get version history for a memory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
semantic_key
|
str
|
Semantic taxonomy key |
required |
namespace
|
str
|
User namespace |
required |
limit
|
int
|
Maximum versions to return |
10
|
Returns:
| Type | Description |
|---|---|
list[MemoryVersion]
|
List of memory versions |
Source code in src/memoir/core/memory.py
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 | |
time_travel
async
¶
Get all memories as they were at a specific time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace |
required |
target_time
|
datetime | float
|
Target datetime or unix timestamp |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dictionary of memories at that time |
Source code in src/memoir/core/memory.py
create_memory_snapshot
async
¶
Create a snapshot of the current memory state.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace |
required |
snapshot_name
|
str | None
|
Optional name for snapshot (auto-generated if not provided) |
None
|
Returns:
| Type | Description |
|---|---|
str
|
Name of the created snapshot |
Source code in src/memoir/core/memory.py
compare_memory_states
async
¶
compare_memory_states(namespace: str, time1: datetime | float, time2: datetime | float) -> dict[str, Any]
Compare memory states between two points in time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace |
required |
time1
|
datetime | float
|
First timestamp |
required |
time2
|
datetime | float
|
Second timestamp |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Comparison results with added/removed/changed memories |
Source code in src/memoir/core/memory.py
branch_memories
async
¶
Create a new branch of memories for experimentation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace |
required |
branch_name
|
str
|
Name for the new branch |
required |
Returns:
| Type | Description |
|---|---|
str
|
Branch identifier |
Source code in src/memoir/core/memory.py
merge_memories
async
¶
merge_memories(namespace: str, source_branch: str, target_branch: str = 'main', strategy: str = 'ours') -> dict[str, Any]
Merge memories from one branch to another.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace |
required |
source_branch
|
str
|
Source branch to merge from |
required |
target_branch
|
str
|
Target branch to merge into |
'main'
|
strategy
|
str
|
Merge strategy ("ours", "theirs", "union") |
'ours'
|
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Merge results with conflicts if any |
Source code in src/memoir/core/memory.py
get_performance_metrics ¶
Get performance metrics for the memory system.
Source code in src/memoir/core/memory.py
optimize_memory_layout
async
¶
Optimize memory layout for better performance. Reorganizes memories based on access patterns.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
User namespace to optimize |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Optimization results |
Source code in src/memoir/core/memory.py
export_memories
async
¶
Export memories to file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
namespace
|
str
|
Namespace to export |
required |
output_path
|
str
|
Output file path |
required |
format
|
str
|
Export format (json, csv, markdown) |
'json'
|
Source code in src/memoir/core/memory.py
import_memories
async
¶
Import memories from file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_path
|
str
|
Input file path |
required |
namespace
|
str | None
|
Override namespace (uses file namespace if None) |
None
|
Returns:
| Type | Description |
|---|---|
int
|
Number of memories imported |