fabricatio Logo

Contents:

  • Overview
    • What is Fabricatio?
    • Core Architecture
      • Event-Based Agent Structure
    • Technology Stack
      • Rust for Performance
      • Handlebars for Templating
      • PyO3 for Python Bindings
    • Key Benefits
    • Primary Use Cases
    • Differentiation from Other LLM Frameworks
  • Architecture Overview
    • Event-Driven Agent Architecture
      • Core Concepts
    • Project Structure
      • Rust Crates Architecture
    • Build System
    • Key Technologies
    • Rust-Python Integration
    • Dependency Resolution Flow
    • Data Flow: RAG Pipeline
    • Data Flow: Multi-Agent Team Collaboration
      • Component Hierarchy
    • Key Technologies
    • Configuration Priority
  • Core Concepts
    • Event-Driven Architecture
      • Event System
      • EventEmitter Pattern
    • Roles
      • Role Lifecycle
    • Skills
    • WorkFlows
      • WorkFlow Execution Flow
    • Tasks
      • Task Properties
      • Delegation Modes
    • Actions
      • Action Lifecycle
    • Capability Mixins
      • LLM Capability
      • Other Capabilities
    • Logger Integration
      • Logger Configuration
    • Async Execution
    • Best Practices
  • Package Ecosystem Guide
    • Package Architecture
    • Package Categories
      • Capability Packages
      • Integration Packages
      • Core Packages
      • Rust Crates
    • Package Dependencies Graph
  • Features
    • Event-Driven Architecture
      • EventEmitter Pattern
      • Task Management Workflows
      • Benefits of Event-Driven Design
    • LLM Integration & Templating
      • Handlebars Templating
      • Dynamic Content Generation
    • Async & Extensible
      • Asynchronous Execution Model
      • Extension Mechanisms
      • Workflow Customization
  • Installation
    • Quick Installation
    • Selective Installation
    • Template Download
    • Available Optional Dependencies
    • Development Installation
    • Building Distribution
    • Requirements
  • Configuration Guide
    • Quick Start Tutorial
      • Step 1: Install Fabricatio
      • Step 2: Create a Configuration File
      • Step 3: Verify Your Setup
      • Step 4: Configure Your First Agent
    • Configuration Sources & Priority
    • Configuration File Formats
      • fabricatio.toml
      • pyproject.toml
      • Environment Variables / .env
    • Configuration Sections
      • [debug]
      • [llm]
      • [embedding]
      • [reranker]
      • [routing]
        • Provider Configuration
        • Deployment Configuration
        • Cache Configuration
        • Router Features
    • Programmatic Configuration
      • Role-level Configuration
      • Action-level Configuration
      • aask() vs aask_structured()
    • Real-World Configuration Examples
      • Example 1: Single Provider with OpenAI
      • Example 2: Multi-Provider with Fallback
      • Example 3: Anthropic with Claude
      • Example 4: Azure OpenAI
      • Example 5: Local Model Setup
    • Advanced: Multiple Provider Setup
      • Load Balancing Across Providers
    • Environment-Specific Configs
      • Development (.env.local)
      • Staging (fabricatio.staging.toml)
      • Production (fabricatio.toml)
      • Loading Environment-Specific Config
    • Template Discovery Configuration
    • Caching Configuration
    • Troubleshooting
    • Common Configuration Patterns
      • Pattern 1: Development with Local Caching
      • Pattern 2: Production with Multiple Tiers
      • Pattern 3: Cost-Optimized Setup
    • Migration Guide
      • Migrating from v0.x to v1.x
  • Use Cases & Examples
    • Basic Chat Agent
    • Retrieval-Augmented Generation (RAG)
    • Code Review
    • Code Correction
    • Task Proposal
    • Structured Output
    • Extracting Structured Data
    • Diff Editing
    • Rule-Based Processing
    • Content Improvement
    • Task Handling with File Operations
    • Task Cancellation and Checkpoint
    • Diary Generation from Commit History
    • Article Extraction and Storage
    • Anki Deck Generation
    • Example Categories
    • Running Examples
  • Development Setup
    • Prerequisites
    • Quick Setup
    • Alternative Setup with UV
    • Development Commands
    • Project Structure
    • Testing
    • Code Quality
    • Building Documentation
    • Debugging
  • Contributing
    • Design Philosophy
    • Getting Started
    • Optional: Generate Subpackages
    • Testing and Quality
    • Python vs Rust Contributions
    • Submitting Changes
    • Contribution Guidelines
      • Review Process
  • Code Style Guide
    • Rust Conventions
      • Edition and Build Configuration
      • Naming Conventions
      • Module Organization
      • Error Handling
      • Doc Comments
      • PyO3 Patterns
      • Async Patterns
      • Traits and Generics
      • Feature Flags
    • Python Conventions
      • Type Hints
      • Async Patterns
      • Naming Conventions
      • Docstring Style
      • Pydantic v2 Patterns
      • Imports Organization
      • Decorators
    • Git Conventions
      • Branch Naming
      • Commit Messages
    • Documentation Conventions
      • Rust Documentation
      • Python Documentation
    • Testing Conventions
      • Python Testing (pytest)
      • Rust Testing
    • Linting and Formatting
      • Rust
      • Python
    • Project Structure
      • Python Package Structure
      • Rust Crate Structure
      • Module Exports
    • Development Commands
    • See Also
  • Rust Crates
    • thryd
      • thryd Architecture
        • Core Concepts
        • Rate Limiting Internals
    • fabricatio-config
    • fabricatio-logger
    • fabricatio-constants
    • fabricatio-stubgen
    • Additional Crates
    • Rust Crate Dependencies
    • Building Rust Crates
      • Development Requirements
      • PyO3 Integration
      • Feature Flags Summary
  • Usage
    • Overview
    • Basic Example
    • Async Usage
      • Delegation Modes
    • Usage Scenarios
    • Key Concepts
    • Getting Started
  • Workflow Patterns
    • Event Flow Overview
    • Simple Action Workflow
    • Multi-Step Pipeline
    • Parallel Actions
    • Conditional Branching
    • Task Proposal Pattern
    • Error Handling Pattern
    • RAG Workflow Pattern
    • Structured Output Pattern
    • Review-Improvement Loop
    • Checkpoint Pattern
    • Team Collaboration Pattern
    • EventEmitter Wildcard Pattern
    • Task Lifecycle Pattern
    • Role and Skill Registration Pattern
    • Capability Mixin Pattern
    • Role Inheritance Pattern
    • Best Practices Summary

