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:statsto see documentation coverage statistics.
Classes & Modules¶
| Class/Module | Description |
|---|---|
| HTM::CircuitBreaker | Fault tolerance for external services |
| HTM::Config::Builder | HTM::Config::Builder class |
| HTM::Config::Database | Database schema and connection management |
| HTM::Config::Validator | HTM::Config::Validator class |
| HTM::Config | HTM::Config class |
| HTM::Database | Database schema and connection management |
| HTM::EmbeddingService | Vector embedding generation service |
| HTM::JobAdapter | Background job abstraction layer |
| HTM::Jobs::GenerateEmbeddingJob | HTM::Jobs::GenerateEmbeddingJob class |
| HTM::Jobs::GeneratePropositionsJob | HTM::Jobs::GeneratePropositionsJob class |
| HTM::Jobs::GenerateRelationshipsJob | HTM::Jobs::GenerateRelationshipsJob class |
| HTM::Jobs::GenerateTagsJob | HTM::Jobs::GenerateTagsJob class |
| HTM::Jobs | HTM::Jobs class |
| HTM::Loaders::MarkdownChunker | HTM::Loaders::MarkdownChunker class |
| HTM::Loaders::MarkdownLoader | HTM::Loaders::MarkdownLoader class |
| HTM::Loaders | HTM::Loaders class |
| HTM::LongTermMemory::FulltextSearch | HTM::LongTermMemory::FulltextSearch class |
| HTM::LongTermMemory::HybridSearch | HTM::LongTermMemory::HybridSearch class |
| HTM::LongTermMemory::NodeOperations | HTM::LongTermMemory::NodeOperations class |
| HTM::LongTermMemory::RelevanceScorer | HTM::LongTermMemory::RelevanceScorer class |
| HTM::LongTermMemory::RobotOperations | HTM::LongTermMemory::RobotOperations class |
| HTM::LongTermMemory::TagOperations | HTM::LongTermMemory::TagOperations class |
| HTM::LongTermMemory::VectorSearch | HTM::LongTermMemory::VectorSearch class |
| HTM::LongTermMemory | PostgreSQL-backed permanent storage |
| HTM::MCP::CLI | HTM::MCP::CLI class |
| HTM::MCP::CreateGroupTool | HTM::MCP::CreateGroupTool class |
| HTM::MCP::FailoverTool | HTM::MCP::FailoverTool class |
| HTM::MCP::FindByTopicTool | HTM::MCP::FindByTopicTool class |
| HTM::MCP::ForgetTool | HTM::MCP::ForgetTool class |
| HTM::MCP::GetGroupStatusTool | HTM::MCP::GetGroupStatusTool class |
| HTM::MCP::GetGroupWorkingMemoryTool | HTM::MCP::GetGroupWorkingMemoryTool class |
| HTM::MCP::GetRobotTool | HTM::MCP::GetRobotTool class |
| HTM::MCP::GetWorkingMemoryTool | HTM::MCP::GetWorkingMemoryTool class |
| HTM::MCP::GroupRecallTool | HTM::MCP::GroupRecallTool class |
| HTM::MCP::GroupRememberTool | HTM::MCP::GroupRememberTool class |
| HTM::MCP::GroupSession | HTM::MCP::GroupSession class |
| HTM::MCP::JoinGroupTool | HTM::MCP::JoinGroupTool class |
| HTM::MCP::LeaveGroupTool | HTM::MCP::LeaveGroupTool class |
| HTM::MCP::ListGroupsTool | HTM::MCP::ListGroupsTool class |
| HTM::MCP::ListTagsTool | HTM::MCP::ListTagsTool class |
| HTM::MCP::MemoryStatsResource | HTM::MCP::MemoryStatsResource class |
| HTM::MCP::PromoteRobotTool | HTM::MCP::PromoteRobotTool class |
| HTM::MCP::RecallTool | HTM::MCP::RecallTool class |
| HTM::MCP::RecentMemoriesResource | HTM::MCP::RecentMemoriesResource class |
| HTM::MCP::RememberTool | HTM::MCP::RememberTool class |
| HTM::MCP::RestoreTool | HTM::MCP::RestoreTool class |
| HTM::MCP::RobotGroupsResource | HTM::MCP::RobotGroupsResource class |
| HTM::MCP::SearchTagsTool | HTM::MCP::SearchTagsTool class |
| HTM::MCP::Server | HTM::MCP::Server class |
| HTM::MCP::Session | HTM::MCP::Session class |
| HTM::MCP::SetRobotTool | HTM::MCP::SetRobotTool class |
| HTM::MCP::ShutdownGroupTool | HTM::MCP::ShutdownGroupTool class |
| HTM::MCP::StatsTool | HTM::MCP::StatsTool class |
| HTM::MCP::SyncGroupTool | HTM::MCP::SyncGroupTool class |
| HTM::MCP::TagHierarchyResource | HTM::MCP::TagHierarchyResource class |
| HTM::MCP | HTM::MCP class |
| HTM::Migration | HTM::Migration class |
| HTM::Models::FileSource | HTM::Models::FileSource class |
| HTM::Models::Node | HTM::Models::Node class |
| HTM::Models::NodeRelationship | HTM::Models::NodeRelationship class |
| HTM::Models::NodeTag | HTM::Models::NodeTag class |
| HTM::Models::Robot | HTM::Models::Robot class |
| HTM::Models::RobotNode | HTM::Models::RobotNode class |
| HTM::Models::Tag | HTM::Models::Tag class |
| HTM::Models | HTM::Models class |
| HTM::Observability | Metrics and logging instrumentation |
| HTM::PropositionService | HTM::PropositionService class |
| HTM::QueryCache | HTM::QueryCache class |
| HTM::RobotGroup | HTM::RobotGroup class |
| HTM::Sinatra::Helpers | HTM::Sinatra::Helpers class |
| HTM::Sinatra::Middleware | HTM::Sinatra::Middleware class |
| HTM::Sinatra | HTM::Sinatra class |
| HTM::SqlBuilder | HTM::SqlBuilder class |
| HTM::TagService | Hierarchical tag extraction service |
| HTM::Telemetry::NullInstrument | HTM::Telemetry::NullInstrument class |
| HTM::Telemetry::NullMeter | HTM::Telemetry::NullMeter class |
| HTM::Telemetry | HTM::Telemetry class |
| HTM::Timeframe::Result | HTM::Timeframe::Result class |
| HTM::Timeframe | Time-based query filtering |
| HTM::TimeframeExtractor::Result | HTM::TimeframeExtractor::Result class |
| HTM::TimeframeExtractor | Natural language time parsing |
| HTM::Workflows::RememberWorkflow | HTM::Workflows::RememberWorkflow class |
| HTM::Workflows | HTM::Workflows class |
| HTM::WorkingMemory | Token-limited in-memory cache |
| HTM::WorkingMemoryChannel | HTM::WorkingMemoryChannel class |
| HTM | Main API class for memory operations |
| Sinatra::Base | Sinatra::Base class |
| Sinatra | Sinatra class |