touchdb-ai 2.0.2__py3-none-any.whl

touchdb/__init__.py

@@ -0,0 +1,172 @@
+"""
+TouchDB Agents - A modular framework for building LLM agents.
+
+This package provides a flexible framework for creating conversational AI agents
+with tool execution, conversation management, and user scoping.
+"""
+
+# Version information
+__version__ = "2.0.2"
+
+# Import core framework components
+from .core import (
+    # Interfaces
+    Agent,
+    ConversationStore,
+    LlmService,
+    SystemPromptBuilder,
+    Tool,
+    UserService,
+    T,
+    # Models
+    Conversation,
+    LlmMessage,
+    LlmRequest,
+    LlmResponse,
+    LlmStreamChunk,
+    Message,
+    ToolCall,
+    ToolContext,
+    ToolResult,
+    ToolSchema,
+    User,
+    # UI Components
+    UiComponent,
+    SimpleComponent,
+    SimpleComponentType,
+    SimpleTextComponent,
+    SimpleImageComponent,
+    SimpleLinkComponent,
+    # Rich Components
+    ArtifactComponent,
+    BadgeComponent,
+    CardComponent,
+    DataFrameComponent,
+    IconTextComponent,
+    LogViewerComponent,
+    NotificationComponent,
+    ProgressBarComponent,
+    ProgressDisplayComponent,
+    RichTextComponent,
+    StatusCardComponent,
+    TaskListComponent,
+    # Core implementations
+    Agent,
+    AgentConfig,
+    DefaultSystemPromptBuilder,
+    DefaultWorkflowHandler,
+    ToolRegistry,
+    # Evaluation
+    Evaluator,
+    TestCase,
+    ExpectedOutcome,
+    AgentResult,
+    EvaluationResult,
+    TestCaseResult,
+    AgentVariant,
+    EvaluationRunner,
+    TrajectoryEvaluator,
+    OutputEvaluator,
+    LLMAsJudgeEvaluator,
+    EfficiencyEvaluator,
+    EvaluationReport,
+    ComparisonReport,
+    EvaluationDataset,
+    # Exceptions
+    AgentError,
+    ConversationNotFoundError,
+    LlmServiceError,
+    PermissionError,
+    ToolExecutionError,
+    ToolNotFoundError,
+    ValidationError,
+)
+
+# Import basic implementations
+from .integrations import MemoryConversationStore, MockLlmService
+
+# Main exports
+__all__ = [
+    # Version
+    "__version__",
+    # Core interfaces
+    "Agent",
+    "Tool",
+    "LlmService",
+    "ConversationStore",
+    "UserService",
+    "SystemPromptBuilder",
+    "T",
+    # Models
+    "User",
+    "Message",
+    "Conversation",
+    "ToolCall",
+    "ToolResult",
+    "ToolContext",
+    "ToolSchema",
+    "LlmMessage",
+    "LlmRequest",
+    "LlmResponse",
+    "LlmStreamChunk",
+    # UI Components
+    "UiComponent",
+    "SimpleComponent",
+    "SimpleComponentType",
+    "SimpleTextComponent",
+    "SimpleImageComponent",
+    "SimpleLinkComponent",
+    # Rich Components
+    "ArtifactComponent",
+    "BadgeComponent",
+    "CardComponent",
+    "DataFrameComponent",
+    "IconTextComponent",
+    "LogViewerComponent",
+    "NotificationComponent",
+    "ProgressBarComponent",
+    "ProgressDisplayComponent",
+    "RichTextComponent",
+    "StatusCardComponent",
+    "TaskListComponent",
+    # Core implementations
+    "Agent",
+    "AgentConfig",
+    "ToolRegistry",
+    "DefaultSystemPromptBuilder",
+    "DefaultWorkflowHandler",
+    # Evaluation
+    "Evaluator",
+    "TestCase",
+    "ExpectedOutcome",
+    "AgentResult",
+    "EvaluationResult",
+    "TestCaseResult",
+    "AgentVariant",
+    "EvaluationRunner",
+    "TrajectoryEvaluator",
+    "OutputEvaluator",
+    "LLMAsJudgeEvaluator",
+    "EfficiencyEvaluator",
+    "EvaluationReport",
+    "ComparisonReport",
+    "EvaluationDataset",
+    # Basic implementations
+    "MemoryConversationStore",
+    "MockLlmService",
+    # Server components
+    "TouchDBFlaskServer",
+    "TouchDBFastAPIServer",
+    "ChatHandler",
+    "ChatRequest",
+    "ChatStreamChunk",
+    "ExampleAgentLoader",
+    # Exceptions
+    "AgentError",
+    "ToolExecutionError",
+    "ToolNotFoundError",
+    "PermissionError",
+    "ConversationNotFoundError",
+    "LlmServiceError",
+    "ValidationError",
+]

