Skip to content

YARD API Reference

Complete API documentation generated by YARD with yard-markdown.

  • API Documentation

    Browse the complete API reference with method signatures, parameters, and examples.

  • Documentation Coverage

    Run rake htm:doc:stats to see documentation coverage statistics.

Classes & Modules

Class/Module Description
HTM Main API class for memory operations
HTM::CircuitBreaker Fault tolerance for external services
HTM::Configuration Multi-provider LLM configuration
HTM::Database Database schema and connection management
HTM::EmbeddingService Vector embedding generation service
HTM::JobAdapter Background job abstraction layer
HTM::LongTermMemory PostgreSQL-backed permanent storage
HTM::Observability Metrics and logging instrumentation
HTM::PropositionService HTM::PropositionService class
HTM::QueryCache HTM::QueryCache class
HTM::RobotGroup HTM::RobotGroup class
HTM::SqlBuilder HTM::SqlBuilder class
HTM::TagService Hierarchical tag extraction service
HTM::Telemetry HTM::Telemetry class
HTM::Telemetry::NullInstrument HTM::Telemetry::NullInstrument class
HTM::Telemetry::NullMeter HTM::Telemetry::NullMeter class
HTM::Timeframe Time-based query filtering
HTM::Timeframe::Result HTM::Timeframe::Result class
HTM::TimeframeExtractor Natural language time parsing
HTM::TimeframeExtractor::Result HTM::TimeframeExtractor::Result class
HTM::WorkingMemory Token-limited in-memory cache
HTM::WorkingMemoryChannel HTM::WorkingMemoryChannel class

Generating Documentation

# Build YARD documentation
rake htm:doc:yard

# Start live-reload server (HTML mode)
rake htm:doc:server

# Show coverage statistics
rake htm:doc:stats