core/README.md
Harshith Mullapudi 25ed9aa430 Fix: update readme
2025-05-27 23:17:34 +05:30

44 lines
865 B
Markdown

# Memory Plane
Simple memory management system for AI agents with per-space ingestion and search capabilities.
## Core APIs
### 1. Ingest API
- Endpoint per space for data ingestion
- Queue-based processing per user
- Creates and links graph nodes automatically
- Optional review queue for controlled ingestion
### 2. Search API
- Simple text-based search
- Input: query string
- Output: relevant text matches
- Scoped to specific memory space
## Features (v1)
[ ] Auto-mode default with optional queue review
[ ] Multiple Spaces support (unique URL per space)
[ ] Basic rules engine for ingestion filters
[ ] Clear, user-friendly guidelines
[ ] Simple text search
## Usage Guidelines
Store:
- Conversation history
- User preferences
- Task context
- Reference materials
Don't Store:
- Sensitive data (PII)
- Credentials
- System logs
- Temporary data