API Reference

  • API Reference
    • fabricatio_yue
      • Submodules
        • fabricatio_yue.actions
        • fabricatio_yue.capabilities
        • fabricatio_yue.cli
        • fabricatio_yue.config
        • fabricatio_yue.models
        • fabricatio_yue.workflows
    • fabricatio_rag
      • Submodules
        • fabricatio_rag.actions
        • fabricatio_rag.capabilities
        • fabricatio_rag.config
        • fabricatio_rag.models
        • fabricatio_rag.workflows
    • fabricatio_tei
      • Submodules
        • fabricatio_tei.actions
        • fabricatio_tei.capabilities
        • fabricatio_tei.config
        • fabricatio_tei.models
        • fabricatio_tei.rust
        • fabricatio_tei.workflows
    • fabricatio_team
      • Submodules
        • fabricatio_team.actions
        • fabricatio_team.capabilities
        • fabricatio_team.config
        • fabricatio_team.models
        • fabricatio_team.workflows
    • fabricatio_core
      • Submodules
        • fabricatio_core.capabilities
        • fabricatio_core.decorators
        • fabricatio_core.emitter
        • fabricatio_core.journal
        • fabricatio_core.models
        • fabricatio_core.rust
        • fabricatio_core.utils
    • fabricatio_rule
      • Submodules
        • fabricatio_rule.actions
        • fabricatio_rule.capabilities
        • fabricatio_rule.config
        • fabricatio_rule.models
    • fabricatio_anki
      • Submodules
        • fabricatio_anki.actions
        • fabricatio_anki.capabilities
        • fabricatio_anki.config
        • fabricatio_anki.models
        • fabricatio_anki.rust
        • fabricatio_anki.workflows
    • fabricatio_tool
      • Submodules
        • fabricatio_tool.actions
        • fabricatio_tool.capabilities
        • fabricatio_tool.config
        • fabricatio_tool.decorators
        • fabricatio_tool.fs
        • fabricatio_tool.mcp
        • fabricatio_tool.models
        • fabricatio_tool.rust
        • fabricatio_tool.toolboxes
        • fabricatio_tool.workflows
    • fabricatio_mock
      • Submodules
        • fabricatio_mock.actions
        • fabricatio_mock.capabilities
        • fabricatio_mock.config
        • fabricatio_mock.models
        • fabricatio_mock.utils
        • fabricatio_mock.workflows
      • Attributes
      • Package Contents
        • DUMMY_LLM_GROUP
        • DUMMY_EMBEDDING_GROUP
        • DUMMY_RERANKER_GROUP
    • fabricatio_diff
      • Submodules
        • fabricatio_diff.actions
        • fabricatio_diff.capabilities
        • fabricatio_diff.config
        • fabricatio_diff.models
        • fabricatio_diff.rust
        • fabricatio_diff.utils
        • fabricatio_diff.workflows
    • fabricatio_plot
      • Submodules
        • fabricatio_plot.actions
        • fabricatio_plot.capabilities
        • fabricatio_plot.config
        • fabricatio_plot.models
        • fabricatio_plot.toolboxes
        • fabricatio_plot.workflows
    • fabricatio_typst
      • Submodules
        • fabricatio_typst.actions
        • fabricatio_typst.capabilities
        • fabricatio_typst.config
        • fabricatio_typst.models
        • fabricatio_typst.rust
        • fabricatio_typst.workflows
    • fabricatio_agent
      • Submodules
        • fabricatio_agent.actions
        • fabricatio_agent.capabilities
        • fabricatio_agent.cli
        • fabricatio_agent.config
        • fabricatio_agent.models
        • fabricatio_agent.rust
        • fabricatio_agent.workflows
    • fabricatio_novel
      • Submodules
        • fabricatio_novel.actions
        • fabricatio_novel.capabilities
        • fabricatio_novel.cli
        • fabricatio_novel.config
        • fabricatio_novel.models
        • fabricatio_novel.rust
        • fabricatio_novel.utils
        • fabricatio_novel.workflows
    • fabricatio_webui
      • Submodules
        • fabricatio_webui.actions
        • fabricatio_webui.capabilities
        • fabricatio_webui.cli
        • fabricatio_webui.config
        • fabricatio_webui.models
        • fabricatio_webui.rust
        • fabricatio_webui.workflows
    • fabricatio_judge
      • Submodules
        • fabricatio_judge.capabilities
        • fabricatio_judge.models
    • fabricatio_memory
      • Submodules
        • fabricatio_memory.actions
        • fabricatio_memory.capabilities
        • fabricatio_memory.config
        • fabricatio_memory.inited_memory_service
        • fabricatio_memory.models
        • fabricatio_memory.rust
        • fabricatio_memory.workflows
    • fabricatio_locale
      • Submodules
        • fabricatio_locale.actions
        • fabricatio_locale.capabilities
        • fabricatio_locale.config
        • fabricatio_locale.models
        • fabricatio_locale.rust
        • fabricatio_locale.workflows
    • fabricatio_digest
      • Submodules
        • fabricatio_digest.actions
        • fabricatio_digest.capabilities
        • fabricatio_digest.config
        • fabricatio_digest.models
        • fabricatio_digest.workflows
    • fabricatio_milvus
      • Submodules
        • fabricatio_milvus.actions
        • fabricatio_milvus.capabilities
        • fabricatio_milvus.config
        • fabricatio_milvus.models
        • fabricatio_milvus.workflows
    • fabricatio_comfyui
      • Submodules
        • fabricatio_comfyui.actions
        • fabricatio_comfyui.capabilities
        • fabricatio_comfyui.client
        • fabricatio_comfyui.config
        • fabricatio_comfyui.models
        • fabricatio_comfyui.workflows
    • fabricatio_actions
      • Submodules
        • fabricatio_actions.actions
        • fabricatio_actions.models
    • fabricatio_tagging
      • Submodules
        • fabricatio_tagging.actions
        • fabricatio_tagging.capabilities
        • fabricatio_tagging.config
        • fabricatio_tagging.models
        • fabricatio_tagging.workflows
    • fabricatio_lancedb
      • Submodules
        • fabricatio_lancedb.actions
        • fabricatio_lancedb.capabilities
        • fabricatio_lancedb.config
        • fabricatio_lancedb.inited_service
        • fabricatio_lancedb.models
        • fabricatio_lancedb.rust
        • fabricatio_lancedb.workflows
    • fabricatio_improve
      • Submodules
        • fabricatio_improve.actions
        • fabricatio_improve.capabilities
        • fabricatio_improve.config
        • fabricatio_improve.models
        • fabricatio_improve.workflows
    • fabricatio_capable
      • Submodules
        • fabricatio_capable.actions
        • fabricatio_capable.capabilities
        • fabricatio_capable.config
        • fabricatio_capable.models
        • fabricatio_capable.workflows
    • fabricatio_thinking
      • Submodules
        • fabricatio_thinking.actions
        • fabricatio_thinking.capabilities
        • fabricatio_thinking.config
        • fabricatio_thinking.models
        • fabricatio_thinking.rust
        • fabricatio_thinking.workflows
    • fabricatio_question
      • Submodules
        • fabricatio_question.actions
        • fabricatio_question.capabilities
        • fabricatio_question.config
        • fabricatio_question.models
        • fabricatio_question.utils
        • fabricatio_question.workflows
    • fabricatio_character
      • Submodules
        • fabricatio_character.actions
        • fabricatio_character.capabilities
        • fabricatio_character.config
        • fabricatio_character.models
        • fabricatio_character.utils
        • fabricatio_character.workflows
    • fabricatio_translate
      • Submodules
        • fabricatio_translate.actions
        • fabricatio_translate.capabilities
        • fabricatio_translate.config
        • fabricatio_translate.models
        • fabricatio_translate.workflows
    • fabricatio_workspace
      • Submodules
        • fabricatio_workspace.actions
        • fabricatio_workspace.capabilities
        • fabricatio_workspace.config
        • fabricatio_workspace.models
        • fabricatio_workspace.rust
        • fabricatio_workspace.workflows
    • fabricatio_checkpoint
      • Submodules
        • fabricatio_checkpoint.actions
        • fabricatio_checkpoint.capabilities
        • fabricatio_checkpoint.cli
        • fabricatio_checkpoint.config
        • fabricatio_checkpoint.inited_service
        • fabricatio_checkpoint.models
        • fabricatio_checkpoint.rust
        • fabricatio_checkpoint.workflows
    • fabricatio_capabilities
      • Submodules
        • fabricatio_capabilities.actions
        • fabricatio_capabilities.capabilities
        • fabricatio_capabilities.config
        • fabricatio_capabilities.models
        • fabricatio_capabilities.workflows
fabricatio
  • Search

© Copyright 2025, Whth.

Built with Sphinx using a theme provided by Read the Docs.