touchdb/agents/__init__.py

@@ -0,0 +1,7 @@
+"""
+Agent implementations.
+
+This package contains agent implementations and utilities.
+"""
+
+__all__: list[str] = []

touchdb/capabilities/__init__.py

@@ -0,0 +1,17 @@
+"""
+Capabilities module.
+
+This package contains abstractions for tool capabilities - reusable utilities
+that tools can compose via dependency injection.
+"""
+
+from .file_system import CommandResult, FileSearchMatch, FileSystem
+from .sql_runner import RunSqlToolArgs, SqlRunner
+
+__all__ = [
+    "FileSystem",
+    "FileSearchMatch",
+    "CommandResult",
+    "SqlRunner",
+    "RunSqlToolArgs",
+]

touchdb/capabilities/agent_memory/__init__.py

@@ -0,0 +1,21 @@
+"""
+Agent memory capability package.
+"""
+
+from .base import AgentMemory
+from .models import (
+    MemoryStats,
+    TextMemory,
+    TextMemorySearchResult,
+    ToolMemory,
+    ToolMemorySearchResult,
+)
+
+__all__ = [
+    "AgentMemory",
+    "TextMemory",
+    "TextMemorySearchResult",
+    "ToolMemory",
+    "ToolMemorySearchResult",
+    "MemoryStats",
+]

touchdb/capabilities/agent_memory/base.py

