API Reference

The DreamLog API provides a comprehensive set of classes and functions for logic programming with wake-sleep optimization cycles.

Core Modules

Terms

• Term - Base class for all terms
• Atom - Atomic constants
• Variable - Logic variables
• Compound - Compound terms with functors and arguments
• Factory functions: atom(), var(), compound()

Parser

• parse_s_expression() - Parse S-expression syntax
• parse_prefix_notation() - Parse JSON prefix arrays
• term_to_sexp() - Convert terms to S-expressions
• term_to_prefix_json() - Convert terms to JSON

Knowledge Base

• KnowledgeBase - Main storage for facts and rules
• Fact - Ground terms
• Rule - Head-body implications
• Indexing and retrieval methods

Unification

• unify() - Standard unification
• match() - One-way matching
• subsumes() - Subsumption checking
• Unifier - Stateful unification operations

Evaluator

• PrologEvaluator - SLD resolution with backtracking
• Solution - Query results with variable bindings
• Query evaluation strategies

Engine

• DreamLogEngine - High-level API combining all components
• add_fact(), add_rule(), query() methods
• Persistence with save_to_prefix(), load_from_prefix()

LLM Integration

LLM Providers

• LLMProvider - Protocol for all providers
• MockLLMProvider - Testing provider
• OpenAIProvider - OpenAI API integration
• AnthropicProvider - Anthropic Claude integration
• OllamaProvider - Local LLM support

LLM Hook

• LLMHook - Automatic knowledge generation
• Context extraction and management
• Caching and rate limiting

Prompt Templates

• PromptTemplateManager - Manage prompt templates
• Template variables and substitution
• Custom template creation

Wake-Sleep System

KB Dreamer

• KnowledgeBaseDreamer - Wake-sleep optimization
• DreamSession - Dream cycle results
• DreamInsight - Individual optimizations
• Compression, abstraction, and generalization

Configuration

• DreamLogConfig - Main configuration
• LLMSamplingConfig - Sampling strategies
• YAML configuration support

Pythonic Interface

Pythonic API

• dreamlog() - Fluent API factory
• Method chaining for facts and rules
• Query execution and results

Integration Modules

TUI

• Interactive terminal user interface
• Commands for queries, facts, rules
• LLM and dreaming support

MCP Server

• Model Context Protocol integration
• Tool definitions for DreamLog operations
• WebSocket communication

REST API

• HTTP endpoints for DreamLog
• WebSocket REPL support
• JSON request/response format