Struct OpenMemory 

pub struct OpenMemory { /* private fields */ }

OpenMemory - Main API

The primary interface for interacting with the memory system.

Implementations

impl OpenMemory

pub async fn new(options: OpenMemoryOptions) -> Result<Self>

Create a new OpenMemory instance

Arguments

• options - Configuration options

Example

use openmemory::{OpenMemory, OpenMemoryOptions};

#[tokio::main]
async fn main() {
    let om = OpenMemory::new(OpenMemoryOptions::default()).await.unwrap();
}

pub async fn in_memory() -> Result<Self>

Create an in-memory instance (useful for testing)

pub async fn add(&self, content: &str, options: AddOptions) -> Result<AddResult>

Add a memory

Arguments

• content - The text content to store
• options - Additional options (tags, metadata, etc.)

Returns

The result containing the generated ID and classified sectors

pub async fn query( &self, query: &str, options: QueryOptions, ) -> Result<Vec<HsgQueryResult>>

Query memories

Uses the HSG algorithm to find relevant memories.

Arguments

• query - Search query
• options - Query options (k, filters, etc.)

pub async fn delete(&self, id: &str) -> Result<()>

Delete a memory by ID

pub async fn get(&self, id: &str) -> Result<Option<MemRow>>

Get a memory by ID

pub async fn get_all(&self, limit: usize, offset: usize) -> Result<Vec<MemRow>>

Get all memories with pagination

pub async fn get_by_sector( &self, sector: &Sector, limit: usize, offset: usize, ) -> Result<Vec<MemRow>>

Get memories by sector

pub async fn run_decay(&self) -> Result<DecayStats>

Run decay on all memories

pub async fn reinforce(&self, id: &str, boost: Option<f64>) -> Result<()>

Reinforce a memory (increase salience)

pub fn config(&self) -> &Config

Get configuration

pub fn embedding_info(&self) -> EmbeddingInfo

Get embedding provider info