@@ -0,0 +1,103 @@
+"""
+Agent memory capability interface for tool usage learning.
+
+This module contains the abstract base class for agent memory operations,
+following the same pattern as the FileSystem interface.
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Any, Dict, List, Optional
+
+if TYPE_CHECKING:
+    from touchdb.core.tool import ToolContext
+    from .models import (
+        ToolMemorySearchResult,
+        TextMemory,
+        TextMemorySearchResult,
+        ToolMemory,
+    )
+
+
+class AgentMemory(ABC):
+    """Abstract base class for agent memory operations."""
+
+    @abstractmethod
+    async def save_tool_usage(
+        self,
+        question: str,
+        tool_name: str,
+        args: Dict[str, Any],
+        context: "ToolContext",
+        success: bool = True,
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> None:
+        """Save a tool usage pattern for future reference."""
+        pass
+
+    @abstractmethod
+    async def save_text_memory(
+        self, content: str, context: "ToolContext"
+    ) -> "TextMemory":
+        """Save a free-form text memory."""
+        pass
+
+    @abstractmethod
+    async def search_similar_usage(
+        self,
+        question: str,
+        context: "ToolContext",
+        *,
+        limit: int = 10,
+        similarity_threshold: float = 0.7,
+        tool_name_filter: Optional[str] = None,
+    ) -> List[ToolMemorySearchResult]:
+        """Search for similar tool usage patterns based on a question."""
+        pass
+
+    @abstractmethod
+    async def search_text_memories(
+        self,
+        query: str,
+        context: "ToolContext",
+        *,
+        limit: int = 10,
+        similarity_threshold: float = 0.7,
+    ) -> List["TextMemorySearchResult"]:
+        """Search stored text memories based on a query."""
+        pass
+
+    @abstractmethod
+    async def get_recent_memories(
+        self, context: "ToolContext", limit: int = 10
+    ) -> List[ToolMemory]:
+        """Get recently added memories. Returns most recent memories first."""
+        pass
+
+    @abstractmethod
+    async def get_recent_text_memories(
+        self, context: "ToolContext", limit: int = 10
+    ) -> List["TextMemory"]:
+        """Fetch recently stored text memories."""
+        pass
+
+    @abstractmethod
+    async def delete_by_id(self, context: "ToolContext", memory_id: str) -> bool:
+        """Delete a memory by its ID. Returns True if deleted, False if not found."""
+        pass
+
+    @abstractmethod
+    async def delete_text_memory(self, context: "ToolContext", memory_id: str) -> bool:
+        """Delete a text memory by its ID. Returns True if deleted, False if not found."""
+        pass
+
+    @abstractmethod
+    async def clear_memories(
+        self,
+        context: "ToolContext",
+        tool_name: Optional[str] = None,
+        before_date: Optional[str] = None,
+    ) -> int:
+        """Clear stored memories (tool or text). Returns number of memories deleted."""
+        pass

touchdb/capabilities/agent_memory/models.py

@@ -0,0 +1,53 @@
+"""
+Memory storage models and types.
+"""
+
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel
+
+
+class ToolMemory(BaseModel):
+    """Represents a stored tool usage memory."""
+
+    memory_id: Optional[str] = None
+    question: str
+    tool_name: str
+    args: Dict[str, Any]
+    timestamp: Optional[str] = None
+    success: bool = True
+    metadata: Optional[Dict[str, Any]] = None
+
+
+class TextMemory(BaseModel):
+    """Represents a stored free-form text memory."""
+
+    memory_id: Optional[str] = None
+    content: str
+    timestamp: Optional[str] = None
+
+
+class ToolMemorySearchResult(BaseModel):
+    """Represents a search result from tool memory storage."""
+
+    memory: ToolMemory
+    similarity_score: float
+    rank: int
+
+
+class TextMemorySearchResult(BaseModel):
+    """Represents a search result from text memory storage."""
+
+    memory: TextMemory
+    similarity_score: float
+    rank: int
+
+
+class MemoryStats(BaseModel):
+    """Memory storage statistics."""
+
+    total_memories: int
+    unique_tools: int
+    unique_questions: int
+    success_rate: float
+    most_used_tools: Dict[str, int]

touchdb/capabilities/file_system/__init__.py

@@ -0,0 +1,14 @@
+"""
+File system capability.
+
+This module provides abstractions for file system operations used by tools.
+"""
+
+from .base import FileSystem
+from .models import CommandResult, FileSearchMatch
+
+__all__ = [
+    "FileSystem",
+    "FileSearchMatch",
+    "CommandResult",
+]

touchdb/capabilities/file_system/base.py

@@ -0,0 +1,71 @@
+"""
+File system capability interface.
+
+This module contains the abstract base class for file system operations.
+"""
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, List, Optional
+
+from .models import CommandResult, FileSearchMatch
+
+if TYPE_CHECKING:
+    from touchdb.core.tool import ToolContext
+
+
+class FileSystem(ABC):
+    """Abstract base class for file system operations."""
+
+    @abstractmethod
+    async def list_files(self, directory: str, context: "ToolContext") -> List[str]:
+        """List files in a directory."""
+        pass
+
+    @abstractmethod
+    async def read_file(self, filename: str, context: "ToolContext") -> str:
+        """Read the contents of a file."""
+        pass
+
+    @abstractmethod
+    async def write_file(
+        self,
+        filename: str,
+        content: str,
+        context: "ToolContext",
+        overwrite: bool = False,
+    ) -> None:
+        """Write content to a file."""
+        pass
+
+    @abstractmethod
+    async def exists(self, path: str, context: "ToolContext") -> bool:
+        """Check if a file or directory exists."""
+        pass
+
+    @abstractmethod
+    async def is_directory(self, path: str, context: "ToolContext") -> bool:
+        """Check if a path is a directory."""
+        pass
+
+    @abstractmethod
+    async def search_files(
+        self,
+        query: str,
+        context: "ToolContext",
+        *,
+        max_results: int = 20,
+        include_content: bool = False,
+    ) -> List[FileSearchMatch]:
+        """Search for files matching a query within the accessible namespace."""
+        pass
+
+    @abstractmethod
+    async def run_bash(
+        self,
+        command: str,
+        context: "ToolContext",
+        *,
+        timeout: Optional[float] = None,
+    ) -> CommandResult:
+        """Execute a bash command within the accessible namespace."""
+        pass

touchdb/capabilities/file_system/models.py

@@ -0,0 +1,25 @@
+"""
+File system capability models.
+
+This module contains data models for file system operations.
+"""
+
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class FileSearchMatch:
+    """Represents a single search result within a file system."""
+
+    path: str
+    snippet: Optional[str] = None
+
+
+@dataclass
+class CommandResult:
+    """Represents the result of executing a shell command."""
+
+    stdout: str
+    stderr: str
+    returncode: int

touchdb/capabilities/sql_runner/__init__.py

@@ -0,0 +1,13 @@
+"""
+SQL runner capability.
+
+This module provides abstractions for SQL execution used by tools.
+"""
+
+from .base import SqlRunner
+from .models import RunSqlToolArgs
+
+__all__ = [
+    "SqlRunner",
+    "RunSqlToolArgs",
+]

touchdb/capabilities/sql_runner/base.py

@@ -0,0 +1,37 @@
+"""
+SQL runner capability interface.
+
+This module contains the abstract base class for SQL execution.
+"""
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+import pandas as pd
+
+from .models import RunSqlToolArgs
+
+if TYPE_CHECKING:
+    from touchdb.core.tool import ToolContext
+
+
+class SqlRunner(ABC):
+    """Interface for SQL execution with different implementations."""
+
+    @abstractmethod
+    async def run_sql(
+        self, args: RunSqlToolArgs, context: "ToolContext"
+    ) -> pd.DataFrame:
+        """Execute SQL query and return results as a DataFrame.
+
+        Args:
+            args: SQL query arguments
+            context: Tool execution context
+
+        Returns:
+            DataFrame with query results
+
+        Raises:
+            Exception: If query execution fails
+        """
+        pass

touchdb/capabilities/sql_runner/models.py

@@ -0,0 +1,13 @@
+"""
+SQL runner capability models.
+
+This module contains data models for SQL execution.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class RunSqlToolArgs(BaseModel):
+    """Arguments for run_sql tool."""
+
+    sql: str = Field(description="SQL query to execute")

