outowiki 0.3.0

AI agent knowledge management system using Wiki-based markdown storage

OutoWiki Documentation

OutoWiki is a wiki-based knowledge management system designed for AI agents. It provides a structured way to store, retrieve, and organize information that AI agents learn across interactions.

Overview

OutoWiki solves the problem of persistent memory for AI agents by organizing information in a familiar wiki structure. Instead of opaque databases, OutoWiki uses markdown documents organized in folders, making the knowledge human-readable and editable.

Architecture

┌─────────────────────────────────────────────────────────┐
│                      OutoWiki Facade                     │
│  (OutoWiki class - main entry point for all operations)  │
└─────────────────────┬───────────────────────────────────┘
                      │
         ┌────────────┼────────────┐
         │            │            │
    ┌────▼────┐  ┌────▼────┐  ┌────▼────┐
    │Recorder │  │Searcher │  │Internal │
    │ Module  │  │ Module  │  │ Agent   │
    └────┬────┘  └────┬────┘  └────┬────┘
         │            │            │
    ┌────▼────────────▼────────────▼────┐
    │           LLM Provider            │
    │   (OpenAI or Anthropic)          │
    └──────────────────────────────────┘

The system has three main components:

• Recorder: Processes new content, determines document placement, manages backlinks
• Searcher: Finds relevant documents using semantic search and intent analysis
• Internal Agent: Handles complex operations like merge, split, and modify plans

Wiki Structure

OutoWiki organizes knowledge as markdown files in a folder hierarchy:

wiki/
├── index.md              # Auto-generated category index
├── conversations/
│   ├── 2024-01-15_001.md
│   └── 2024-01-16_001.md
├── projects/
│   ├── project-alpha.md
│   └── notes/
│       └── planning.md
└── concepts/
    ├── python.md
    └── web-development.md

Documents support backlinks using the [[Document Name]] syntax. When auto_backlinks is enabled, OutoWiki automatically updates related documents when new content references existing topics.

Quick Start

from outowiki import OutoWiki, WikiConfig

# Create configuration
config = WikiConfig(
    provider="openai",
    api_key="sk-...",        # Your OpenAI API key
    model="gpt-4",
    wiki_path="./my_wiki"    # Local wiki folder
)

# Initialize the wiki
wiki = OutoWiki(config)

# Record new information
result = wiki.record({
    "type": "conversation",
    "content": "User prefers Python for web development. Suggested Flask or Django."
})
print(f"Recorded: {result.success}")
print(f"Actions: {result.actions_taken}")

# Search for information
results = wiki.search("programming preferences")
print(f"Found: {results.paths}")

# Work with a specific document
doc = wiki.get_document("concepts/web-development.md")
print(f"Title: {doc.metadata.title}")
print(doc.content[:500])

Documentation

Getting Started

• Installation - How to install OutoWiki
• Configuration - Configuration options and settings

API Reference

• OutoWiki Facade - Main entry point for all operations
• Data Models - WikiDocument, SearchQuery, etc.
• Plan Models - CreatePlan, ModifyPlan, MergePlan, etc.
• Analysis Models - IntentAnalysis, AnalysisResult
• Modules - Recorder, Searcher, InternalAgent
• Providers - OpenAI, Anthropic providers
• Exceptions - Error handling

Guides

• Recording Workflow - How to record information
• Search Strategies - How to search effectively
• Document Management - CRUD operations

License

Apache License 2.0 - see LICENSE file for details.