YAAF

Contents:

  • Getting Started
    • Prerequisites
    • Installation
    • Running the Backend
    • Running the Frontend
    • Running Both Together
    • Your First Query
    • Verifying the Installation
    • Common Issues
    • Next Steps
  • Core Concepts
    • Artifact-First, Not Agent-First
    • Artifact-Driven Execution
    • What is an Artifact?
    • The Railway Metaphor
    • The Workflow DAG
    • Why This Matters
    • Artifact Types and Compatibility
    • Next Steps
  • Agent Taxonomy
    • The Four Roles
      • EXTRACTOR
      • TRANSFORMER
      • SYNTHESIZER
      • GENERATOR
    • Additional Classifications
      • Interaction Mode
      • Output Permanence
    • Complete Agent Classification
    • How the Planner Uses Taxonomy
    • Next Steps
  • Agents Reference
    • EXTRACTORS
      • SqlAgent
      • DocumentRetrieverAgent
      • BraveSearchAgent
      • DuckDuckGoSearchAgent
      • UrlAgent
      • UserInputAgent
    • TRANSFORMERS
      • MleAgent
      • ReviewerAgent
      • ToolAgent
      • NumericalSequencesAgent
      • ValidationAgent
    • SYNTHESIZERS
      • AnswererAgent
      • UrlReviewerAgent
      • PlannerAgent
    • GENERATORS
      • VisualizationAgent
      • BashAgent
    • Agent Configuration
      • Per-Agent Model Settings
      • Agent Budgets
    • Creating Custom Agents
  • Planning System
    • Overview
    • Goal Extraction
    • RAG-Based Example Retrieval
    • Workflow YAML Format
    • Workflow Execution
    • Validation and Checks
    • Error Handling and Replanning
    • Planning Constraints
    • Debugging Plans
    • Custom Planning
    • Adding Examples for Custom Agents
    • Next Steps
  • Configuration
    • Configuration File
    • Basic Structure
    • Client Configuration
    • Agent Configuration
      • Simple Format
      • Per-Agent Settings
    • Data Sources
      • SQLite Sources
      • Text Sources
      • RAG Sources
    • MCP Tools Configuration
      • SSE Tools
      • Stdio Tools
    • API Keys
    • Safety Filter
    • Complete Example
    • Configuration Generator
    • Environment Variables
    • Troubleshooting
  • Architecture
    • System Overview
    • Core Components
      • Orchestrator
      • Planner Agent
      • Workflow Engine
      • Artifact Storage
    • Data Flow
      • Request Processing
    • Agent System
      • Base Classes
      • Executor Pattern
      • Taxonomy System
    • Message Structure
      • Messages
      • Notes
      • Artifacts
    • Storage Architecture
      • ArtefactStorage
    • API Endpoints
      • Backend API
    • Frontend Architecture
      • Next.js Application
      • Chat Interface
    • Project Structure
    • Extensibility
      • Adding New Agents
      • Adding New Sources
      • Adding New Artifact Types
  • Development Guide
    • Development Environment
      • Prerequisites
      • Setting Up Development Environment
    • Code Style and Standards
      • Python Standards
      • TypeScript/Frontend Standards
    • Testing
      • Backend Testing
      • Frontend Testing
      • Integration Testing
    • Debugging
      • Backend Debugging
      • Frontend Debugging
    • Performance Monitoring
      • Backend Performance
      • Frontend Performance
    • Contributing
      • Git Workflow
      • Code Review Guidelines
      • Documentation
    • Release Process
      • Version Management
      • Deployment
    • Best Practices
      • Security
      • Performance
      • Maintainability
YAAF
  • Search

© Copyright 2024, YAAF Contributors.

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