touchdb/components/__init__.py

@@ -0,0 +1,92 @@
+"""UI Component system for TouchDB Agents."""
+
+# Base component
+from .base import UiComponent
+
+# Simple components
+from .simple import (
+    SimpleComponent,
+    SimpleComponentType,
+    SimpleTextComponent,
+    SimpleImageComponent,
+    SimpleLinkComponent,
+)
+
+# Rich components - re-export all
+from .rich import (
+    # Base
+    RichComponent,
+    ComponentType,
+    ComponentLifecycle,
+    # Text
+    RichTextComponent,
+    # Data
+    DataFrameComponent,
+    ChartComponent,
+    # Feedback
+    NotificationComponent,
+    StatusCardComponent,
+    ProgressBarComponent,
+    ProgressDisplayComponent,
+    StatusIndicatorComponent,
+    LogViewerComponent,
+    LogEntry,
+    BadgeComponent,
+    IconTextComponent,
+    # Interactive
+    TaskListComponent,
+    Task,
+    StatusBarUpdateComponent,
+    TaskTrackerUpdateComponent,
+    ChatInputUpdateComponent,
+    TaskOperation,
+    ButtonComponent,
+    ButtonGroupComponent,
+    # Containers
+    CardComponent,
+    # Specialized
+    ArtifactComponent,
+)
+
+__all__ = [
+    # Base
+    "UiComponent",
+    # Simple components
+    "SimpleComponent",
+    "SimpleComponentType",
+    "SimpleTextComponent",
+    "SimpleImageComponent",
+    "SimpleLinkComponent",
+    # Rich components - Base
+    "RichComponent",
+    "ComponentType",
+    "ComponentLifecycle",
+    # Rich components - Text
+    "RichTextComponent",
+    # Rich components - Data
+    "DataFrameComponent",
+    "ChartComponent",
+    # Rich components - Feedback
+    "NotificationComponent",
+    "StatusCardComponent",
+    "ProgressBarComponent",
+    "ProgressDisplayComponent",
+    "StatusIndicatorComponent",
+    "LogViewerComponent",
+    "LogEntry",
+    "BadgeComponent",
+    "IconTextComponent",
+    # Rich components - Interactive
+    "TaskListComponent",
+    "Task",
+    "StatusBarUpdateComponent",
+    "TaskTrackerUpdateComponent",
+    "ChatInputUpdateComponent",
+    "TaskOperation",
+    "ButtonComponent",
+    "ButtonGroupComponent",
+    # Rich components - Containers
+    "CardComponent",
+    # Rich components - Specialized
+    "ArtifactComponent",
+]

touchdb/components/base.py

@@ -0,0 +1,11 @@
+"""
+UI components base - re-exports UiComponent from core.
+
+UiComponent lives in core/ because it's a fundamental return type for tools.
+This module provides backward compatibility by re-exporting it here.
+"""
+
+# Re-export UiComponent from core for backward compatibility
+from ..core.components import UiComponent
+
+__all__ = ["UiComponent"]