Struct MemoryDBTool 

pub struct MemoryDBTool { /* private fields */ }

In-Memory Database Tool

Provides a simple key-value store for agents to cache data during conversations. Supports set, get, delete, list keys, and clear operations.

Implementations

impl MemoryDBTool

pub fn new() -> Self

Examples found in repository

examples/agent_with_memory_db.rs (line 30)

async fn main() -> helios_engine::Result<()> {
    println!("🚀 Helios Engine - Agent with Memory DB Example");
    println!("================================================\n");

    // Load configuration
    let config = Config::from_file("config.toml").unwrap_or_else(|_| {
        println!("⚠ No config.toml found, using default configuration");
        Config::new_default()
    });

    // Create agent with memory database tool
    let mut agent = Agent::builder("DataAgent")
        .config(config)
        .system_prompt(
            "You are a helpful assistant with access to an in-memory database. \
             You can store and retrieve information using the memory_db tool. \
             Operations available: set, get, delete, list, clear, exists. \
             Use this to remember important information across our conversation."
        )
        .tool(Box::new(MemoryDBTool::new()))
        .max_iterations(10)
        .build()
        .await?;

    println!("✓ Agent created with memory database tool\n");

    // Example 1: Store user preferences
    println!("Example 1: Storing User Preferences");
    println!("====================================\n");

    let response = agent
        .chat("Store my name as 'Alice' and my favorite color as 'blue' in the database")
        .await?;
    println!("Agent: {}\n", response);

    // Example 2: Retrieve stored data
    println!("\nExample 2: Retrieving Stored Data");
    println!("==================================\n");

    let response = agent
        .chat("What's my name and favorite color?")
        .await?;
    println!("Agent: {}\n", response);

    // Example 3: Store calculations
    println!("\nExample 3: Caching Calculations");
    println!("================================\n");

    let response = agent
        .chat("Calculate 123 * 456 and store the result in the database with key 'calculation_result'")
        .await?;
    println!("Agent: {}\n", response);

    // Example 4: List all stored data
    println!("\nExample 4: Listing All Data");
    println!("===========================\n");

    let response = agent
        .chat("Show me everything stored in the database")
        .await?;
    println!("Agent: {}\n", response);

    // Example 5: Check if key exists
    println!("\nExample 5: Checking Key Existence");
    println!("==================================\n");

    let response = agent
        .chat("Check if 'name' and 'age' exist in the database")
        .await?;
    println!("Agent: {}\n", response);

    // Example 6: Delete specific data
    println!("\nExample 6: Deleting Data");
    println!("========================\n");

    let response = agent
        .chat("Delete the 'calculation_result' from the database")
        .await?;
    println!("Agent: {}\n", response);

    // Example 7: Final state
    println!("\nExample 7: Final Database State");
    println!("================================\n");

    let response = agent
        .chat("List all remaining items in the database")
        .await?;
    println!("Agent: {}\n", response);

    println!("\n✅ Example completed successfully!");
    println!("\n💡 Key Features Demonstrated:");
    println!("  • Setting key-value pairs in memory database");
    println!("  • Retrieving stored values");
    println!("  • Listing all database contents");
    println!("  • Checking key existence");
    println!("  • Deleting specific entries");
    println!("  • Persistent data across multiple agent interactions");
    println!("\n📝 Use Cases:");
    println!("  • Caching expensive computations");
    println!("  • Storing user preferences during conversation");
    println!("  • Maintaining context across multiple queries");
    println!("  • Temporary data storage for complex workflows");

    Ok(())
}

pub fn with_shared_db(db: Arc<Mutex<HashMap<String, String>>>) -> Self

Trait Implementations

impl Default for MemoryDBTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for MemoryDBTool

fn name(&self) -> &str

fn description(&self) -> &str

fn parameters(&self) -> HashMap<String, ToolParameter>

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn to_definition(&self) -> ToolDefinition