Expand description
Core types and traits for MemOS-compatible memory API.
Request/response DTOs align with MemOS product_models.py for JSON compatibility.
Structs§
- AddJob
Submitted - Response when add is submitted in async mode (returns task_id for status polling).
- AddJob
Submitted Data - AddMemory
Relation - Optional relation spec used by add-memory request.
- ApiAdd
Request - Add-memory request (MemOS APIADDRequest).
- ApiSearch
Request - Search-memory request (MemOS APISearchRequest).
- Audit
Event - One audit event (for governance and debugging).
- Audit
List Options - Options for listing audit events (filter + pagination).
- Base
Response - Base response envelope.
- Forget
Memory Request - Request to forget (soft or hard delete) a memory.
- GetMemory
Request - Request to get a single memory by id.
- GetMemory
Response - Response for get_memory: optional MemoryItem.
- Graph
Neighbor - Neighbor item for graph traversal response.
- Graph
Neighbor Item - API response item for one graph neighbor.
- Graph
Neighbors Data - API response payload for graph neighbor query.
- Graph
Neighbors Request - API request for graph neighbor query.
- Graph
Path - Internal shortest-path result.
- Graph
Path Data - API response payload for graph path query.
- Graph
Path Request - API request for graph path query.
- Graph
Paths Request - API request for multi-path graph query.
- Job
- A submitted or running add job.
- Memory
Bucket - One bucket of memories (e.g. WorkingMemory, LongTermMemory).
- Memory
Edge - Graph edge between two memory nodes.
- Memory
Item - Single memory item as returned in search (id, memory, metadata).
- Memory
Node - Internal memory node (id, memory, metadata, optional embedding).
- Memory
Record - Full record for lifecycle (versioning, state, audit). Can be derived from MemoryNode.metadata.
- Message
- Single chat message (user/assistant).
- Scheduler
Status Response - Response for GET /product/scheduler/status (MemOS-compatible).
- Search
Response - Search response (MemOS SearchResponse).
- Search
Response Data - Search result data: text_mem and optional pref_mem.
- Update
Memory Request - Request to update an existing memory (partial fields).
- VecSearch
Hit - Result of a vector search hit (id + score).
- VecStore
Item - Item for vector store (id, vector, payload).
Enums§
- Audit
Event Kind - Kind of auditable event.
- Audit
Store Error - Embedder
Error - Graph
Direction - Traversal direction for graph neighbor query.
- Graph
Store Error - JobStatus
- Status of an async add job.
- MemCube
Error - Memory
Scope - Scope for memory (MemOS: WorkingMemory, LongTermMemory, UserMemory).
- Memory
State - State of a memory record in its lifecycle.
- VecStore
Error
Traits§
- Audit
Store - Audit event store: append-only log with optional list by user/cube/time and pagination.
- Embedder
- Embedder: text -> vector(s).
- Graph
Store - Graph store abstraction (subset of MemOS BaseGraphDB).
- MemCube
- MemCube abstraction: add, search, update, and forget memories.
- VecStore
- Vector store abstraction (subset of MemOS BaseVecDB).
Type Aliases§
- Forget
Memory Response - Graph
Neighbors Response - API response for graph neighbor query.
- Graph
Path Response - API response for graph path query.
- Graph
Paths Response - API response for multi-path query.
- Memory
Response - Add-memory response (MemOS MemoryResponse).
- Update
Memory Response - Response for update_memory / forget_memory (same envelope as add).