ShadAI Framework
    ShadAI Framework
    • Index
    • README
    • Pricing
      • Pricing Plan
    • advanced
      • Best Practices
      • Tool Orchestration
      • Performance Optimization
      • Custom Tools
    • examples
      • Advanced Patterns
      • Custom Agent Examples
      • Market Research Examples
      • Multi-Document Analysis
      • Basic Query Examples
    • api-reference
      • Exceptions Reference
      • Engine Tool API
      • Shadai Client API Reference
      • Query Tool API
      • Summarize Tool API
      • Agent Tool API
      • Web Search Tool API
    • use-cases
      • Knowledge Synthesis
      • Research Assistant
      • Custom Workflows
      • Document Q&A
    • core-concepts
      • Architecture
      • Intelligent Agent
      • RAG System
      • Tools Overview
    • guides
      • Memory & Context
      • Streaming Responses
      • File Ingestion
      • Error Handling
      • Session Management
    • getting-started
      • Authentication
      • Your First Query
      • Quick Start
      • Installation

    Index

    Welcome to the complete documentation for the Shadai Python client! This documentation will help you build powerful AI applications with document understanding, intelligent agents, and RAG technology.

    šŸ“š Documentation Structure#

    Index ā†’#

    Main documentation hub with complete navigation

    šŸš€ Quick Links#

    New to Shadai?#

    Start here to get up and running:
    Installation - Install Shadai in 60 seconds
    Authentication - Set up your API key
    Quick Start - Core operations in 5 minutes
    Your First Query - Step-by-step tutorial

    Building Applications?#

    Learn the essentials:
    Session Management - Organize your work
    Memory & Context - Conversational AI
    File Ingestion - Process documents
    Streaming Responses - Real-time output
    Error Handling - Robust applications

    Understanding Shadai?#

    Deep dive into concepts:
    Architecture - How Shadai works
    RAG System - Retrieval-Augmented Generation
    Tools Overview - All available tools
    Intelligent Agent - Autonomous workflows

    Real-World Use Cases?#

    Practical applications:
    Document Q&A - Build Q&A systems
    Research Assistant - Analyze research
    Knowledge Synthesis - Multi-document analysis
    Custom Workflows - Build specialized systems

    API Reference?#

    Complete technical reference:
    Shadai Client - Main client class
    Query Tool - Document queries
    Summarize Tool - Document summaries
    Web Search Tool - Internet search
    Engine Tool - Multi-tool orchestration
    Agent Tool - Custom workflows
    Exceptions - Error handling

    Code Examples?#

    Ready-to-use examples:
    Basic Query - Simple queries
    Multi-Document Analysis - Multiple docs
    Custom Agent - Build agents
    Market Research - Research workflows
    Advanced Patterns - Pro techniques

    Advanced Topics?#

    Take it to the next level:
    Custom Tools - Build your own tools
    Tool Orchestration - Complex workflows
    Performance Optimization - Speed & efficiency
    Best Practices - Production-ready patterns

    šŸŽÆ Common Tasks#

    I want to...#

    Query documents
    ā†’ Document Q&A Guide
    Build a chatbot
    ā†’ Quick Start
    Create custom tools
    ā†’ Custom Tools Guide
    Analyze multiple documents
    ā†’ Knowledge Synthesis

    šŸ“– Learning Paths#

    Path 1: Build a Q&A System (30 minutes)#

    1.
    Installation (5 min)
    2.
    Authentication (5 min)
    3.
    Your First Query (10 min)
    4.
    Document Q&A Use Case (10 min)

    Path 2: Master Core Features (1 hour)#

    1.
    Quick Start (15 min)
    2.
    Session Management (15 min)
    3.
    Memory & Context (15 min)
    4.
    Tools Overview (15 min)

    Path 3: Build Custom Agents (2 hours)#

    1.
    Intelligent Agent Concepts (30 min)
    2.
    Custom Tools Guide (45 min)
    3.
    Custom Agent Examples (30 min)
    4.
    Tool Orchestration (15 min)

    Path 4: Production Deployment (1.5 hours)#

    1.
    Error Handling (20 min)
    2.
    Performance Optimization (40 min)
    3.
    Best Practices (30 min)

    šŸ” Search by Topic#

    RAG & Document Processing#

    RAG System Explained
    File Ingestion Guide
    Multi-Document Analysis

    Agents & Tools#

    Intelligent Agent
    Custom Tools
    Tool Orchestration
    Custom Agent Examples

    Memory & Conversations#

    Memory & Context Guide
    Session Management
    Chat History API

    Performance & Optimization#

    Streaming Responses
    Performance Optimization
    Best Practices

    Integration & Production#

    Document Q&A System
    Error Handling
    Best Practices

    šŸ’” Tips#

    Start Simple: Begin with basic queries, add complexity as needed
    Use Memory: Enable memory by default for natural conversations
    Stream Responses: Always stream for better user experience
    Handle Errors: Use try/except for robust applications
    Reuse Sessions: Keep sessions alive for better performance

    šŸ†˜ Need Help?#

    šŸ“§ Email: support@shadai.com
    šŸ› Issues: GitHub Issues
    šŸ“– API Reference: Complete API Docs

    šŸ†• What's New in v0.1.29#

    šŸ§  Memory Enabled by Default - All tools now use conversation memory automatically
    šŸ’¬ Chat History Management - New methods to retrieve and clear session history
    šŸ“– Complete Documentation - This comprehensive documentation site!
    See full changelog ā†’

    šŸ“„ License#

    MIT License - see LICENSE file for details.
    Ready to start? ā†’ Installation Guide
    Have questions? ā†’ Core Concepts
    Building something specific? ā†’ Use Cases
    Modified atĀ 2025-10-17 17:48:43
    Next
    README
    Built with